{ "openapi": "3.1.0", "info": { "title": "Accounting Service", "version": "1b77ae3dcaf5", "summary": "DgCore platform API surface for the Accounting Service domain.", "description": "The Accounting Service domain: 162 operations across 31 resource groups.\n\nThis is the published contract, not a description of a running deployment: the environment\nyou were granted may carry operations this document does not, and may not carry every\noperation listed here." }, "servers": [ { "url": "https://{gateway}/accounting-service", "description": "The full route is `https:///accounting-service/`. The service segment is fixed; the gateway host is the one you were granted. Substitute it below.", "variables": { "gateway": { "default": "gateway.example" } } } ], "tags": [ { "name": "accounting-engine", "description": "Operations addressed under `/accounting-engine` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accounting-entries", "description": "Operations addressed under `/accounting-entries` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "accounting-entry-definitions", "description": "Operations addressed under `/accounting-entry-definitions` — 15 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "balances", "description": "Operations addressed under `/balances` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "batch-accounting-entry-files", "description": "Operations addressed under `/batch-accounting-entry-files` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "batch-catalog", "description": "Operations addressed under `/batch-catalog` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "caches", "description": "Operations addressed under `/caches` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "compensating-transactions", "description": "Operations addressed under `/compensating-transactions` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "daily-balances", "description": "Operations addressed under `/daily-balances` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "data-migrations", "description": "Operations addressed under `/data-migrations` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "extended-properties", "description": "Operations addressed under `/extended-properties` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "financial-statement-templates", "description": "Operations addressed under `/financial-statement-templates` — 13 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "financial-statements", "description": "Operations addressed under `/financial-statements` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "financial-transactions", "description": "Operations addressed under `/financial-transactions` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "fiscal-year", "description": "Operations addressed under `/fiscal-year` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "fiscal-years", "description": "Operations addressed under `/fiscal-years` — 11 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "gl-code-formats", "description": "Operations addressed under `/gl-code-formats` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "gl-code-sections", "description": "Operations addressed under `/gl-code-sections` — 9 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "gl-codes", "description": "Operations addressed under `/gl-codes` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "interbranch-accounts", "description": "Operations addressed under `/interbranch-accounts` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "key-formats", "description": "Operations addressed under `/key-formats` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-balances", "description": "Operations addressed under `/ledger-balances` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-code-matrix", "description": "Operations addressed under `/ledger-code-matrix` — 15 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledger-level-formats", "description": "Operations addressed under `/ledger-level-formats` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "ledgers", "description": "Operations addressed under `/ledgers` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "localizations", "description": "Operations addressed under `/localizations` — 10 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "parameters", "description": "Operations addressed under `/parameters` — 21 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "position-accounts", "description": "Operations addressed under `/position-accounts` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "previous-entries", "description": "Operations addressed under `/previous-entries` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "template-definitions", "description": "Operations addressed under `/template-definitions` — 4 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "trial-balance", "description": "Operations addressed under `/trial-balance` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } ], "paths": { "/accounting-engine": { "post": { "operationId": "trigger-accounting-engine", "tags": [ "accounting-engine" ], "summary": "trigger-accounting-engine", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "bpmFlowCode": { "type": "string", "x-aura-field-code": "bpmFlowCode" }, "isSimulation": { "type": "boolean", "x-aura-field-code": "isSimulation" }, "parameters": { "type": "object", "x-aura-field-code": "parameters" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } }, "required": [ "accountingEntryDefinitionCode", "bpmFlowCode", "isSimulation", "parameters", "transactionDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "simulationEntry": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "accountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountingEntryDetailAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "exchangeRateType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeRateType" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationId": { "type": "string", "format": "uuid", "x-aura-field-code": "organizationId" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "x-aura-field-code": "accountingEntryDetails" } }, "bpmFlowCode": { "type": "string", "x-aura-field-code": "bpmFlowCode" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDescription" }, "entryType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountingEntryType" }, "transactionDate": { "x-aura-type": "unresolved" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } }, "x-aura-field-code": "simulationEntry" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "trigger-accounting-engine", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-engine", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BpmFlowCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsSimulation", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Parameters", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEngineDto", "payload": "AccountingEngineDto", "collection": false, "members": [ { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "SimulationEntry", "declared_type": "SimulatorEntry", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_127", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة بالكود المعطى '{0}'.", "en": "Accounting Entry Definition is not found with the given code '{0}'.", "tr": "Verilen '{0}' koduyla Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEFINITION_NOT_FOUND" }, { "code": "ERR_ACCTNG_172", "status": 400, "message": { "ar": "لم يتم إرسال المتغير '{0}' في الطلب.", "en": "Variable '{0}' is not sent in the request.", "tr": "İstekte '{0}' değişkeni gönderilmiyor." }, "message_available": true, "constant_name": "PARAMETER_LEDGER_MUST_BE_NOT_NULL" }, { "code": "ERR_ACCTNG_176", "status": 400, "message": { "ar": "لا توجد تفاصيل تعريف قيد محاسبي تتطابق مع الشرط '{0}' الذي يرجع بقيمة صحيحة.", "en": "There is no accounting entry definition details matching with condition '{0}' which return true.", "tr": "Doğru döndüren '{0}' koşuluyla eşleşen muhasebe girişi tanımı ayrıntısı yok.\n" }, "message_available": true, "constant_name": "EACH_CONDITION_MUST_HAVE_ACCOUNTING_ENTRY_DEFINITION_DETAIL" }, { "code": "ERR_ACCTNG_181", "status": 400, "message": { "ar": "يمكن تشغيل هذا التطبيق فقط مع BPM.", "en": "This api can only be run with BPM.", "tr": "Bu api sadece BPM üzerinden çalıştırılmalıdır." }, "message_available": true, "constant_name": "THIS_API_CAN_ONLY_BE_RUN_BY_BPM" } ] } } }, "/accounting-entries": { "get": { "operationId": "get-accounting-entry-list", "tags": [ "accounting-entries" ], "summary": "get-accounting-entry-list", "parameters": [ { "name": "accountNumber", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "accountNumber" } }, { "name": "beginDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "beginDate" } }, { "name": "bpmFlowCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "bpmFlowCode" } }, { "name": "correlationId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "correlationId" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "endDate" } }, { "name": "entryType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "accountingEntryType" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "gLCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "glCode" } }, { "name": "id", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "organizationCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "organizationCode" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "referenceNumber", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "referenceNumber" } }, { "name": "userCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "userCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 16 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "accountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "ledgerName": { "type": "string", "x-aura-field-code": "ledgerName" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "rateType": { "type": "integer", "format": "int32", "x-aura-field-code": "spreadType" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "x-aura-field-code": "accountingEntryDetails" } }, "bpmFlowCode": { "type": "string", "x-aura-field-code": "bpmFlowCode" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDescription" }, "entryType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountingEntryType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "isReverse": { "type": "boolean", "x-aura-field-code": "isReverse" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" }, "valueDate": { "type": "string", "format": "date", "x-aura-field-code": "valueDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entries", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeginDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": null, "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "GLCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountingEntryDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsReverse", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "AccountingEntryDetails", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_160", "status": 400, "message": { "ar": "لم يُعثر على رمز GL '{0}'.", "en": "GL Code '{0}' is not found.", "tr": "GL Kodu '{0}' bulunamadı." }, "message_available": true, "constant_name": "GL_CODE_NOT_FOUND" }, { "code": "ERR_ACCTNG_175", "status": 400, "message": { "ar": "يجب أن يكون تاريخ الانتهاء أكبر من تاريخ البداية.", "en": "'endDate' must be bigger than 'beginDate'.", "tr": "'endDate' 'beginDate' den büyük olmalı." }, "message_available": true, "constant_name": "END_DATE_MUST_BE_BIGGER_BEGIN_DATE" } ] } }, "post": { "operationId": "create-accounting-entry", "tags": [ "accounting-entries" ], "summary": "create-accounting-entry", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "accountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingEntryDefinitionDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionDetailId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountingEntryDetailAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "amount", "currencyNumber", "description", "entryDirection", "exchangeRate", "exchangeSpreadType", "glCode", "ordinalPosition", "organizationCode" ], "x-aura-field-code": "accountingEntryDetails" } }, "bpmFlowCode": { "type": "string", "x-aura-field-code": "bpmFlowCode" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDescription" }, "entryType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountingEntryType" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } }, "required": [ "accountingEntryDetails", "description", "entryType", "transactionDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-accounting-entry", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entries", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": null, "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsReverse", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_169", "status": 400, "message": { "ar": "لا تحتوي قيد المحاسبة على أي تفاصيل. لا يمكن إنشاؤه.", "en": "Accounting entry does not have any details. It cannot be created.", "tr": "Muhasebe girişi herhangi bir ayrıntıya sahip değildir. Oluşturulamaz." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DOES_NOT_HAVE_ANY_DETAILS" }, { "code": "ERR_ACCTNG_181", "status": 400, "message": { "ar": "يمكن تشغيل هذا التطبيق فقط مع BPM.", "en": "This api can only be run with BPM.", "tr": "Bu api sadece BPM üzerinden çalıştırılmalıdır." }, "message_available": true, "constant_name": "THIS_API_CAN_ONLY_BE_RUN_BY_BPM" } ] } } }, "/accounting-entries/by-correlation-id/{correlationId}": { "get": { "operationId": "get-accounting-entry-list-by-correlation-id", "tags": [ "accounting-entries" ], "summary": "get-accounting-entry-list-by-correlation-id", "parameters": [ { "name": "correlationId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryList": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "x-aura-type": "unresolved" }, "accountingEntryDetails": { "type": "object", "properties": { "accountNumber": { "x-aura-type": "unresolved" }, "amount": { "x-aura-type": "unresolved" }, "currencyId": { "x-aura-type": "unresolved" }, "currencyRate": { "x-aura-type": "unresolved" }, "description": { "x-aura-type": "unresolved" }, "entryDirection": { "x-aura-type": "unresolved" }, "financialTransactionCode": { "x-aura-type": "unresolved" }, "gLCode": { "x-aura-type": "unresolved" }, "ledgerName": { "x-aura-type": "unresolved" }, "ordinalPosition": { "x-aura-type": "unresolved" }, "organizationId": { "x-aura-type": "unresolved" }, "rateType": { "x-aura-type": "unresolved" }, "transactionDate": { "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "bpmFlowCode": { "x-aura-type": "unresolved" }, "description": { "x-aura-type": "unresolved" }, "entryType": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "transactionDate": { "x-aura-type": "unresolved" }, "userCode": { "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "correlationId": { "x-aura-type": "unresolved" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-list-by-correlation-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entries/by-correlation-id/{correlationId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CorrelationId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEntryCorrelationIdDto", "payload": "AccountingEntryCorrelationIdDto", "collection": false, "members": [ { "name": "CorrelationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountingEntryList", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_173", "status": 400, "message": { "ar": "لم يتم العثور على قيود المحاسبة باستخدام معرف الارتباط المُعطى: ‘{0}’.", "en": "Accounting Entries are not found with the given Correlationid : ‘{0}’.", "tr": "Verilen Korelasyon Kimliği ile Muhasebe Girişleri bulunamadı: '{0}'." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRIES_NOT_FOUND" } ] } } }, "/accounting-entries/validate": { "post": { "operationId": "accounting-entry-validation", "tags": [ "accounting-entries" ], "summary": "accounting-entry-validation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "accountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingEntryDefinitionDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionDetailId" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "accountingEntryDetailAmount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "amount", "currencyNumber", "description", "entryDirection", "exchangeRate", "exchangeSpreadType", "glCode", "ordinalPosition", "organizationCode" ], "x-aura-field-code": "accountingEntryDetails" } }, "bpmFlowCode": { "type": "string", "x-aura-field-code": "bpmFlowCode" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDescription" }, "entryType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountingEntryType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "entry_type", "values": [ { "value": 1, "name": "Engine" }, { "value": 2, "name": "Manual" }, { "value": 3, "name": "Logo" }, { "value": 4, "name": "ProfitLoss" }, { "value": 5, "name": "Closing" }, { "value": 6, "name": "Opening" } ] } }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } }, "required": [ "accountingEntryDetails", "description", "entryType", "transactionDate" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-entry-validation", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entries/validate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": null, "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_156", "status": 400, "message": { "ar": "الفترة المالية مغلقة. لا يمكن إنشاء قيد محاسبي.", "en": "Fical period is closed. Accounting Entry cannot be created.", "tr": "Mali dönem kapandı. Muhasebe Girişi oluşturulamıyor." }, "message_available": true, "constant_name": "FISCAL_PERIOD_IS_CLOSED" }, { "code": "ERR_ACCTNG_157", "status": 400, "message": { "ar": "لا يُسمح بإنشاء قيد محاسبي بتاريخ مستقبلي.", "en": "It is not allowed to create a future dated accounting entry.", "tr": "İleri tarihli muhasebe kaydı oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "IT_IS_NOT_ALLOWED_TO_CREATE_A_FUTURE_DATED_ACCOUNTING_ENTRY" }, { "code": "ERR_ACCTNG_158", "status": 400, "message": { "ar": "مقدار الإدخال هو 0. لا يمكن إنشاء قيد محاسبي. التتابع: '{0}'.", "en": "Amount of the entry is 0. Accounting entry cannot be created. Sequence:'{0}'.", "tr": "Giriş miktarı 0'dır. Muhasebe girişi oluşturulamıyor. Sıra:'{0}'." }, "message_available": true, "constant_name": "AMOUNT_OF_THE_ENTRY_IS_ZERO" }, { "code": "ERR_ACCTNG_159", "status": 400, "message": { "ar": "يجب أن يكون إجمالي المدين مساويًا لإجمالي الدائن. {0}", "en": "Total Debit must be equal to the total Credit. {0}", "tr": "Toplam Borç toplam Krediye eşit olmalıdır. {0}" }, "message_available": true, "constant_name": "TOTAL_DEBIT_MUST_BE_EQUAL_TO_THE_TOTAL_CREDIT" }, { "code": "ERR_ACCTNG_160", "status": 400, "message": { "ar": "لم يُعثر على رمز GL '{0}'.", "en": "GL Code '{0}' is not found.", "tr": "GL Kodu '{0}' bulunamadı." }, "message_available": true, "constant_name": "GL_CODE_NOT_FOUND" }, { "code": "ERR_ACCTNG_161", "status": 400, "message": { "ar": "الدفتر '{0}' ليس \"نشطًا\". لا يمكن إنشاء قيد محاسبي.", "en": "Ledger '{0}' is not 'Active'. Accounting entry cannot be created.", "tr": "'{0}' Defter 'Etkin' değil. Muhasebe girişi oluşturulamıyor." }, "message_available": true, "constant_name": "LEDGER_IS_NOT_ACTIVE" }, { "code": "ERR_ACCTNG_162", "status": 400, "message": { "ar": "قيمة 'customerOption' على دفتر الأستاذ '{0}' هي 'بدون_زبون'. لا يمكن إنشاء قيد محاسبي باستخدام 'رقم_الحساب'.", "en": "'customerOption' value of the Ledger '{0}' is 'without_cus'. Accounting entry cannot be created with 'accountNumber'.", "tr": "'{0}' Defterinin 'customerOption' değeri 'without_cus'tur. 'accountNumber' ile muhasebe girişi oluşturulamaz." }, "message_available": true, "constant_name": "LEDGER_IS_WITHOUT_CUS" }, { "code": "ERR_ACCTNG_163", "status": 400, "message": { "ar": "قيمة 'customerOption' في دفتر الأستاذ '{0}' هي 'with_cus'. لا يمكن إنشاء قيد محاسبي بدون 'رقم الحساب'.", "en": "'customerOption' value of the Ledger '{0}' is 'with_cus'. Accounting entry cannot be created without 'accountNumber'.", "tr": "'{0}' Defterinin 'customerOption' değeri 'with_cus'tur. 'accountNumber' olmadan muhasebe girişi oluşturulamaz." }, "message_available": true, "constant_name": "LEDGER_IS_WITH_CUS" }, { "code": "ERR_ACCTNG_164", "status": 400, "message": { "ar": "عملة الإدخال غير متوافقة مع قيمة عملة دفتر الأستاذ '{0}'. لا يمكن إنشاء قيد محاسبي. التسلسل: '{1}'.", "en": "Currency of the entry is not compatible with the ledger's '{0}' currency value. Accounting entry cannot be created. Sequence:'{1}'.", "tr": "Girişin para birimi, defterin '{0}' para birimi değeriyle uyumlu değil. Muhasebe girişi oluşturulamıyor. Sıra:'{1}'." }, "message_available": true, "constant_name": "LEDGER_CURRENCY_NOT_COMPATIBLE" }, { "code": "ERR_ACCTNG_166", "status": 400, "message": { "ar": "دفتر '{0}' سيكون لديه رصيد سلبي. لا يمكن إنشاء قيد محاسبي.", "en": "Ledger '{0}' will have negative balance. Accounting entry cannot be created.", "tr": "'{0}' defteri negatif bakiye verecek. Muhasebe kaydı oluşturulamaz." }, "message_available": true, "constant_name": "LEDGER_NOT_NEGATIVE_BALANCE" }, { "code": "ERR_ACCTNG_169", "status": 400, "message": { "ar": "لا تحتوي قيد المحاسبة على أي تفاصيل. لا يمكن إنشاؤه.", "en": "Accounting entry does not have any details. It cannot be created.", "tr": "Muhasebe girişi herhangi bir ayrıntıya sahip değildir. Oluşturulamaz." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DOES_NOT_HAVE_ANY_DETAILS" }, { "code": "ERR_ACCTNG_170", "status": 400, "message": { "ar": "دفتر الأستاذ '{0}' مغلق أمام الإدخال اليدوي. لا يمكن إنشاء قيد محاسبي.", "en": "Ledger '{0}' is closed to manual entry. Accounting entry cannot be created.", "tr": "Defter '{0}' manuel girişe kapalı. Muhasebe girişi oluşturulamıyor." }, "message_available": true, "constant_name": "LEDGER_IS_CLOSED_MANUEL_ENTRY" }, { "code": "ERR_ACCTNG_177", "status": 400, "message": { "ar": "تم إغلاق فئة الدفتر. {0}", "en": "Ledger category has been closed. {0}", "tr": "Defter kategorisi kapatılmıştır. {0}" }, "message_available": true, "constant_name": "LEDGER_CATEGORY_HAS_BEEN_CLOSED_FOR_FC" } ] } } }, "/accounting-entries/{id}": { "get": { "operationId": "get-accounting-entry-with-detail-by-id", "tags": [ "accounting-entries" ], "summary": "get-accounting-entry-with-detail-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionCode": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "accountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "description" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "spreadType" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "ledgerName": { "type": "string", "x-aura-field-code": "ledgerName" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "x-aura-field-code": "accountingEntryDetails" } }, "bpmFlowCode": { "type": "string", "x-aura-field-code": "bpmFlowCode" }, "description": { "type": "string", "x-aura-field-code": "description" }, "entryType": { "type": "integer", "format": "int32", "x-aura-field-code": "accountingEntryType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isReverse": { "type": "boolean", "x-aura-field-code": "isReverse" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-with-detail-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entries/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEntryDto", "payload": "AccountingEntryDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EntryType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "BpmFlowCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingEntryDefinitionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsReverse", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "AccountingEntryDetails", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_174", "status": 400, "message": { "ar": "لم يتم العثور على قيد المحاسبة بالمعرف المُعطى: «{0}»", "en": "Accounting Entry is not found with the given Id : ‘{0}’.", "tr": "Verilen Kimlikle Muhasebe Girişi bulunamadı: '{0}'." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_NOT_FOUND" } ] } } }, "/accounting-entries/{id}/reverse": { "post": { "operationId": "reverse-accounting-entry", "tags": [ "accounting-entries" ], "summary": "reverse-accounting-entry", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "reverseAccountingEntryId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "reverse-accounting-entry", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entries/{id}/reverse", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_174", "status": 400, "message": { "ar": "لم يتم العثور على قيد المحاسبة بالمعرف المُعطى: «{0}»", "en": "Accounting Entry is not found with the given Id : ‘{0}’.", "tr": "Verilen Kimlikle Muhasebe Girişi bulunamadı: '{0}'." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_NOT_FOUND" }, { "code": "ERR_ACCTNG_191", "status": 400, "message": { "ar": "القيد المحاسبي قد تم عكسه بالفعل. لا يمكن عكسه مرة أخرى.", "en": "Accounting Entry is already reversed. It\ncannot be reversed again.", "tr": "Muhasebe Girişi zaten tersine çevrildi. BT" }, "message_available": true, "constant_name": "REVERSE_ACCOUNTING_ALREADY_EXISTS" }, { "code": "ERR_ACCTNG_192", "status": 400, "message": { "ar": "لا توجد سلطة لإنشاء سجل محاسبة عكسي بأثر رجعي لهذا التعريف المحاسبي.", "en": "There is no authority to create a retroactive reverse accounting record for this accounting definition.", "tr": "Bu muhasebe tanımı için geriye dönük ters muhasebe kaydı oluşturma yetkisi bulunmamaktadır." }, "message_available": true, "constant_name": "REVERSE_ACCOUNTING_BACKDATE_AUTHORITY" } ] } } }, "/accounting-entry-definitions": { "get": { "operationId": "get-accounting-entry-definition-list", "tags": [ "accounting-entry-definitions" ], "summary": "get-accounting-entry-definition-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "isActive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "isActive" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 6 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "description": { "type": "string", "x-aura-field-code": "description" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "isPreviousReverseEntry": { "type": "boolean", "x-aura-field-code": "isPreviousReverseEntry" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-definition-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountingEntryDefinitionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPreviousReverseEntry", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-accounting-entry-definition", "tags": [ "accounting-entry-definitions" ], "summary": "create-accounting-entry-definition", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionDescription" }, "isPreviousReverseEntry": { "type": "boolean", "x-aura-field-code": "isPreviousReverseEntry" }, "name": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionName" } }, "required": [ "code", "description", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-accounting-entry-definition", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsPreviousReverseEntry", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_125", "status": 400, "message": { "ar": "يوجد بالفعل تعريف قيد محاسبي بهذا الرمز '{0}'. يجب أن يكون رمز تعريف القيد المحاسبي فريدًا.", "en": "There is already an Accounting Entry Definition with the given code '{0}'. Accounting Entry Definition Code must be unique.", "tr": "Verilen '{0}' koduna sahip bir Muhasebe Giriş Tanımı zaten var. Muhasebe Giriş Tanım Kodu benzersiz olmalıdır." }, "message_available": true, "constant_name": null } ] } } }, "/accounting-entry-definitions/by-code/{code}": { "get": { "operationId": "get-accounting-entry-definition-by-code", "tags": [ "accounting-entry-definitions" ], "summary": "get-accounting-entry-definition-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionCode" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" }, "isActive": { "type": "boolean", "x-aura-field-code": "accountingEntryDefinitionIsActive" }, "isPreviousReverseEntry": { "type": "boolean", "x-aura-field-code": "isPreviousReverseEntry" }, "name": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionName" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-definition-by-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/by-code/{code}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEntryDefinitionDto", "payload": "AccountingEntryDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPreviousReverseEntry", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_127", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة بالكود المعطى '{0}'.", "en": "Accounting Entry Definition is not found with the given code '{0}'.", "tr": "Verilen '{0}' koduyla Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEFINITION_NOT_FOUND" } ] } } }, "/accounting-entry-definitions/by-code/{code}/id": { "get": { "operationId": "get-accounting-entry-definition-id-by-code", "tags": [ "accounting-entry-definitions" ], "summary": "get-accounting-entry-definition-id-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-definition-id-by-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/by-code/{code}/id", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/accounting-entry-definitions/{id}": { "get": { "operationId": "get-accounting-entry-definition-by-id", "tags": [ "accounting-entry-definitions" ], "summary": "get-accounting-entry-definition-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "description": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "isPreviousReverseEntry": { "type": "boolean", "x-aura-field-code": "isPreviousReverseEntry" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-definition-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEntryDefinitionDto", "payload": "AccountingEntryDefinitionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsPreviousReverseEntry", "declared_type": "bool?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" } ] } }, "put": { "operationId": "update-accounting-entry-definition", "tags": [ "accounting-entry-definitions" ], "summary": "update-accounting-entry-definition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionDescription" }, "isActive": { "type": "boolean", "x-aura-field-code": "accountingEntryDefinitionIsActive" }, "isPreviousReverseEntry": { "type": "boolean", "x-aura-field-code": "isPreviousReverseEntry" }, "name": { "type": "string", "x-aura-field-code": "accountingEntryDefinitionName" } }, "required": [ "description", "isActive", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-accounting-entry-definition", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsPreviousReverseEntry", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" } ] } } }, "/accounting-entry-definitions/{id}/conditions": { "get": { "operationId": "get-accounting-entry-condition-by-definition-id", "tags": [ "accounting-entry-definitions" ], "summary": "get-accounting-entry-condition-by-definition-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountingEntryDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" }, "code": { "type": "string", "x-aura-field-code": "accountingEntryConditionCode" }, "conditionFormula": { "type": "string", "x-aura-field-code": "conditionFormula" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryConditionId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-condition-by-definition-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/conditions", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "AccountingEntryConditionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountingEntryDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ConditionFormula", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" } ] } }, "post": { "operationId": "create-accounting-entry-condition", "tags": [ "accounting-entry-definitions" ], "summary": "create-accounting-entry-condition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "accountingEntryConditionCode" }, "conditionFormula": { "type": "string", "x-aura-field-code": "conditionFormula" } }, "required": [ "code", "conditionFormula" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryConditionId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-accounting-entry-condition", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/conditions", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ConditionFormula", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_122", "status": 400, "message": { "ar": "هناك شرط بالفعل في تعريف قيد المحاسبة بنفس الرمز.", "en": "There is already a condition under the accounting entry definition with the same code.", "tr": "Zaten muhasebe girişi tanımında aynı koda sahip bir koşul var." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_CONDITION_CODE_MUST_BE_UNIQUE" }, { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" } ] } } }, "/accounting-entry-definitions/{id}/conditions/{conditionId}": { "delete": { "operationId": "delete-accounting-entry-condition", "tags": [ "accounting-entry-definitions" ], "summary": "delete-accounting-entry-condition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" } }, { "name": "conditionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryConditionId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-accounting-entry-condition", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/conditions/{conditionId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ConditionId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_128", "status": 400, "message": { "ar": "لم يتم العثور على شرط قيد المحاسبة بالمعرف '{0}'.", "en": "Accounting Entry Condition is not found with the given ConditionId '{0}'.", "tr": "Verilen Koşul Kimliği '{0}' ile Muhasebe Giriş Koşulu bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_CONDITION_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_129", "status": 400, "message": { "ar": "شرط قيد المحاسبة '{0}' مستخدم في تفاصيل تعريف قيد المحاسبة. لا يمكن حذفه.", "en": "Accounting Entry Condition '{0}' is used in Accounting Entry Definition Detail. It cannot be deleted.", "tr": "Muhasebe Giriş Koşulu '{0}', Muhasebe Giriş Tanımı Detayında kullanılıyor. Silinemez." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_CONDITION_USED_IN_ACCOUNTING_ENTRY_DEFINITION_DETAIL" } ] } }, "get": { "operationId": "get-accounting-entry-condition", "tags": [ "accounting-entry-definitions" ], "summary": "get-accounting-entry-condition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "conditionId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" }, "code": { "type": "string", "x-aura-field-code": "accountingEntryConditionCode" }, "conditionFormula": { "type": "string", "x-aura-field-code": "conditionFormula" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryConditionId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-condition", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/conditions/{conditionId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ConditionId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AccountingEntryConditionDto", "payload": "AccountingEntryConditionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "AccountingEntryDefinitionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ConditionFormula", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_128", "status": 400, "message": { "ar": "لم يتم العثور على شرط قيد المحاسبة بالمعرف '{0}'.", "en": "Accounting Entry Condition is not found with the given ConditionId '{0}'.", "tr": "Verilen Koşul Kimliği '{0}' ile Muhasebe Giriş Koşulu bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_CONDITION_IS_NOT_FOUND" } ] } }, "put": { "operationId": "update-accounting-entry-condition", "tags": [ "accounting-entry-definitions" ], "summary": "update-accounting-entry-condition", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" } }, { "name": "conditionId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryConditionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "accountingEntryConditionCode" }, "conditionFormula": { "type": "string", "x-aura-field-code": "conditionFormula" } }, "required": [ "code", "conditionFormula" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-accounting-entry-condition", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/conditions/{conditionId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ConditionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ConditionFormula", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_122", "status": 400, "message": { "ar": "هناك شرط بالفعل في تعريف قيد المحاسبة بنفس الرمز.", "en": "There is already a condition under the accounting entry definition with the same code.", "tr": "Zaten muhasebe girişi tanımında aynı koda sahip bir koşul var." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_CONDITION_CODE_MUST_BE_UNIQUE" }, { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_128", "status": 400, "message": { "ar": "لم يتم العثور على شرط قيد المحاسبة بالمعرف '{0}'.", "en": "Accounting Entry Condition is not found with the given ConditionId '{0}'.", "tr": "Verilen Koşul Kimliği '{0}' ile Muhasebe Giriş Koşulu bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_CONDITION_IS_NOT_FOUND" } ] } } }, "/accounting-entry-definitions/{id}/details": { "get": { "operationId": "get-accounting-entry-definition-detail-by-definition-id", "tags": [ "accounting-entry-definitions" ], "summary": "get-accounting-entry-definition-detail-by-definition-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryConditionCode": { "type": "string", "x-aura-field-code": "accountingEntryConditionCode" }, "accountingEntryConditionId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryConditionId" }, "detailId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionDetailId" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "refAccountNumber": { "type": "string", "x-aura-field-code": "refAccountNumber" }, "refAmount": { "type": "string", "x-aura-field-code": "refAmount" }, "refCurrencyNumber": { "type": "string", "x-aura-field-code": "refCurrencyNumber" }, "refDescription": { "type": "string", "x-aura-field-code": "refDescription" }, "refExchangeRate": { "type": "string", "x-aura-field-code": "refExchangeRate" }, "refExchangeSpreadType": { "type": "string", "x-aura-field-code": "refExchangeSpreadType" }, "refOrganizationCode": { "type": "string", "x-aura-field-code": "refOrganizationCode" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-accounting-entry-definition-detail-by-definition-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/details", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "DetailEntryDto", "collection": true, "members": [ { "name": "DetailId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountingEntryConditionId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountingEntryConditionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FinancialTransactionCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EntryDirection", "declared_type": "int", "nullable": false, "collection": false }, { "name": "OrdinalPosition", "declared_type": "int", "nullable": false, "collection": false }, { "name": "RefOrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefAmount", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefCurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefExchangeRate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefExchangeSpreadType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RefDescription", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" } ] } }, "post": { "operationId": "create-accounting-entry-definition-detail", "tags": [ "accounting-entry-definitions" ], "summary": "create-accounting-entry-definition-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionDetails": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryConditionCode": { "type": "string", "x-aura-field-code": "accountingEntryConditionCode" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "refAccountNumber": { "type": "string", "x-aura-field-code": "refAccountNumber" }, "refAmount": { "type": "string", "x-aura-field-code": "refAmount" }, "refCurrencyNumber": { "type": "string", "x-aura-field-code": "refCurrencyNumber" }, "refDescription": { "type": "string", "x-aura-field-code": "refDescription" }, "refExchangeRate": { "type": "string", "x-aura-field-code": "refExchangeRate" }, "refExchangeSpreadType": { "type": "string", "x-aura-field-code": "refExchangeSpreadType" }, "refOrganizationCode": { "type": "string", "x-aura-field-code": "refOrganizationCode" } }, "required": [ "entryDirection", "financialTransactionCode", "ordinalPosition", "refAmount", "refCurrencyNumber", "refDescription", "refExchangeRate", "refExchangeSpreadType", "refOrganizationCode" ], "x-aura-field-code": "accountingEntryDefinitionDetails" } } }, "required": [ "accountingEntryDefinitionDetails" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-accounting-entry-definition-detail", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_123", "status": 400, "message": { "ar": "لم يتم العثور على شرط قيد المحاسبة باستخدام الرمز المعطى '{0}'.", "en": "Accounting Entry Condition is not found with the given code '{0}'.", "tr": "Verilen '{0}' koduyla Muhasebe Giriş Koşulu bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_CONDITION_NOT_FOUND_BY_CODE" }, { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_130", "status": 400, "message": { "ar": "'التسلسل' هو قيمة فريدة لتعريف قيد المحاسبة. لا يمكن تكراره في تفاصيل تعريف قيد المحاسبة.", "en": "'sequence' is a unique value for Accounting Entry Definition. It cannot be repeated in Accounting Entry Definition Detail.", "tr": "'sıra', Muhasebe Giriş Tanımı için benzersiz bir değerdir. Muhasebe Giriş Tanımı Detayında tekrarlanamaz." }, "message_available": true, "constant_name": "SEQUENCE_IS_UNIQUE_VALUE_FOR_ACCOUNTING_ENTRY_DEFINITION" }, { "code": "ERR_ACCTNG_131", "status": 400, "message": { "ar": "يجب أن يتضمن تعريف قيد المحاسبة على الأقل سطرًا دائنًا وسطرًا مدينًا.", "en": "Accounting Entry Definition Detail must include at least one Credit line and one Debit line.", "tr": "Muhasebe Giriş Tanımı Detayı en az bir Kredi limiti ve bir Borç limiti içermelidir." }, "message_available": true, "constant_name": "DEFINITION_DETAIL_MUST_INCLUDE_AT_LEAST_ONE_CREDIT_OR_DEBIT_LINE" }, { "code": "ERR_ACCTNG_132", "status": 400, "message": { "ar": "يجب أن يكون 'entryDirection' متوافقًا مع محتوى المعاملة المالية '{0}'.", "en": "'entryDirection' must be compatible with the Financial Transaction '{0}' content.", "tr": "'entryDirection', Finansal İşlem '{0}' içeriğiyle uyumlu olmalıdır." }, "message_available": true, "constant_name": "ENTRYDIRECTION_MUST_BE_COMPATIBLE_WITH_THE_FINANCIAL_TRANSACTION_CONTENT" }, { "code": "ERR_ACCTNG_133", "status": 400, "message": { "ar": "العملية المالية '{0}' غير موجودة. لا يمكن استخدامها في تفاصيل تعريف قيد المحاسبة.", "en": "Financial transaction '{0}' is not existing. It cannot be used in Accounting Entry Definition Detail.", "tr": "'{0}' mali işlemi mevcut değil. Muhasebe Giriş Tanımı Detayında kullanılamaz." }, "message_available": true, "constant_name": "FINANCIAL_TRANSACTION_IS_NOT_EXISTING" } ] } }, "put": { "operationId": "update-accounting-entry-definition-detail", "tags": [ "accounting-entry-definitions" ], "summary": "update-accounting-entry-definition-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryDefinitionDetails": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryConditionCode": { "type": "string", "x-aura-field-code": "accountingEntryConditionCode" }, "detailId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionDetailId" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "refAccountNumber": { "type": "string", "x-aura-field-code": "refAccountNumber" }, "refAmount": { "type": "string", "x-aura-field-code": "refAmount" }, "refCurrencyNumber": { "type": "string", "x-aura-field-code": "refCurrencyNumber" }, "refDescription": { "type": "string", "x-aura-field-code": "refDescription" }, "refExchangeRate": { "type": "string", "x-aura-field-code": "refExchangeRate" }, "refExchangeSpreadType": { "type": "string", "x-aura-field-code": "refExchangeSpreadType" }, "refOrganizationCode": { "type": "string", "x-aura-field-code": "refOrganizationCode" } }, "required": [ "detailId", "entryDirection", "financialTransactionCode", "ordinalPosition", "refAmount", "refCurrencyNumber", "refDescription", "refExchangeRate", "refExchangeSpreadType", "refOrganizationCode" ], "x-aura-field-code": "accountingEntryDefinitionDetails" } } }, "required": [ "accountingEntryDefinitionDetails" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-accounting-entry-definition-detail", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_123", "status": 400, "message": { "ar": "لم يتم العثور على شرط قيد المحاسبة باستخدام الرمز المعطى '{0}'.", "en": "Accounting Entry Condition is not found with the given code '{0}'.", "tr": "Verilen '{0}' koduyla Muhasebe Giriş Koşulu bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_CONDITION_NOT_FOUND_BY_CODE" }, { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_130", "status": 400, "message": { "ar": "'التسلسل' هو قيمة فريدة لتعريف قيد المحاسبة. لا يمكن تكراره في تفاصيل تعريف قيد المحاسبة.", "en": "'sequence' is a unique value for Accounting Entry Definition. It cannot be repeated in Accounting Entry Definition Detail.", "tr": "'sıra', Muhasebe Giriş Tanımı için benzersiz bir değerdir. Muhasebe Giriş Tanımı Detayında tekrarlanamaz." }, "message_available": true, "constant_name": "SEQUENCE_IS_UNIQUE_VALUE_FOR_ACCOUNTING_ENTRY_DEFINITION" }, { "code": "ERR_ACCTNG_131", "status": 400, "message": { "ar": "يجب أن يتضمن تعريف قيد المحاسبة على الأقل سطرًا دائنًا وسطرًا مدينًا.", "en": "Accounting Entry Definition Detail must include at least one Credit line and one Debit line.", "tr": "Muhasebe Giriş Tanımı Detayı en az bir Kredi limiti ve bir Borç limiti içermelidir." }, "message_available": true, "constant_name": "DEFINITION_DETAIL_MUST_INCLUDE_AT_LEAST_ONE_CREDIT_OR_DEBIT_LINE" }, { "code": "ERR_ACCTNG_132", "status": 400, "message": { "ar": "يجب أن يكون 'entryDirection' متوافقًا مع محتوى المعاملة المالية '{0}'.", "en": "'entryDirection' must be compatible with the Financial Transaction '{0}' content.", "tr": "'entryDirection', Finansal İşlem '{0}' içeriğiyle uyumlu olmalıdır." }, "message_available": true, "constant_name": "ENTRYDIRECTION_MUST_BE_COMPATIBLE_WITH_THE_FINANCIAL_TRANSACTION_CONTENT" }, { "code": "ERR_ACCTNG_133", "status": 400, "message": { "ar": "العملية المالية '{0}' غير موجودة. لا يمكن استخدامها في تفاصيل تعريف قيد المحاسبة.", "en": "Financial transaction '{0}' is not existing. It cannot be used in Accounting Entry Definition Detail.", "tr": "'{0}' mali işlemi mevcut değil. Muhasebe Giriş Tanımı Detayında kullanılamaz." }, "message_available": true, "constant_name": "FINANCIAL_TRANSACTION_IS_NOT_EXISTING" }, { "code": "ERR_ACCTNG_135", "status": 400, "message": { "ar": "لم يتم العثور على تفاصيل تعريف قيد المحاسبة '{0}'.", "en": "Accounting Entry Definition Detail '{0}' is not found.", "tr": "Muhasebe Giriş Tanımı Detayı '{0}' bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEFINITION_DETAIL_IS_NOT_FOUND" } ] } } }, "/accounting-entry-definitions/{id}/details/{detailId}": { "delete": { "operationId": "delete-accounting-entry-definition-detail", "tags": [ "accounting-entry-definitions" ], "summary": "delete-accounting-entry-definition-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionId" } }, { "name": "detailId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryDefinitionDetailId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-accounting-entry-definition-detail", "x-aura-domain": "accounting", "x-aura-raw-url-path": "accounting-entry-definitions/{id}/details/{detailId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DetailId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_126", "status": 400, "message": { "ar": "لم يتم العثور على تعريف قيد المحاسبة باستخدام المعرف المقدم '{0}'.", "en": "Accounting Entry Definition is not found with the given Id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Muhasebe Giriş Tanımı bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEF_ID_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_131", "status": 400, "message": { "ar": "يجب أن يتضمن تعريف قيد المحاسبة على الأقل سطرًا دائنًا وسطرًا مدينًا.", "en": "Accounting Entry Definition Detail must include at least one Credit line and one Debit line.", "tr": "Muhasebe Giriş Tanımı Detayı en az bir Kredi limiti ve bir Borç limiti içermelidir." }, "message_available": true, "constant_name": "DEFINITION_DETAIL_MUST_INCLUDE_AT_LEAST_ONE_CREDIT_OR_DEBIT_LINE" }, { "code": "ERR_ACCTNG_135", "status": 400, "message": { "ar": "لم يتم العثور على تفاصيل تعريف قيد المحاسبة '{0}'.", "en": "Accounting Entry Definition Detail '{0}' is not found.", "tr": "Muhasebe Giriş Tanımı Detayı '{0}' bulunamadı." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_DEFINITION_DETAIL_IS_NOT_FOUND" } ] } } }, "/balances/by-account-list": { "get": { "operationId": "get-balance-by-account-list", "tags": [ "balances" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Get Balance By Account Number List", "description": "Invokes the `get-balance-by-account-list` service definition through `GET /balances/by-account-list`.\n\nTurkish display name: Hesap Numara Listesi ile Bakiye Getiren Api", "parameters": [ { "name": "accounts", "in": "query", "required": true, "schema": { "type": "array", "items": { "type": "object", "x-aura-field-code": "accounts" } } }, { "name": "balanceDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "balanceDate" } }, { "name": "ledgers", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "object", "x-aura-field-code": "ledgers" } } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 3 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "ledgers": { "type": "array", "items": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "totalBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "totalBalance" } }, "x-aura-field-code": "ledgers" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-balance-by-account-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "balances/by-account-list", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BalanceDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "AccountListBalanceDto", "collection": true, "members": [ { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Ledgers", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/balances/by-gl-code/{glCode}": { "get": { "operationId": "get-balance-by-gLCode", "tags": [ "balances" ], "summary": "get-balance-by-gLCode", "parameters": [ { "name": "glCode", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" }, { "name": "accountNumber", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "currency", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "gLCode", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "transactionDate", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 4 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "x-aura-type": "unresolved" }, "balanceList": { "type": "object", "properties": { "creditBalance": { "x-aura-type": "unresolved" }, "currency": { "x-aura-type": "unresolved" }, "debitBalance": { "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "gLCode": { "x-aura-type": "unresolved" }, "transactionDate": { "x-aura-type": "unresolved" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-balance-by-gLCode", "x-aura-domain": "accounting", "x-aura-raw-url-path": "balances/by-gl-code/{glCode}", "x-aura-code-response": { "state": "structure", "declared_type": "GLBalanceDto", "payload": "GLBalanceDto", "collection": false, "members": [ { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "GLCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Balances", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_160", "status": 400, "message": { "ar": "لم يُعثر على رمز GL '{0}'.", "en": "GL Code '{0}' is not found.", "tr": "GL Kodu '{0}' bulunamadı." }, "message_available": true, "constant_name": "GL_CODE_NOT_FOUND" }, { "code": "ERR_ACCTNG_239", "status": 400, "message": { "en": "Currency is not found." }, "message_available": true, "constant_name": "CURRENCY_NUMBER_IS_NOT_VALID" } ] } } }, "/batch-accounting-entry-files": { "post": { "operationId": "create-batch-accounting-entry-file", "tags": [ "batch-accounting-entry-files" ], "summary": "create-batch-accounting-entry-file", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryList": { "type": "array", "items": { "type": "object", "properties": { "accountingEntryDetails": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "entryDirection": { "type": "integer", "format": "int32", "x-aura-field-code": "entryDirection" }, "exchangeRate": { "type": "number", "format": "decimal", "x-aura-field-code": "exchangeRate" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "glCode": { "type": "string", "x-aura-field-code": "glCode" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" } }, "required": [ "accountNumber", "amount", "currencyNumber", "description", "entryDirection", "exchangeRate", "exchangeSpreadType", "glCode", "ordinalPosition", "organizationCode" ], "x-aura-field-code": "accountingEntryDetails" } }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDescription" }, "orderNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "batchAccountingorderNumber" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } }, "required": [ "accountingEntryDetails", "description", "orderNumber", "transactionDate" ], "x-aura-field-code": "accountingEntryList" } }, "fileName": { "type": "string", "x-aura-field-code": "fileName" }, "userCode": { "type": "string", "x-aura-field-code": "userCode" } }, "required": [ "accountingEntryList", "fileName", "userCode" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-batch-accounting-entry-file", "x-aura-domain": "accounting", "x-aura-raw-url-path": "batch-accounting-entry-files", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FileName", "declared_type": null, "nullable": false, "collection": false }, { "name": "UserCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/batch-accounting-entry-files/{id}": { "put": { "operationId": "process-batch-accounting-entry-file", "tags": [ "batch-accounting-entry-files" ], "summary": "process-batch-accounting-entry-file", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "batchAccountingEntryFileId" } } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "process-batch-accounting-entry-file", "x-aura-domain": "accounting", "x-aura-raw-url-path": "batch-accounting-entry-files/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/batch-accounting-entry-files/{id}/batch-accounting-entries/{batchAccountingEntryId}": { "put": { "operationId": "update-batch-accounting-entry", "tags": [ "batch-accounting-entry-files" ], "summary": "update-batch-accounting-entry", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "batchAccountingEntryFileId" } }, { "name": "batchAccountingEntryId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "batchAccountingEntryId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "processResult": { "type": "string", "x-aura-field-code": "batchAccountingProcessResult" }, "processStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "batchAccountingProcessStatus", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "batch_process_status", "values": [ { "value": 1, "name": "uploaded", "labels": { "en": "Uploaded", "tr": "Yüklendi", "ar": "تم الرفع" } }, { "value": 2, "name": "success", "labels": { "en": "Accounting entry success", "tr": "Fiş başarılı kesildi", "ar": "نجاح قيد المحاسبة" } }, { "value": 3, "name": "error", "labels": { "en": "Accounting Entry Error", "tr": "Fiş kesme esnasında problem oluştu", "ar": "خطأ في قيد المحاسبة" } } ] } } }, "required": [ "accountingEntryId", "processResult", "processStatus" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-batch-accounting-entry", "x-aura-domain": "accounting", "x-aura-raw-url-path": "batch-accounting-entry-files/{id}/batch-accounting-entries/{batchAccountingEntryId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "BatchAccountingEntryId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProcessStatus", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProcessResult", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingEntryId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/batch-catalog": { "post": { "operationId": "accounting-batch-catalog", "tags": [ "batch-catalog" ], "summary": "accounting-batch-catalog", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "sequenceNumber" }, "serviceCode": { "type": "string", "x-aura-field-code": "serviceCode" }, "variables": { "type": "object", "x-aura-field-code": "batch_variables" } }, "required": [ "serviceCode", "variables" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-batch-catalog", "x-aura-domain": "accounting", "x-aura-raw-url-path": "batch-catalog", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route declares `IEnumerable`. `object` is the C# base type, so the code states that a body is returned and declines to say what is in it — the shape is chosen at runtime, and the body is a JSON array whose elements need not share a shape. That is the declaration, not a failure to read it, and nothing here narrows it.", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "object" } } }, "/caches/refresh": { "post": { "operationId": "accounting-refresh-cache", "tags": [ "caches" ], "summary": "accounting-refresh-cache", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "x-aura-type": "unresolved" } }, "required": [ "key" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a collection.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-refresh-cache", "x-aura-domain": "accounting", "x-aura-raw-url-path": "caches/refresh", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "RefreshCacheDto", "collection": true, "members": [ { "name": "Key", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSuccess", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_AURA_2", "status": 400, "message": null, "message_available": false, "constant_name": "CACHE_REFRESH_INPUT_MISSING" } ] } } }, "/compensating-transactions/commit": { "post": { "operationId": "accounting-commit-compensating-transaction", "tags": [ "compensating-transactions" ], "summary": "accounting-commit-compensating-transaction", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-commit-compensating-transaction", "x-aura-domain": "accounting", "x-aura-raw-url-path": "compensating-transactions/commit", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/compensating-transactions/rollback": { "post": { "operationId": "accounting-rollback-compensating-transaction", "tags": [ "compensating-transactions" ], "summary": "accounting-rollback-compensating-transaction", "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-rollback-compensating-transaction", "x-aura-domain": "accounting", "x-aura-raw-url-path": "compensating-transactions/rollback", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/daily-balances": { "post": { "operationId": "create-daily-balance", "tags": [ "daily-balances" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Insert daily balances", "description": "Invokes the `create-daily-balance` service definition through `POST /daily-balances`.\n\nTurkish display name: Geriye dönük bakiyeleri ekle", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-daily-balance", "x-aura-domain": "accounting", "x-aura-raw-url-path": "daily-balances", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "TransactionDate", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_245", "status": 400, "message": null, "message_available": false, "constant_name": "DAILY_BALANCE_PROCESSING" }, { "code": "ERR_ACCTNG_246", "status": 400, "message": null, "message_available": false, "constant_name": "DAILY_BALANCE_CAN_RUN_ONCE_A_DAY" } ] } }, "put": { "operationId": "update-daily-balance", "tags": [ "daily-balances" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Update daily balances", "description": "Invokes the `update-daily-balance` service definition through `PUT /daily-balances`.\n\nTurkish display name: Geriye dönük bakiyeleri güncelle", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-daily-balance", "x-aura-domain": "accounting", "x-aura-raw-url-path": "daily-balances", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_174", "status": 400, "message": { "ar": "لم يتم العثور على قيد المحاسبة بالمعرف المُعطى: «{0}»", "en": "Accounting Entry is not found with the given Id : ‘{0}’.", "tr": "Verilen Kimlikle Muhasebe Girişi bulunamadı: '{0}'." }, "message_available": true, "constant_name": "ACCOUNTING_ENTRY_NOT_FOUND" } ] } } }, "/data-migrations": { "get": { "operationId": "accounting-get-data-migration-list", "tags": [ "data-migrations" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Returns data migration records", "description": "Invokes the `accounting-get-data-migration-list` service definition through `GET /data-migrations`.\n\nTurkish display name: Data migration listesini döner", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-data-migration-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "data-migrations", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "DataMigrationDto", "collection": true, "members": [ { "name": "Id", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TableName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastCommittedId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LastCommittedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "Script", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Parameters", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasError", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ErrorMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DatabaseName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "TransactionStatus", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/extended-properties": { "get": { "operationId": "accounting-get-extended-property-list", "tags": [ "extended-properties" ], "summary": "accounting-get-extended-property-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "entityId": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "isParametric": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parameterCode": { "x-aura-type": "unresolved" }, "parameterKey": { "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-extended-property-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "extended-properties", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "accounting-create-extended-property", "tags": [ "extended-properties" ], "summary": "accounting-create-extended-property", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "string", "x-aura-field-code": "entityId" }, "isParametric": { "type": "boolean", "x-aura-field-code": "isParametric" }, "name": { "type": "string", "x-aura-field-code": "extendedPropertyName" }, "parameterCode": { "type": "string", "x-aura-field-code": "parameterCode" }, "parameterKey": { "type": "string", "x-aura-field-code": "parameterKey" } }, "required": [ "entityId", "isParametric", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-create-extended-property", "x-aura-domain": "accounting", "x-aura-raw-url-path": "extended-properties", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/extended-properties/{id}": { "put": { "operationId": "accounting-update-extended-property", "tags": [ "extended-properties" ], "summary": "accounting-update-extended-property", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "extendedPropertyId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "entityId": { "type": "string", "x-aura-field-code": "entityId" }, "isActive": { "x-aura-type": "unresolved" }, "isParametric": { "x-aura-type": "unresolved" }, "parameterCode": { "x-aura-type": "unresolved" }, "parameterKey": { "x-aura-type": "unresolved" } }, "required": [ "entityId", "isActive", "isParametric", "parameterCode", "parameterKey" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-update-extended-property", "x-aura-domain": "accounting", "x-aura-raw-url-path": "extended-properties/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/financial-statement-templates": { "get": { "operationId": "get-statement-template-list", "tags": [ "financial-statement-templates" ], "summary": "get-statement-template-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "x-aura-field-code": "filterParameters" } }, "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "statementTemplateDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" }, "name": { "type": "string", "x-aura-field-code": "statementTemplateName" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-statement-template-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "StatementTemplateDto", "collection": true, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-statement-template", "tags": [ "financial-statement-templates" ], "summary": "create-statement-template", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "financialStatementTemplateDescription" }, "name": { "type": "string", "x-aura-field-code": "financialStatementTemplateName" } }, "required": [ "description", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-statement-template", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/financial-statement-templates/{id}": { "delete": { "operationId": "delete-statement-template", "tags": [ "financial-statement-templates" ], "summary": "delete-statement-template", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-statement-template", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" } ] } }, "get": { "operationId": "get-statement-template-by-id", "tags": [ "financial-statement-templates" ], "summary": "get-statement-template-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "financialStatementTemplateDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "name": { "type": "string", "x-aura-field-code": "financialStatementTemplateName" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-statement-template-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "StatementTemplateDto", "payload": "StatementTemplateDto", "collection": false, "members": [ { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" } ] } }, "put": { "operationId": "update-statement-template", "tags": [ "financial-statement-templates" ], "summary": "update-statement-template", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "statementTemplateDescription" }, "name": { "type": "string", "x-aura-field-code": "statementTemplateName" } }, "required": [ "description", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-statement-template", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" } ] } } }, "/financial-statement-templates/{id}/items": { "get": { "operationId": "get-statement-template-item-and-details-by-template-id", "tags": [ "financial-statement-templates" ], "summary": "get-statement-template-item-and-details-by-template-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "calculationResource": { "type": "integer", "format": "int32", "x-aura-field-code": "templateItemCalculationResource" }, "code": { "type": "string", "x-aura-field-code": "financialStatementTemplateItemCode" }, "details": { "type": "array", "items": { "type": "object", "properties": { "calcFinancialStatementTemplateItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "calcFinancialStatementTemplateItemId" }, "calcLedgerCode": { "type": "string", "x-aura-field-code": "calcLedgerCode" }, "effectType": { "type": "integer", "format": "int32", "enum": [ 1, 2 ], "x-aura-field-code": "statementItemDetailEffectType", "x-aura-enum": { "parameter": "effect_type", "values": [ { "value": 1, "name": "Add", "labels": { "ar": "إضافة" } }, { "value": 2, "name": "Subtract", "labels": { "ar": "طرح" } } ] }, "description": "Permitted values (2):\n\n- `1` — Add (ar: إضافة)\n- `2` — Subtract (ar: طرح)" }, "financialStatementTemplateDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateDetailId" } }, "x-aura-field-code": "statementTemplateItemDetails" } }, "financialStatementTemplateItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateItemId" }, "isAbsolute": { "type": "boolean", "x-aura-field-code": "isAbsoluteTemplateItem" }, "isSummary": { "type": "boolean", "x-aura-field-code": "isSummaryTemplateItem" }, "name": { "type": "string", "x-aura-field-code": "financialStatementTemplateItemName" }, "parentFinancialStatementTemplateItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentFinancialStatementTemplateItemId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-statement-template-item-and-details-by-template-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}/items", "x-aura-capabilities": { "filtering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "StatementTemplateItemDto", "collection": true, "members": [ { "name": "FinancialStatementTemplateItemId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSummary", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsAbsolute", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CalculationResource", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ParentFinancialStatementTemplateItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Details", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" } ] } }, "post": { "operationId": "create-statement-template-item", "tags": [ "financial-statement-templates" ], "summary": "create-statement-template-item", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "financialStatementTemplateItems": { "type": "array", "items": { "type": "object", "properties": { "calculationResource": { "type": "integer", "format": "int32", "x-aura-field-code": "templateItemCalculationResource" }, "code": { "type": "string", "x-aura-field-code": "financialStatementTemplateItemCode" }, "details": { "type": "array", "items": { "type": "object", "properties": { "calcFinancialStatementTemplateItemCode": { "type": "string", "x-aura-field-code": "calcFinancialStatementTemplateItemCode" }, "calcLedgerCode": { "type": "string", "x-aura-field-code": "calcLedgerCode" }, "effectType": { "type": "integer", "format": "int32", "enum": [ 1, 2 ], "x-aura-field-code": "statementItemDetailEffectType", "x-aura-enum": { "parameter": "effect_type", "values": [ { "value": 1, "name": "Add", "labels": { "ar": "إضافة" } }, { "value": 2, "name": "Subtract", "labels": { "ar": "طرح" } } ] }, "description": "Permitted values (2):\n\n- `1` — Add (ar: إضافة)\n- `2` — Subtract (ar: طرح)" } }, "x-aura-field-code": "statementTemplateItemDetails" } }, "isAbsolute": { "type": "boolean", "x-aura-field-code": "isAbsoluteTemplateItem" }, "isSummary": { "type": "boolean", "x-aura-field-code": "isSummaryTemplateItem" }, "name": { "type": "string", "x-aura-field-code": "financialStatementTemplateItemName" }, "parentFinancialStatementTemplateItemCode": { "type": "string", "x-aura-field-code": "parentFinancialStatementTemplateItemCode" } }, "required": [ "code", "isAbsolute", "isSummary", "name" ], "x-aura-field-code": "financialStatementTemplateItems" } } }, "required": [ "financialStatementTemplateItems" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateItemId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-statement-template-item", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}/items", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_21", "status": 400, "message": { "ar": "السجل '{0}' غير موجود", "en": "Ledger '{0}' is not found", "tr": "'{0}' defteri bulunamadı" }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NOT_NULL" }, { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_222", "status": 400, "message": { "ar": "العناصر التي تنتمي إلى نموذج لا يمكن أن تكون لها نفس الاسم.", "en": "Items belong to a template cannot have same name.", "tr": "Bir şablona ait öğeler aynı ada sahip olamaz." }, "message_available": true, "constant_name": "DUPLICATE_TEMPLATE_ITEM_NAME_NOT_ALLOWED" }, { "code": "ERR_ACCTNG_223", "status": 400, "message": { "ar": "تفاصيل مورد الحساب والعنصر النموذجي غير متطابقة.", "en": "Calculation resource and template item detail is not matched.", "tr": "Hesaplama kaynağı ve şablon öğesi ayrıntıları eşleşmiyor." }, "message_available": true, "constant_name": "CALCULATION_RESOURCE_AND_TEMPLATE_ITEM_DETAIL_IS_NOT_MATCHED" }, { "code": "ERR_ACCTNG_224", "status": 400, "message": { "ar": "عنصر واحد أو أكثر في القائمة التالية غير موجود. '{0}'", "en": "One or more items in the following list\nis not found. '{0}'", "tr": "Aşağıdaki listedeki bir veya daha fazla öğe" }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND" }, { "code": "ERR_ACCTNG_227", "status": 400, "message": { "ar": "لا يمكن أن تحتوي العناصر التابعة لنموذج على نفس الرمز.", "en": "Items belong to a template cannot have same code.", "tr": "Bir şablona ait öğeler aynı koda sahip olamaz." }, "message_available": true, "constant_name": "DUPLICATE_TEMPLATE_ITEM_CODE_NOT_ALLOWED" }, { "code": "ERR_ACCTNG_228", "status": 400, "message": { "ar": "لا يُسمح للبنود الملخصة بوجود تفاصيل.", "en": "It is not allowed summary items to have details.", "tr": "Özet öğelerinin ayrıntı içermesine izin verilmez." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_DETAIL_MUST_BE_EMPTY_FOR_SUMMERY" } ] } } }, "/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}": { "delete": { "operationId": "delete-statement-template-item", "tags": [ "financial-statement-templates" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Delete Statement Template Item", "description": "Invokes the `delete-statement-template-item` service definition through `DELETE /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } }, { "name": "financialStatementTemplateItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateItemId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-statement-template-item", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}/items/{financialStatementTemplateItemId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FinancialStatementTemplateItemId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_224", "status": 400, "message": { "ar": "عنصر واحد أو أكثر في القائمة التالية غير موجود. '{0}'", "en": "One or more items in the following list\nis not found. '{0}'", "tr": "Aşağıdaki listedeki bir veya daha fazla öğe" }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND" }, { "code": "ERR_ACCTNG_229", "status": 400, "message": { "ar": "عنصر قالب البيان المالي يُستخدم كتفصيل ضمن عنصر قالب مختلف. لا يمكن حذفه.", "en": "Financial statement template item is used as detail in a different template item. It cannot be delete", "tr": "Mali tablo şablon kalemi farklı bir şablon kaleminde detay olarak kullanılıyor. Silinemez\n" }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_IS_USED_CANNOT_BE_DELETED" } ] } }, "post": { "operationId": "create-statement-template-item-detail", "tags": [ "financial-statement-templates" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Create Statement Template Item", "description": "Invokes the `create-statement-template-item-detail` service definition through `POST /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } }, { "name": "financialStatementTemplateItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateItemId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "calcFinancialStatementTemplateItemCode": { "type": "string", "x-aura-field-code": "calcFinancialStatementTemplateItemCode" }, "calcLedgerCode": { "type": "string", "x-aura-field-code": "calcLedgerCode" }, "effectType": { "type": "integer", "format": "int32", "enum": [ 1, 2 ], "x-aura-field-code": "statementItemDetailEffectType", "x-aura-enum": { "parameter": "effect_type", "values": [ { "value": 1, "name": "Add", "labels": { "ar": "إضافة" } }, { "value": 2, "name": "Subtract", "labels": { "ar": "طرح" } } ] }, "description": "Permitted values (2):\n\n- `1` — Add (ar: إضافة)\n- `2` — Subtract (ar: طرح)" } }, "required": [ "effectType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateDetailId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-statement-template-item-detail", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}/items/{financialStatementTemplateItemId}", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "put": { "operationId": "update-statement-template-item", "tags": [ "financial-statement-templates" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Update Statement Template Item", "description": "Invokes the `update-statement-template-item` service definition through `PUT /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } }, { "name": "financialStatementTemplateItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateItemId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "calculationResource": { "type": "integer", "format": "int32", "x-aura-field-code": "templateItemCalculationResource", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "calculation_resource", "values": [ { "value": 1, "name": "Ledger", "labels": { "ar": "دفتر الحسابات" } }, { "value": 2, "name": "financial_statement_item", "labels": { "ar": "عنصر البيان المالي" } } ] } }, "code": { "type": "string", "x-aura-field-code": "financialStatementTemplateItemCode" }, "isAbsolute": { "type": "boolean", "x-aura-field-code": "isAbsoluteTemplateItem" }, "isSummary": { "type": "boolean", "x-aura-field-code": "isSummaryTemplateItem" }, "name": { "type": "string", "x-aura-field-code": "financialStatementTemplateItemName" }, "parentFinancialStatementTemplateItemCode": { "type": "string", "x-aura-field-code": "parentFinancialStatementTemplateItemCode" } }, "required": [ "code", "isAbsolute", "isSummary", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-statement-template-item", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}/items/{financialStatementTemplateItemId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FinancialStatementTemplateItemId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsSummary", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsAbsolute", "declared_type": null, "nullable": true, "collection": false }, { "name": "CalculationResource", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParentFinancialStatementTemplateItemCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_222", "status": 400, "message": { "ar": "العناصر التي تنتمي إلى نموذج لا يمكن أن تكون لها نفس الاسم.", "en": "Items belong to a template cannot have same name.", "tr": "Bir şablona ait öğeler aynı ada sahip olamaz." }, "message_available": true, "constant_name": "DUPLICATE_TEMPLATE_ITEM_NAME_NOT_ALLOWED" }, { "code": "ERR_ACCTNG_223", "status": 400, "message": { "ar": "تفاصيل مورد الحساب والعنصر النموذجي غير متطابقة.", "en": "Calculation resource and template item detail is not matched.", "tr": "Hesaplama kaynağı ve şablon öğesi ayrıntıları eşleşmiyor." }, "message_available": true, "constant_name": "CALCULATION_RESOURCE_AND_TEMPLATE_ITEM_DETAIL_IS_NOT_MATCHED" }, { "code": "ERR_ACCTNG_224", "status": 400, "message": { "ar": "عنصر واحد أو أكثر في القائمة التالية غير موجود. '{0}'", "en": "One or more items in the following list\nis not found. '{0}'", "tr": "Aşağıdaki listedeki bir veya daha fazla öğe" }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND" }, { "code": "ERR_ACCTNG_227", "status": 400, "message": { "ar": "لا يمكن أن تحتوي العناصر التابعة لنموذج على نفس الرمز.", "en": "Items belong to a template cannot have same code.", "tr": "Bir şablona ait öğeler aynı koda sahip olamaz." }, "message_available": true, "constant_name": "DUPLICATE_TEMPLATE_ITEM_CODE_NOT_ALLOWED" } ] } } }, "/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details": { "get": { "operationId": "get-statement-template-item-detail-by-item-id", "tags": [ "financial-statement-templates" ], "summary": "get-statement-template-item-detail-by-item-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "financialStatementTemplateItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateItemId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "calcFinancialStatementTemplateItemId": { "type": "string", "format": "uuid", "x-aura-field-code": "calcFinancialStatementTemplateItemId" }, "calcLedgerCode": { "type": "string", "x-aura-field-code": "calcLedgerCode" }, "effectType": { "type": "integer", "format": "int32", "enum": [ 1, 2 ], "x-aura-field-code": "statementItemDetailEffectType", "x-aura-enum": { "parameter": "effect_type", "values": [ { "value": 1, "name": "Add", "labels": { "ar": "إضافة" } }, { "value": 2, "name": "Subtract", "labels": { "ar": "طرح" } } ] }, "description": "Permitted values (2):\n\n- `1` — Add (ar: إضافة)\n- `2` — Subtract (ar: طرح)" }, "financialStatementTemplateDetailId": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateDetailId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-statement-template-item-detail-by-item-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FinancialStatementTemplateItemId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "StatementTemplateItemDetailDto", "collection": true, "members": [ { "name": "FinancialStatementTemplateDetailId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CalcLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CalcFinancialStatementTemplateItemId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "EffectType", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_224", "status": 400, "message": { "ar": "عنصر واحد أو أكثر في القائمة التالية غير موجود. '{0}'", "en": "One or more items in the following list\nis not found. '{0}'", "tr": "Aşağıdaki listedeki bir veya daha fazla öğe" }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND" } ] } } }, "/financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}": { "delete": { "operationId": "delete-statement-template-item-detail", "tags": [ "financial-statement-templates" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Delete Statement Template Item Detail", "description": "Invokes the `delete-statement-template-item-detail` service definition through `DELETE /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } }, { "name": "financialStatementTemplateItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateItemId" } }, { "name": "financialStatementTemplateDetailId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateDetailId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 3, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-statement-template-item-detail", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FinancialStatementTemplateItemId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FinancialStatementTemplateDetailId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_224", "status": 400, "message": { "ar": "عنصر واحد أو أكثر في القائمة التالية غير موجود. '{0}'", "en": "One or more items in the following list\nis not found. '{0}'", "tr": "Aşağıdaki listedeki bir veya daha fazla öğe" }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_NOT_FOUND" }, { "code": "ERR_ACCTNG_230", "status": 400, "message": { "ar": "لم يتم العثور على تفاصيل عنصر قالب البيانات المالية بالمعرف المعطى: '{0}'.", "en": "Financial statement template item detail is not found with the given id: '{0}'.", "tr": "Mali tablo şablonu öğesi ayrıntısı verilen kimlikle bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_DETAIL_NOT_FOUND" } ] } }, "put": { "operationId": "update-statement-template-item-detail", "tags": [ "financial-statement-templates" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Update Statement Template Item Detail", "description": "Invokes the `update-statement-template-item-detail` service definition through `PUT /financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } }, { "name": "financialStatementTemplateItemId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateItemId" } }, { "name": "financialStatementTemplateDetailId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateDetailId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "calcFinancialStatementTemplateItemCode": { "type": "string", "x-aura-field-code": "calcFinancialStatementTemplateItemCode" }, "calcLedgerCode": { "type": "string", "x-aura-field-code": "calcLedgerCode" }, "effectType": { "type": "integer", "format": "int32", "enum": [ 1, 2 ], "x-aura-field-code": "statementItemDetailEffectType", "x-aura-enum": { "parameter": "effect_type", "values": [ { "value": 1, "name": "Add", "labels": { "ar": "إضافة" } }, { "value": 2, "name": "Subtract", "labels": { "ar": "طرح" } } ] }, "description": "Permitted values (2):\n\n- `1` — Add (ar: إضافة)\n- `2` — Subtract (ar: طرح)" } }, "required": [ "effectType" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 3, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-statement-template-item-detail", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statement-templates/{id}/items/{financialStatementTemplateItemId}/details/{financialStatementTemplateDetailId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FinancialStatementTemplateDetailId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_230", "status": 400, "message": { "ar": "لم يتم العثور على تفاصيل عنصر قالب البيانات المالية بالمعرف المعطى: '{0}'.", "en": "Financial statement template item detail is not found with the given id: '{0}'.", "tr": "Mali tablo şablonu öğesi ayrıntısı verilen kimlikle bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_ITEM_DETAIL_NOT_FOUND" } ] } } }, "/financial-statements/calculate": { "post": { "operationId": "calculate-financial-statement", "tags": [ "financial-statements" ], "summary": "calculate-financial-statement", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "columns": { "type": "array", "items": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "columnBeginDate" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "columnEndDate" }, "name": { "type": "string", "x-aura-field-code": "financialStatementColumnName" } }, "required": [ "beginDate", "name" ], "x-aura-field-code": "financialStatementColumns" } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "exchangeRateType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeRateType" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" }, "financialStatementTemplateId": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" } }, "required": [ "columns", "financialStatementTemplateId" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "financialStatementName": { "type": "string", "x-aura-field-code": "financialStatementName" }, "reportDate": { "type": "string", "format": "date", "x-aura-field-code": "financialStatementReportDate" }, "statementItems": { "type": "array", "items": { "type": "object", "properties": { "balances": { "type": "array", "items": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "balanceBeginDate" }, "columnName": { "type": "string", "x-aura-field-code": "financialStatementColumnName" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "balanceEndDate" }, "foreignBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "foreignBalance" }, "localBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "localBalance" }, "totalBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "totalBalance" } }, "x-aura-field-code": "balances" } }, "code": { "type": "string", "x-aura-field-code": "financialStatementTemplateItemCode" }, "name": { "type": "string", "x-aura-field-code": "financialStatementTemplateItemName" }, "parentItemCode": { "type": "string", "x-aura-field-code": "parentFinancialStatementTemplateItemCode" } }, "x-aura-field-code": "financialStatementTemplateItems" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "calculate-financial-statement", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-statements/calculate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FinancialStatementTemplateId", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExchangeSpreadType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExchangeRateType", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CalculateFinancialStatementDto", "payload": "CalculateFinancialStatementDto", "collection": false, "members": [ { "name": "FinancialStatementName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReportDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatementItems", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_221", "status": 400, "message": { "ar": "لم يتم العثور على قالب البيان المالي بالمعرّف المُعطى: '{0}'.", "en": "Financial statement template is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip mali tablo şablonu bulunamadı: '{0}'." }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_TEMPLATE_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_226", "status": 400, "message": { "ar": "القالب لا يحتوي على تفاصيل يتم حسابها من خلال دفتر الأستاذ، لذلك لا يمكن إنشاء البيان المالي.", "en": "Template has no detail whose calculation resource is ledger, financial statement cannot be created.", "tr": "Şablonda hesaplama kaynağı defter olan detay bulunmuyor, mali tablo oluşturulamıyor.\n" }, "message_available": true, "constant_name": "FINANCIAL_STATEMENT_CANNOT_BE_CREATED_BECAUSE_TEMPLATE_HAS_NO_DETAIL_WHOSE_CALCULATION_RESOURCE_IS_LEDGER" } ] } } }, "/financial-transactions": { "get": { "operationId": "get-financial-transaction-list", "tags": [ "financial-transactions" ], "summary": "get-financial-transaction-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "creditLedgerCode": { "x-aura-type": "unresolved" }, "creditLedgerFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" }, "creditLedgerMatrixFieldName": { "type": "string", "x-aura-field-code": "creditLedgerMatrixFieldName" }, "creditLedgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" }, "creditLedgerMatrixName": { "type": "string", "x-aura-field-code": "creditLedgerMatrixName" }, "debitLedgerCode": { "type": "string", "x-aura-field-code": "debitLedgerCode" }, "debitLedgerFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" }, "debitLedgerMatrixFieldName": { "type": "string", "x-aura-field-code": "debitLedgerMatrixFieldName" }, "debitLedgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" }, "debitLedgerMatrixName": { "type": "string", "x-aura-field-code": "debitLedgerMatrixName" }, "description": { "type": "string", "x-aura-field-code": "financialTransactionDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "financialTransactionId" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-financial-transaction-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-transactions", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FinancialTransactionDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-financial-transaction", "tags": [ "financial-transactions" ], "summary": "create-financial-transaction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "creditLedgerCode": { "type": "string", "x-aura-field-code": "creditLedgerCode" }, "creditLedgerMatrixFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "creditLedgerMatrixFieldId" }, "creditLedgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "creditLedgerMatrixId" }, "debitLedgerCode": { "type": "string", "x-aura-field-code": "debitLedgerCode" }, "debitLedgerMatrixFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "debitLedgerMatrixFieldId" }, "debitLedgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "debitLedgerMatrixId" }, "description": { "type": "string", "x-aura-field-code": "financialTransactionDescription" }, "name": { "type": "string", "x-aura-field-code": "financialTransactionName" } }, "required": [ "code" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-financial-transaction", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-transactions", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_116", "status": 400, "message": { "ar": "غير مسموح بإنشاء عملية مالية واحدة أكثر من مرة بنفس الرمز '{0}'.", "en": "It is not allowed to create more than one financial transaction with same code '{0}'.", "tr": "Aynı kod '{0}' ile birden fazla finansal işlem oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "NOT_ALLOWED_TO_CREATE_MORE_THAN_ONE_FINANCIAL_TRANSACTION_WITH_SAME_CODE" }, { "code": "ERR_ACCTNG_118", "status": 400, "message": { "ar": "لا يمكن أن يتجاوز طول قيمة \"code\" 20 حرفًا، ولا يمكن أن تتضمن أي حروف خاصة.", "en": "Length of the 'code' value cannot exceed 20 characters and cannot include any special characters.", "tr": "'Kod' değerinin uzunluğu 20 karakteri geçemez ve herhangi bir özel karakter içeremez.\n" }, "message_available": true, "constant_name": "FINANCIAL_TRANSACTION_CODE_WRONG_FORMAT" } ] } } }, "/financial-transactions/by-code/{code}": { "get": { "operationId": "get-financial-transaction-by-code", "tags": [ "financial-transactions" ], "summary": "get-financial-transaction-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "financialTransactionCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "creditLedgerCode": { "type": "string", "x-aura-field-code": "creditLedgerCode" }, "creditLedgerMatrixFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "creditLedgerMatrixFieldId" }, "creditLedgerMatrixFieldName": { "type": "string", "x-aura-field-code": "creditLedgerMatrixFieldName" }, "creditLedgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "creditLedgerMatrixId" }, "creditLedgerMatrixName": { "type": "string", "x-aura-field-code": "creditLedgerMatrixName" }, "debitLedgerCode": { "type": "string", "x-aura-field-code": "debitLedgerCode" }, "debitLedgerMatrixFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "debitLedgerMatrixFieldId" }, "debitLedgerMatrixFieldName": { "type": "string", "x-aura-field-code": "debitLedgerMatrixFieldName" }, "debitLedgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "debitLedgerMatrixId" }, "debitLedgerMatrixName": { "type": "string", "x-aura-field-code": "debitLedgerMatrixName" }, "description": { "type": "string", "x-aura-field-code": "financialTransactionDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "financialTransactionId" }, "name": { "type": "string", "x-aura-field-code": "financialTransactionName" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-financial-transaction-by-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-transactions/by-code/{code}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FinancialTransactionDto", "payload": "FinancialTransactionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/financial-transactions/{id}": { "delete": { "operationId": "delete-financial-transaction", "tags": [ "financial-transactions" ], "summary": "delete-financial-transaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialTransactionId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-financial-transaction", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-transactions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_120", "status": 400, "message": { "ar": "المعاملة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Financial Transaction is not found with the given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Finansal İşlem bulunamadı." }, "message_available": true, "constant_name": "FINANCIAL_TRANSACTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_121", "status": 400, "message": { "ar": "يلزم المعاملة المالية '{0}' في تعريف قيد المحاسبة. لا يمكن حذفها.", "en": "Financial transaction '{0}' is used in accounting entry definition.It cannot be deleted.", "tr": "Muhasebe girişi tanımında '{0}' finansal işlemi kullanılıyor. Silinemiyor." }, "message_available": true, "constant_name": "FINANCIAL_TRANSACTION_IS_USED_IN_ACCOUNTING_ENTRY_DEFINITION_IT_CANNOT_BE_DELETED" } ] } }, "get": { "operationId": "get-financial-transaction-by-id", "tags": [ "financial-transactions" ], "summary": "get-financial-transaction-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialTransactionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-financial-transaction-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-transactions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FinancialTransactionDto", "payload": "FinancialTransactionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DebitLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DebitLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreditLedgerMatrixFieldId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CreditLedgerMatrixFieldName", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_120", "status": 400, "message": { "ar": "المعاملة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Financial Transaction is not found with the given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Finansal İşlem bulunamadı." }, "message_available": true, "constant_name": "FINANCIAL_TRANSACTION_NOT_FOUND" } ] } }, "put": { "operationId": "update-financial-transaction", "tags": [ "financial-transactions" ], "summary": "update-financial-transaction", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialTransactionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "creditLedgerCode": { "type": "string", "x-aura-field-code": "creditLedgerCode" }, "creditLedgerMatrixFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "creditLedgerMatrixFieldId" }, "creditLedgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "creditLedgerMatrixId" }, "debitLedgerCode": { "type": "string", "x-aura-field-code": "debitLedgerCode" }, "debitLedgerMatrixFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "debitLedgerMatrixFieldId" }, "debitLedgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "debitLedgerMatrixId" }, "description": { "type": "string", "x-aura-field-code": "financialTransactionDescription" }, "name": { "type": "string", "x-aura-field-code": "financialTransactionName" } }, "required": [ "code" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 9, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-financial-transaction", "x-aura-domain": "accounting", "x-aura-raw-url-path": "financial-transactions/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_116", "status": 400, "message": { "ar": "غير مسموح بإنشاء عملية مالية واحدة أكثر من مرة بنفس الرمز '{0}'.", "en": "It is not allowed to create more than one financial transaction with same code '{0}'.", "tr": "Aynı kod '{0}' ile birden fazla finansal işlem oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "NOT_ALLOWED_TO_CREATE_MORE_THAN_ONE_FINANCIAL_TRANSACTION_WITH_SAME_CODE" }, { "code": "ERR_ACCTNG_118", "status": 400, "message": { "ar": "لا يمكن أن يتجاوز طول قيمة \"code\" 20 حرفًا، ولا يمكن أن تتضمن أي حروف خاصة.", "en": "Length of the 'code' value cannot exceed 20 characters and cannot include any special characters.", "tr": "'Kod' değerinin uzunluğu 20 karakteri geçemez ve herhangi bir özel karakter içeremez.\n" }, "message_available": true, "constant_name": "FINANCIAL_TRANSACTION_CODE_WRONG_FORMAT" }, { "code": "ERR_ACCTNG_120", "status": 400, "message": { "ar": "المعاملة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Financial Transaction is not found with the given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Finansal İşlem bulunamadı." }, "message_available": true, "constant_name": "FINANCIAL_TRANSACTION_NOT_FOUND" } ] } } }, "/fiscal-year/profit-loss-accounting-entries/{id}": { "get": { "operationId": "get-profit-loss-accounting-entry-list", "tags": [ "fiscal-year" ], "summary": "get-profit-loss-accounting-entry-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "creditAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "creditAmount" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "debitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "debitAmount" }, "gLCode": { "x-aura-type": "unresolved" }, "ledgerName": { "type": "string", "x-aura-field-code": "ledgerName" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "pLCreditAmount": { "x-aura-type": "unresolved" }, "pLDebitAmount": { "x-aura-type": "unresolved" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "creditAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "creditAmount" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "debitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "debitAmount" }, "gLCode": { "x-aura-type": "unresolved" }, "ledgerName": { "type": "string", "x-aura-field-code": "ledgerName" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "pLCreditAmount": { "x-aura-type": "unresolved" }, "pLDebitAmount": { "x-aura-type": "unresolved" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "creditAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "creditAmount" }, "currencyId": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyId" }, "debitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "debitAmount" }, "gLCode": { "x-aura-type": "unresolved" }, "ledgerName": { "type": "string", "x-aura-field-code": "ledgerName" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "pLCreditAmount": { "x-aura-type": "unresolved" }, "pLDebitAmount": { "x-aura-type": "unresolved" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-profit-loss-accounting-entry-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-year/profit-loss-accounting-entries/{id}", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/fiscal-year/{id}/profit-loss-accounting-entries": { "post": { "operationId": "create-profit-loss-accounting-entry", "tags": [ "fiscal-year" ], "summary": "create-profit-loss-accounting-entry", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } } ], "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-profit-loss-accounting-entry", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-year/{id}/profit-loss-accounting-entries", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/fiscal-years": { "get": { "operationId": "get-fiscal-year-list", "tags": [ "fiscal-years" ], "summary": "get-fiscal-year-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "status": { "type": "integer", "format": "int32", "enum": [ 0, 1, 2 ], "x-aura-field-code": "fiscalYearStatus", "x-aura-enum": { "parameter": "fiscal_year_status", "values": [ { "value": 0, "name": "closed" }, { "value": 1, "name": "open" }, { "value": 2, "name": "Permanently Closed", "labels": { "tr": "Kalici olarak kapali" } } ] }, "description": "Permitted values (3):\n\n- `0` — closed\n- `1` — open\n- `2` — Permanently Closed (tr: Kalici olarak kapali)" }, "yearEnd": { "type": "string", "format": "date", "x-aura-field-code": "fiscalYearEnd" }, "yearEndClosingStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "yearEndClosingStatus" }, "yearStart": { "type": "string", "format": "date", "x-aura-field-code": "fiscalYearStart" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-fiscal-year-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FiscalYearDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "YearStart", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "YearEnd", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "YearEndClosingStatus", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-fiscal-year", "tags": [ "fiscal-years" ], "summary": "create-fiscal-year", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "yearEnd": { "type": "string", "format": "date", "x-aura-field-code": "fiscalYearEnd" }, "yearStart": { "type": "string", "format": "date", "x-aura-field-code": "fiscalYearStart" } }, "required": [ "yearEnd", "yearStart" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-fiscal-year", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "YearStart", "declared_type": null, "nullable": true, "collection": false }, { "name": "YearEnd", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "command-id", "note": "The route returns `AuraCommandDto`, which is the response body itself and not a wrapper around one: the framework declares it as a class with a single property, `Id`, of type `Guid`. A caller gets a JSON OBJECT with one field, not a bare value. The field is `id` on the wire.", "declared_type": "AuraCommandDto", "envelopes": [ "AuraCommandDto" ], "payload": "Guid", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false, "wire_name": "id", "wire_name_basis": "framework-naming-policy" } ], "naming": "Member names are the service's declaration names.", "synthesized": true }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_140", "status": 400, "message": { "ar": "لا يُسمح بإنشاء سنة مالية واحدة لأكثر من تاريخ واحد.", "en": "It is not allowed to create more than one fiscal year for same dates.", "tr": "Aynı tarihler için birden fazla mali yıl oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "CANNOT_CREATE_FISCAL_YEAR_FOR_SAME_DATES" }, { "code": "ERR_ACCTNG_141", "status": 400, "message": { "ar": "لا يُسمح بإنشاء سنة مالية تتجاوز عامًا واحدًا.", "en": "It is not allowed to create a fiscal year which is longer than one year.", "tr": "Bir yıldan daha uzun bir mali yıl oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": null }, { "code": "ERR_ACCTNG_142", "status": 400, "message": { "ar": "يجب أن يكون 'YearEnd' أكبر من 'YearStart'.", "en": "'YearEnd' must be bigger than 'YearStart'.", "tr": "'Yıl Sonu', 'Yıl Başlangıcından' büyük olmalıdır." }, "message_available": true, "constant_name": null } ] } } }, "/fiscal-years/{id}": { "delete": { "operationId": "delete-fiscal-year", "tags": [ "fiscal-years" ], "summary": "delete-fiscal-year", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-fiscal-year", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": null }, { "code": "ERR_ACCTNG_146", "status": 400, "message": { "ar": "السنة المالية لديها فترات. لا يمكن حذفها.", "en": "Fiscal year has periods. It cannot be deleted.", "tr": "Mali yılın dönemleri vardır. Silinemez." }, "message_available": true, "constant_name": null } ] } }, "get": { "operationId": "get-fiscal-year-by-id", "tags": [ "fiscal-years" ], "summary": "get-fiscal-year-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "status": { "type": "integer", "format": "int32", "enum": [ 0, 1, 2 ], "x-aura-field-code": "fiscalYearStatus", "x-aura-enum": { "parameter": "fiscal_year_status", "values": [ { "value": 0, "name": "closed" }, { "value": 1, "name": "open" }, { "value": 2, "name": "Permanently Closed", "labels": { "tr": "Kalici olarak kapali" } } ] }, "description": "Permitted values (3):\n\n- `0` — closed\n- `1` — open\n- `2` — Permanently Closed (tr: Kalici olarak kapali)" }, "yearEnd": { "type": "string", "format": "date", "x-aura-field-code": "fiscalYearEnd" }, "yearEndClosingStatus": { "type": "integer", "format": "int32", "x-aura-field-code": "yearEndClosingStatus" }, "yearStart": { "type": "string", "format": "date", "x-aura-field-code": "fiscalYearStart" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-fiscal-year-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FiscalYearDto", "payload": "FiscalYearDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "YearStart", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "YearEnd", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "YearEndClosingStatus", "declared_type": "int?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": "FISCAL_YEAR_IS_NOT_FOUND" } ] } }, "put": { "operationId": "update-fiscal-year", "tags": [ "fiscal-years" ], "summary": "update-fiscal-year", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "enum": [ 0, 1, 2 ], "x-aura-field-code": "fiscalYearStatus", "x-aura-enum": { "parameter": "fiscal_year_status", "values": [ { "value": 0, "name": "closed" }, { "value": 1, "name": "open" }, { "value": 2, "name": "Permanently Closed", "labels": { "tr": "Kalici olarak kapali" } } ] }, "description": "Permitted values (3):\n\n- `0` — closed\n- `1` — open\n- `2` — Permanently Closed (tr: Kalici olarak kapali)" }, "yearEnd": { "type": "string", "format": "date", "x-aura-field-code": "fiscalYearEnd" }, "yearStart": { "type": "string", "format": "date", "x-aura-field-code": "fiscalYearStart" } }, "required": [ "status", "yearEnd", "yearStart" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-fiscal-year", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "YearStart", "declared_type": null, "nullable": true, "collection": false }, { "name": "YearEnd", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_140", "status": 400, "message": { "ar": "لا يُسمح بإنشاء سنة مالية واحدة لأكثر من تاريخ واحد.", "en": "It is not allowed to create more than one fiscal year for same dates.", "tr": "Aynı tarihler için birden fazla mali yıl oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "CANNOT_CREATE_FISCAL_YEAR_FOR_SAME_DATES" }, { "code": "ERR_ACCTNG_141", "status": 400, "message": { "ar": "لا يُسمح بإنشاء سنة مالية تتجاوز عامًا واحدًا.", "en": "It is not allowed to create a fiscal year which is longer than one year.", "tr": "Bir yıldan daha uzun bir mali yıl oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": null }, { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": null }, { "code": "ERR_ACCTNG_144", "status": 400, "message": { "ar": "السنة المالية لها فترات. لا يمكن تحديث تواريخها.", "en": "Fiscal year has periods. Its dates cannot be updated.", "tr": "Mali yılın dönemleri vardır. Tarihleri ​​güncellenemez." }, "message_available": true, "constant_name": null }, { "code": "ERR_ACCTNG_145", "status": 400, "message": { "ar": "السنة المالية تحتوي على فترات مفتوحة ولا يمكن إغلاقها.", "en": "Fiscal year has open periods. It cannot be closed.", "tr": "Mali yılın açık dönemleri vardır. Kapatılamaz." }, "message_available": true, "constant_name": null } ] } } }, "/fiscal-years/{id}/periods": { "delete": { "operationId": "delete-fiscal-period", "tags": [ "fiscal-years" ], "summary": "delete-fiscal-period", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-fiscal-period", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}/periods", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PeriodId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": null }, { "code": "ERR_ACCTNG_151", "status": 400, "message": { "ar": "تم إنشاء قيود محاسبية في السنة المالية الحالية. لا يمكن حذف الفترات.", "en": "There are accounting entries created in this fiscal year. Periods cannot be deleted.", "tr": "Bu mali yılda oluşturulan muhasebe kayıtları var. Dönemler silinemez." }, "message_available": true, "constant_name": null } ] } }, "get": { "operationId": "get-fiscal-period-list", "tags": [ "fiscal-years" ], "summary": "get-fiscal-period-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "fiscalPeriodId": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalPeriodId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isClosed": { "x-aura-type": "unresolved" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizations": { "type": "array", "items": { "type": "object", "x-aura-field-code": "organizationFiscalPeriods" } }, "periodEnd": { "x-aura-type": "unresolved" }, "periodStart": { "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-fiscal-period-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}/periods", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FiscalPeriodDto", "collection": true, "members": [ { "name": "FiscalPeriodId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PeriodStart", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "PeriodEnd", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "OrdinalPosition", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Organizations", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": "FISCAL_YEAR_IS_NOT_FOUND" } ] } }, "post": { "operationId": "create-fiscal-period", "tags": [ "fiscal-years" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Create Fiscal Period", "description": "Invokes the `create-fiscal-period` service definition through `POST /fiscal-years/{id}/periods`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "integer", "format": "int32", "x-aura-field-code": "fiscalPeriodType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "fiscal_period_type", "values": [ { "value": 1, "name": "Weekly" }, { "value": 2, "name": "Monthly" }, { "value": 3, "name": "3 Months" }, { "value": 4, "name": "6 Months" } ] } } }, "required": [ "type" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "fiscalPeriodId": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalPeriodId" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "isClosed": { "type": "boolean", "x-aura-field-code": "isClosedFiscalPeriod" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" } }, "x-aura-field-code": "organizations" } }, "periodEnd": { "type": "string", "format": "date-time", "x-aura-field-code": "periodEnd" }, "periodStart": { "type": "string", "format": "date-time", "x-aura-field-code": "periodStart" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-fiscal-period", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}/periods", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Type", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "FiscalPeriodDto", "collection": true, "members": [ { "name": "FiscalPeriodId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PeriodStart", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "PeriodEnd", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "OrdinalPosition", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Organizations", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": "FISCAL_YEAR_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_152", "status": 400, "message": { "ar": "ستُنشأ الفترات المالية بالفعل.", "en": "Fiscal periods has already created.", "tr": "Mali dönemler zaten oluşturuldu." }, "message_available": true, "constant_name": "FISCAL_PERIOD_HAS_ALREADY_CREATED" }, { "code": "ERR_ACCTNG_19", "status": 400, "message": { "ar": "لا يتم العثور على صيغة رمز الحساب العام، ولا يمكن إنشاء فترات المالية.", "en": "GL Code Format is not found, fiscal periods cannot be created.", "tr": "GL Kod Formatı bulunamadı, mali dönemler oluşturulamıyor." }, "message_available": true, "constant_name": "GL_CODE_FORMAT_NOT_FOUND_FISCAL_PERIOD_CANNOT_BE_CREATED" }, { "code": "ERR_ACCTNG_60", "status": 400, "message": { "ar": "حجز", "en": "Rezerve" }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_NOT_FOUND" } ] } } }, "/fiscal-years/{id}/periods/{periodId}": { "get": { "operationId": "get-fiscal-period-by-id", "tags": [ "fiscal-years" ], "summary": "get-fiscal-period-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "periodId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "fiscalPeriodId": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalPeriodId" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" }, "organizations": { "type": "array", "items": { "type": "object", "properties": { "isClosed": { "type": "boolean", "x-aura-field-code": "isClosedOrganizationFiscalPeriod" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" } }, "x-aura-field-code": "organizations" } }, "periodEnd": { "type": "string", "format": "date-time", "x-aura-field-code": "periodEnd" }, "periodStart": { "type": "string", "format": "date-time", "x-aura-field-code": "periodStart" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-fiscal-period-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}/periods/{periodId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PeriodId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "FiscalPeriodDto", "payload": "FiscalPeriodDto", "collection": false, "members": [ { "name": "FiscalPeriodId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PeriodStart", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "PeriodEnd", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "OrdinalPosition", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Organizations", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": "FISCAL_YEAR_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_147", "status": 400, "message": { "ar": "لم يتم العثور على الفترة المالية باستخدام معرف الفترة المعطى '{0}'.", "en": "Fiscal period is not found with the given PeriodId '{0}'.", "tr": "Verilen PeriodId '{0}' ile mali dönem bulunamadı." }, "message_available": true, "constant_name": "FISCAL_PERIOD_IS_NOT_FOUND" } ] } }, "put": { "operationId": "update-fiscal-period-status", "tags": [ "fiscal-years" ], "summary": "update-fiscal-period-status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } }, { "name": "periodId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalPeriodId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isClosed": { "type": "boolean", "x-aura-field-code": "isClosedFiscalPeriod" } }, "required": [ "isClosed" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-fiscal-period-status", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}/periods/{periodId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PeriodId", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsClosed", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": "FISCAL_YEAR_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_147", "status": 400, "message": { "ar": "لم يتم العثور على الفترة المالية باستخدام معرف الفترة المعطى '{0}'.", "en": "Fiscal period is not found with the given PeriodId '{0}'.", "tr": "Verilen PeriodId '{0}' ile mali dönem bulunamadı." }, "message_available": true, "constant_name": "FISCAL_PERIOD_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_150", "status": 400, "message": { "ar": "السنة المالية للفترة مغلقة وليس Period النهائي للسنة المالية. لا يمكن تحديثه.", "en": "Fiscal year of the period is closed and the period is not final period of the fiscal year. It cannot be updated.", "tr": "Dönemin mali yılı kapalı olup, dönem mali yılın son dönemi değildir. Güncellenemez." }, "message_available": true, "constant_name": "FISCAL_YEAR_OF_THE_PERIOD_IS_CLOSED" }, { "code": "ERR_ACCTNG_243", "status": 400, "message": null, "message_available": false, "constant_name": "FISCAL_YEAR_PERMANENTLY_CLOSED" } ] } } }, "/fiscal-years/{id}/periods/{periodId}/organizations/by-organization-code/{organizationCode}": { "put": { "operationId": "update-organization-fiscal-period-status", "tags": [ "fiscal-years" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "update organization fiscal period status", "description": "Invokes the `update-organization-fiscal-period-status` service definition through `PUT /fiscal-years/{id}/periods/{periodId}/organizations/by-organization-code/{organizationCode}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalYearId" } }, { "name": "periodId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fiscalPeriodId" } }, { "name": "organizationCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "organizationCode" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isClosed": { "type": "boolean", "x-aura-field-code": "isClosedOrganizationFiscalPeriod" } }, "required": [ "isClosed" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 3, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-organization-fiscal-period-status", "x-aura-domain": "accounting", "x-aura-raw-url-path": "fiscal-years/{id}/periods/{periodId}/organizations/by-organization-code/{organizationCode}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PeriodId", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsClosed", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_143", "status": 400, "message": { "ar": "السنة المالية غير موجودة بالمعرف المقدم '{0}'.", "en": "Fiscal year is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle mali yıl bulunamadı." }, "message_available": true, "constant_name": "FISCAL_YEAR_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_147", "status": 400, "message": { "ar": "لم يتم العثور على الفترة المالية باستخدام معرف الفترة المعطى '{0}'.", "en": "Fiscal period is not found with the given PeriodId '{0}'.", "tr": "Verilen PeriodId '{0}' ile mali dönem bulunamadı." }, "message_available": true, "constant_name": "FISCAL_PERIOD_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_150", "status": 400, "message": { "ar": "السنة المالية للفترة مغلقة وليس Period النهائي للسنة المالية. لا يمكن تحديثه.", "en": "Fiscal year of the period is closed and the period is not final period of the fiscal year. It cannot be updated.", "tr": "Dönemin mali yılı kapalı olup, dönem mali yılın son dönemi değildir. Güncellenemez." }, "message_available": true, "constant_name": "FISCAL_YEAR_OF_THE_PERIOD_IS_CLOSED" }, { "code": "ERR_ACCTNG_154", "status": 400, "message": { "ar": "لم يتم العثور على فترة مالية المنظمة باستخدام رمز المنظمة المعطى: '{0}'", "en": "Organization fiscal period is not found with the give organization code: '{0}'", "tr": "Kuruluşun mali dönemi şu kuruluş kodunu vererek bulunamadı: '{0}'" }, "message_available": true, "constant_name": "ORGANIZATION_CODE_IS_NOT_FOUND" } ] } } }, "/gl-code-formats": { "delete": { "operationId": "delete-gLCode-format", "tags": [ "gl-code-formats" ], "summary": "delete-gLCode-format", "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-gLCode-format", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_86", "status": 400, "message": { "ar": "تنسيق رمز دفتر الأستاذ العام يُستخدم لإنشاء رمز دفتر الأستاذ العام. لا يمكن تحديثه أو حذفه.", "en": "GL Code Format is used to create glCode. It cannot be updated or deleted.", "tr": "GL Kod Formatı glCode oluşturmak için kullanılır. Güncellenemez veya silinemez." }, "message_available": true, "constant_name": "GL_CODE_FORMAT_IS_USED_TO_CREATE_GLCODE_IT_CANNOT_BE_UPDATED_OR_DELETED" }, { "code": "ERR_ACCTNG_87", "status": 400, "message": { "ar": "لم يتم العثور على تنسيق رمز GL.", "en": "GL Code Format is not found.", "tr": "GL Kod Formatı bulunamadı." }, "message_available": true, "constant_name": "GL_CODE_FORMAT_NOT_FOUND" } ] } }, "get": { "operationId": "get-gLCode-format-list", "tags": [ "gl-code-formats" ], "summary": "get-gLCode-format-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-gLCode-format-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-formats", "x-aura-capabilities": { "filtering": true, "ordering": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "GLCodeFormatDto", "payload": "GLCodeFormatDto", "collection": false, "members": [ { "name": "SectionSeparator", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GLCodeSections", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-glCode-format", "tags": [ "gl-code-formats" ], "summary": "create-glCode-format", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "glCodeSections": { "type": "array", "items": { "type": "object", "properties": { "glCodeSectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" }, "isIncludedToFiscalPeriod": { "type": "boolean", "x-aura-field-code": "isIncludedToFiscalPeriod" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" } }, "required": [ "glCodeSectionId", "isIncludedToFiscalPeriod", "ordinalPosition" ], "x-aura-field-code": "glCodeSections" } }, "sectionSeparator": { "type": "string", "x-aura-field-code": "separator" } } } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-glCode-format", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_83", "status": 400, "message": { "ar": "صيغة رمز الحساب العام موجودة بالفعل. يرجى محاولة التحديث.", "en": "GL Code Format already exists. Please try to update.", "tr": "GL Kod Formatı zaten mevcut. Lütfen güncellemeyi deneyin." }, "message_available": true, "constant_name": "GL_CODE_FORMAT_ALREADY_EXISTS" } ] } }, "put": { "operationId": "update-gLCode-format", "tags": [ "gl-code-formats" ], "summary": "update-gLCode-format", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "glCodeSections": { "type": "array", "items": { "type": "object", "properties": { "glCodeSectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" }, "isIncludedToFiscalPeriod": { "type": "boolean", "x-aura-field-code": "isIncludedToFiscalPeriod" }, "ordinalPosition": { "type": "integer", "format": "int32", "x-aura-field-code": "ordinalPosition" } }, "required": [ "glCodeSectionId", "isIncludedToFiscalPeriod", "ordinalPosition" ], "x-aura-field-code": "glCodeSections" } }, "sectionSeparator": { "type": "string", "x-aura-field-code": "separator" } }, "required": [ "glCodeSections", "sectionSeparator" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-gLCode-format", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_84", "status": 400, "message": { "ar": "'القسم' أو 'التسلسل' ليس جزءًا من صيغة رمز GL.", "en": "'Section' or 'Sequence' is not part of the GL Code Format.", "tr": "'Bölüm' veya 'Sıra', GL Kod Formatının bir parçası değildir." }, "message_available": true, "constant_name": "SECTION_OR_SEQUENCE_IS_NOT_PART_OF_THE_GL_CODE_FORMAT" }, { "code": "ERR_ACCTNG_86", "status": 400, "message": { "ar": "تنسيق رمز دفتر الأستاذ العام يُستخدم لإنشاء رمز دفتر الأستاذ العام. لا يمكن تحديثه أو حذفه.", "en": "GL Code Format is used to create glCode. It cannot be updated or deleted.", "tr": "GL Kod Formatı glCode oluşturmak için kullanılır. Güncellenemez veya silinemez." }, "message_available": true, "constant_name": "GL_CODE_FORMAT_IS_USED_TO_CREATE_GLCODE_IT_CANNOT_BE_UPDATED_OR_DELETED" } ] } } }, "/gl-code-sections": { "get": { "operationId": "get-gLCode-section-list", "tags": [ "gl-code-sections" ], "summary": "get-gLCode-section-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" }, "isMainParent": { "type": "boolean", "x-aura-field-code": "glCodeSectionIsMainParent" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "glCodeSectionIsMandatory" }, "name": { "type": "string", "x-aura-field-code": "glCodeSectionName" }, "parentSectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentGlCodeSectionId" }, "parentSectionName": { "type": "string", "x-aura-field-code": "parentGlCodeSectionName" }, "sectionLength": { "type": "integer", "format": "int32", "x-aura-field-code": "glCodeSectionLength" }, "sectionType": { "type": "string", "x-aura-field-code": "glCodeSectionType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-gLCode-section-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "GLCodeSectionListDto", "collection": true, "members": [ { "name": "ParentSectionName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SectionLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsMainParent", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsMandatory", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentSectionId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-gLCode-section", "tags": [ "gl-code-sections" ], "summary": "create-gLCode-section", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isMainParent": { "type": "boolean", "x-aura-field-code": "glCodeSectionIsMainParent" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "glCodeSectionIsMandatory" }, "name": { "type": "string", "x-aura-field-code": "glCodeSectionName" }, "parentSectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentGlCodeSectionId" }, "sectionLength": { "type": "integer", "format": "int32", "x-aura-field-code": "glCodeSectionLength" }, "sectionType": { "type": "string", "x-aura-field-code": "glCodeSectionType" } }, "required": [ "isMainParent", "isMandatory", "name", "sectionLength", "sectionType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-gLCode-section", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "SectionLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMainParent", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMandatory", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParentSectionId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_232", "status": 400, "message": null, "message_available": false, "constant_name": "SECTION_TYPES_MUST_BE_ONEOFTHE_DEFINED_TYPES" }, { "code": "ERR_ACCTNG_41", "status": 400, "message": { "ar": "غير مسموح بإنشاء أكثر من قسم واحد بنوع القسم {0}.", "en": "It is not allowed to create more than one section with the {0} section type.", "tr": "{0} section tipi ile birden fazla section tipi oluşturulmasına izin verilmiyor." }, "message_available": true, "constant_name": "NOT_ALLOWED_TO_CREATE_MORE_THAN_ONE_SECTION" }, { "code": "ERR_ACCTNG_42", "status": 400, "message": { "ar": "هناك قسم رمز الحساب العام بنفس الاسم {0}.", "en": "There is a GL Code Section with the same name {0}.", "tr": "Aynı isimde {0} olan bir GL Kodu Bölümü bulunmaktadır." }, "message_available": true, "constant_name": "THERE_IS_A_GL_CODE_SECTION_WITH_THE_SAME_NAME" }, { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_44", "status": 400, "message": { "ar": "قسم رمز الحساب العام:{0} لديه بالفعل قسم فرعي لرمز الحساب العام. لا يمكن أن يكون لديه أكثر من قسم فرعي واحد.", "en": "GL Code Section:{0} has already a child GL Code Section. It cannot have more than one child section.", "tr": "GL Kodu Bölümü:{0} zaten bir alt GL Kodu Bölümüne sahip. Birden fazla alt bölümü olamaz." }, "message_available": true, "constant_name": "GL_CODE_SECTION_HAS_ALREADY_A_CHILD_GL_CODE_SECTION" }, { "code": "ERR_ACCTNG_45", "status": 400, "message": { "ar": "لا يمكن أن يكون قسم رمز الحساب العام الذي يحتوي على نوع دفتر الأستاذ قسمًا رئيسيًا لرمز الحساب العام.", "en": "GL Code Section with Ledger type cannot be a parent GL Code Section.", "tr": "Defter tipindeki GL Kodu Bölümü ana GL Kodu Bölümü olamaz." }, "message_available": true, "constant_name": "GL_CODE_SECTION_WITH_LEDGER_TYPE_CANNOT_BE_PARENT_GL_CODE_SECTION" }, { "code": "ERR_ACCTNG_54", "status": 400, "message": { "ar": "لا يُسمح بوجود أكثر من قسم رئيسي واحد للأب.", "en": "It is not allowed to have more than one main parent section.", "tr": "Birden fazla ana ana bölümün bulunmasına izin verilmez." }, "message_available": true, "constant_name": "MULTIPLE_MAIN_PARENT_SECTIONS_ARE_NOT_ALLOWED" }, { "code": "ERR_ACCTNG_64", "status": 400, "message": { "ar": "قسم رمز GL ليس القسم الرئيسي، بل من الضروري أن يكون هناك قسم رئيسي له", "en": "GL Code Section is not main parent, it is mandatory to have a parent section", "tr": "GL Kodu Bölümü ana üst bölüm değildir, üst bölümün olması zorunludur" }, "message_available": true, "constant_name": "PARENT_SECTION_ID_MUST_BE_PROVIDED" } ] } } }, "/gl-code-sections/{id}": { "delete": { "operationId": "delete-gLCode-section", "tags": [ "gl-code-sections" ], "summary": "delete-gLCode-section", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-gLCode-section", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_233", "status": 400, "message": { "ar": "لا يمكن حذف نوع قسم دفتر الأستاذ في رمز GL.", "en": "GL code section type ledger cannot be deleted.", "tr": "Ledger tipindeki GL kod bölümünü silemezsiniz." }, "message_available": true, "constant_name": "A_RECORD_WITH_SECTION_TYPE_LEDGER_CANNOT_BE_DELETED" }, { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_46", "status": 400, "message": { "ar": "قسم رمز دفتر الأستاذ العام يُستخدم في تنسيق رمز دفتر الأستاذ العام. لا يمكن حذفه.", "en": "GL Code Section is used in GL Code Format. It cannot be deleted.", "tr": "GL Kodu Bölümü GL Kodu Formatında kullanılır. Silinemez." }, "message_available": true, "constant_name": "GL_CODE_SECTION_USED_IN_GL_CODE_FORMAT_CANNOT_BE_DELETED" }, { "code": "ERR_ACCTNG_59", "status": 400, "message": { "ar": "قسم رمز الحساب العام هو قسم رئيسي. لا يمكن حذفه.", "en": "GL Code Section is a parent section. It cannot be deleted.", "tr": "GL Kodu Bölümü bir üst bölümdür. Silinemez." }, "message_available": true, "constant_name": "GL_CODE_SECTION_HAVE_CHILDREN_CAN_NOT_BE_DELETED" } ] } }, "get": { "operationId": "get-gLCode-section-by-id", "tags": [ "gl-code-sections" ], "summary": "get-gLCode-section-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" }, "isMainParent": { "type": "boolean", "x-aura-field-code": "glCodeSectionIsMainParent" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "glCodeSectionIsMandatory" }, "name": { "type": "string", "x-aura-field-code": "glCodeSectionName" }, "parentSectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentGlCodeSectionId" }, "sectionLength": { "type": "integer", "format": "int32", "x-aura-field-code": "glCodeSectionLength" }, "sectionType": { "type": "string", "x-aura-field-code": "glCodeSectionType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-gLCode-section-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "GLCodeSectionDto", "payload": "GLCodeSectionDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "SectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SectionLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsMainParent", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsMandatory", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentSectionId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" } ] } }, "put": { "operationId": "update-gLCode-section", "tags": [ "gl-code-sections" ], "summary": "update-gLCode-section", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isMainParent": { "type": "boolean", "x-aura-field-code": "glCodeSectionIsMainParent" }, "isMandatory": { "type": "boolean", "x-aura-field-code": "glCodeSectionIsMandatory" }, "name": { "type": "string", "x-aura-field-code": "glCodeSectionName" }, "parentSectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentGlCodeSectionId" }, "sectionLength": { "type": "integer", "format": "int32", "x-aura-field-code": "glCodeSectionLength" }, "sectionType": { "type": "string", "x-aura-field-code": "glCodeSectionType" } }, "required": [ "isMainParent", "isMandatory", "name", "sectionLength", "sectionType" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 6, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-gLCode-section", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "SectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "SectionLength", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMainParent", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsMandatory", "declared_type": null, "nullable": true, "collection": false }, { "name": "ParentSectionId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_232", "status": 400, "message": null, "message_available": false, "constant_name": "SECTION_TYPES_MUST_BE_ONEOFTHE_DEFINED_TYPES" }, { "code": "ERR_ACCTNG_42", "status": 400, "message": { "ar": "هناك قسم رمز الحساب العام بنفس الاسم {0}.", "en": "There is a GL Code Section with the same name {0}.", "tr": "Aynı isimde {0} olan bir GL Kodu Bölümü bulunmaktadır." }, "message_available": true, "constant_name": "THERE_IS_A_GL_CODE_SECTION_WITH_THE_SAME_NAME" }, { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_44", "status": 400, "message": { "ar": "قسم رمز الحساب العام:{0} لديه بالفعل قسم فرعي لرمز الحساب العام. لا يمكن أن يكون لديه أكثر من قسم فرعي واحد.", "en": "GL Code Section:{0} has already a child GL Code Section. It cannot have more than one child section.", "tr": "GL Kodu Bölümü:{0} zaten bir alt GL Kodu Bölümüne sahip. Birden fazla alt bölümü olamaz." }, "message_available": true, "constant_name": "GL_CODE_SECTION_HAS_ALREADY_A_CHILD_GL_CODE_SECTION" }, { "code": "ERR_ACCTNG_45", "status": 400, "message": { "ar": "لا يمكن أن يكون قسم رمز الحساب العام الذي يحتوي على نوع دفتر الأستاذ قسمًا رئيسيًا لرمز الحساب العام.", "en": "GL Code Section with Ledger type cannot be a parent GL Code Section.", "tr": "Defter tipindeki GL Kodu Bölümü ana GL Kodu Bölümü olamaz." }, "message_available": true, "constant_name": "GL_CODE_SECTION_WITH_LEDGER_TYPE_CANNOT_BE_PARENT_GL_CODE_SECTION" }, { "code": "ERR_ACCTNG_47", "status": 400, "message": { "ar": "القسم الذي نوعه \"دفتر الأستاذ\" هو القسم الافتراضي. لا يمكن تحديثه.", "en": "The section with the type 'ledger' is default section. It cannot be updated.", "tr": "'Defter' tipinin bulunduğu bölüm varsayılan bölümdür. Güncellenemez." }, "message_available": true, "constant_name": "THE_SECTION_WITH_THE_TYPE_LEDGER_IS_DEFAULT_SECTION_IT_CANNOT_BE_UPDATED" }, { "code": "ERR_ACCTNG_48", "status": 400, "message": { "ar": "أقسام رمز دفتر الأستاذ العام التي تحتوي على أنواع الأقسام \"شركة\" و\"فرع\" و\"دفتر الأستاذ\" هي أقسام افتراضية. لا يمكن تحديث قيمة \"النوع\" الخاصة بها.", "en": "GL Code Sections with the 'Company', 'Branch' and 'Ledger' section types are default sections. Their 'Type' value cannot be updated.", "tr": "'Şirket', 'Şube' ve 'Defter' bölüm türlerini içeren GL Kodu Bölümleri varsayılan bölümlerdir. 'Tür' değeri güncellenemez." }, "message_available": true, "constant_name": "GL_CODE_SECTIONS_WITH_THE_COMPANY_BRANCH_AND_LEDGER_SECTION_TYPES_ARE_DEFAULT_SECTIONS_THEIR_TYPE_VALUE_CANNOT_BE_UPDATED" }, { "code": "ERR_ACCTNG_49", "status": 400, "message": { "ar": "لا يُسمح بوجود أكثر من قسم واحد بأنواع أقسام \"الشركة\" و\"الفرع\" و\"دفتر الأستاذ\".", "en": "It is not allowed to have more than one section with the 'Company', 'Branch' and 'Ledger' section types.", "tr": "'Şirket', 'Şube' ve 'Defter' bölüm tiplerinde birden fazla bölüm bulundurulamaz." }, "message_available": true, "constant_name": "IT_IS_NOT_ALLOWED_TO_HAVE_MORE_THAN_ONE_SECTION_WITH_THE_COMPANY_BRANCH_AND_LEDGER_SECTION_TYPES" }, { "code": "ERR_ACCTNG_54", "status": 400, "message": { "ar": "لا يُسمح بوجود أكثر من قسم رئيسي واحد للأب.", "en": "It is not allowed to have more than one main parent section.", "tr": "Birden fazla ana ana bölümün bulunmasına izin verilmez." }, "message_available": true, "constant_name": "MULTIPLE_MAIN_PARENT_SECTIONS_ARE_NOT_ALLOWED" }, { "code": "ERR_ACCTNG_55", "status": 400, "message": { "ar": "لا يمكن أن يكون قسم رمز الحساب العام هو القسم الأب الخاص به. قسم رمز الحساب العام: {0}", "en": "GL Code Section cannot be its own parent GL Code Section. GL Code Section : {0}", "tr": "GL Kodu Bölümü, kendi ana GL Kodu Bölümü olamaz. GL Kodu Bölümü : {0}" }, "message_available": true, "constant_name": "GL_CODE_SECTION_CANNOT_BE_ITS_OWN_PARENT_GL_CODE_SECTION" }, { "code": "ERR_ACCTNG_64", "status": 400, "message": { "ar": "قسم رمز GL ليس القسم الرئيسي، بل من الضروري أن يكون هناك قسم رئيسي له", "en": "GL Code Section is not main parent, it is mandatory to have a parent section", "tr": "GL Kodu Bölümü ana üst bölüm değildir, üst bölümün olması zorunludur" }, "message_available": true, "constant_name": "PARENT_SECTION_ID_MUST_BE_PROVIDED" } ] } } }, "/gl-code-sections/{id}/values": { "get": { "operationId": "get-gLCode-section-value-list", "tags": [ "gl-code-sections" ], "summary": "get-gLCode-section-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "glCodeSectionId": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" }, "glCodeSectionValueId": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionValueId" }, "name": { "type": "string", "x-aura-field-code": "glCodeSectionValueName" }, "parentValueId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentGlCodeSectionValueId" }, "sectionValue": { "type": "string", "x-aura-field-code": "glCodeSectionValue" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-gLCode-section-value-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections/{id}/values", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "GLCodeSectionValueDto", "collection": true, "members": [ { "name": "GLCodeSectionId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "GLCodeSectionValueId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SectionValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentValueId", "declared_type": "Guid?", "nullable": true, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_65", "status": 400, "message": { "ar": "يجب استخدام طرق دفتر الأستاذ للحصول على قيمة القسم الذي نوعه ليس هو دفتر الأستاذ.", "en": "Get Ledger methods should be used to get value of the section whose 'type' is not 'Ledger'.", "tr": "'Ledger' section type section value içermediği için sorgulanamaz." }, "message_available": true, "constant_name": "GET_LEDGER_METHODS_SHOULD_BE_USED_TO_GET_VALUE_OF_THE_SECTION_WHOSE_TYPE_IS_LEDGER" } ] } }, "post": { "operationId": "create-gLCode-section-value", "tags": [ "gl-code-sections" ], "summary": "create-gLCode-section-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "glCodeSectionValues": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "x-aura-field-code": "glCodeSectionValueName" }, "parentValueId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentGlCodeSectionValueId" }, "sectionValue": { "type": "string", "x-aura-field-code": "glCodeSectionValue" } }, "required": [ "name", "sectionValue" ], "x-aura-field-code": "glCodeSectionValues" } } }, "required": [ "glCodeSectionValues" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-gLCode-section-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections/{id}/values", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_56", "status": 400, "message": { "ar": "هناك قيمة قسم بالفعل مثل {0}.", "en": "There is already a section value like {0}.", "tr": "Zaten {0} gibi bir bölüm değeri var." }, "message_available": true, "constant_name": "SECTION_VALUE_IS_ALREADY_EXISTS" }, { "code": "ERR_ACCTNG_57", "status": 400, "message": { "ar": "يجب تحديد قيمة قسم رمز دفتر الأستاذ الذي يكون نوعه \"دفتر الأستاذ\" باستخدام طريقة إنشاء دفتر الأستاذ.", "en": "Value of the GL Code Section whose 'type' is 'Ledger' must be defined with the Create Ledger method.", "tr": "'Türü' 'Defter' olan GL Kodu bölümünün değeri Create Ledger yöntemi ile tanımlanmalıdır." }, "message_available": true, "constant_name": "VALUE_OF_THE_GL_CODE_SECTION_WHOSE_TYPE_IS_LEDGER_MUST_BE_DEFINED_WITH_THE_CREATE_LEDGER_METHOD" }, { "code": "ERR_ACCTNG_58", "status": 400, "message": { "ar": "لا يمكن أن تكون قيمة قسم رمز الحساب العام أكبر من طول قسم رمز الحساب العام: {0}.", "en": "GL Code Section Value length cannot be larger than the GL Code Section length: {0}.", "tr": "GL Kodu Bölüm Değeri uzunluğu GL Kodu Bölüm uzunluğundan daha büyük olamaz: {0}." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_LENGTH_CANNOT_BE_LARGER_THAN_THE_GL_CODE_SECTION_LENGTH" }, { "code": "ERR_ACCTNG_61", "status": 400, "message": { "ar": "لا يمكن أن تحتوي قيمة القسم على مسافة بيضاء.", "en": "Section value cannot contain white space.", "tr": "Bölüm değeri boşluk içeremez." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_CANNOT_CONTAIN_WHITESPACE" }, { "code": "ERR_ACCTNG_63", "status": 400, "message": { "ar": "قسم رمز GL:{0} موجود في قسم الطفل، يجب تقديم 'parentValueId'.", "en": "GL Code Section:{0} is in child section position, 'parentValueId' must be provided.", "tr": "GL Code Bölüm:{0} alt bölüm konumunda, 'parentValueId' sağlanmalıdır." }, "message_available": true, "constant_name": "GL_CODE_SECTION_IS_IN_CHILD_SECTION_POSITION_PARENTVALUEID_MUST_BE_PROVIDED" }, { "code": "ERR_ACCTNG_69", "status": 400, "message": { "ar": "لم يتم العثور على قيمة قسم رمز الحساب العام. معرف قيمة قسم رمز الحساب العام = {0}.", "en": "GL Code Section Value not found. GL code section value id = {0}.", "tr": "GL Kodu Bölüm Değeri bulunamadı. GL kodu bölümü değeri kimliği = {0}." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_NOT_FOUND_VALUE_ID" }, { "code": "ERR_ACCTNG_91", "status": 400, "message": { "ar": "لم يتم العثور على قيمة قسم رمز GL {0} في القسم {1}.", "en": "GL Code Section Value {0} in {1} section is not found.", "tr": "GL Kodu Bölüm {1} bölümünde Değer {0} bulunamadı." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_IN_SECTION_IS_NOT_FOUND" } ] } } }, "/gl-code-sections/{id}/values/{valueId}": { "delete": { "operationId": "delete-gLCode-section-value", "tags": [ "gl-code-sections" ], "summary": "delete-gLCode-section-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionValueId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-gLCode-section-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections/{id}/values/{valueId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_76", "status": 400, "message": { "ar": "لم يتم العثور على قيمة قسم رمز الحساب العام. معرف قيمة قسم رمز الحساب العام={0}.", "en": "GL Code Section Value not found. GL code section value id ={0}.", "tr": "GL Code Bölüm Değeri bulunamadı. GL kodu bölüm değeri id ={0}." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_VALUE_NOT_FOUND" }, { "code": "ERR_ACCTNG_78", "status": 400, "message": { "ar": "الكودات العمومية باستخدام قيمة قسم الكود العمومي المحددة تُستخدم في قيد الحسابات. لا يمكن حذفها.", "en": "GL Codes with the given Gl Code Section Value is used for accounting entry. It cannot be deleted.", "tr": "Muhasebe girişi için Gl Kodu Bölüm Değeri verilen GL Kodları kullanılır. Silinemez." }, "message_available": true, "constant_name": "SECTION_VALUE_IS_USED_CANNOT_BE_DELETED" } ] } }, "put": { "operationId": "update-gLCode-section-value", "tags": [ "gl-code-sections" ], "summary": "update-gLCode-section-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionId" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "glCodeSectionValueId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "x-aura-field-code": "glCodeSectionValueName" }, "parentValueId": { "type": "string", "format": "uuid", "x-aura-field-code": "parentGlCodeSectionValueId" }, "sectionValue": { "type": "string", "x-aura-field-code": "glCodeSectionValue" } }, "required": [ "name", "sectionValue" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-gLCode-section-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-code-sections/{id}/values/{valueId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "SectionValue", "declared_type": null, "nullable": false, "collection": false }, { "name": "ParentValueId", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_43", "status": 400, "message": { "ar": "القسم {0} من رمز GL غير موجود.", "en": "Gl Code Section:{0} is not found.", "tr": "Gl Kodu Bölümü:{0} bulunamadı." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_NOT_FOUND" }, { "code": "ERR_ACCTNG_56", "status": 400, "message": { "ar": "هناك قيمة قسم بالفعل مثل {0}.", "en": "There is already a section value like {0}.", "tr": "Zaten {0} gibi bir bölüm değeri var." }, "message_available": true, "constant_name": "SECTION_VALUE_IS_ALREADY_EXISTS" }, { "code": "ERR_ACCTNG_58", "status": 400, "message": { "ar": "لا يمكن أن تكون قيمة قسم رمز الحساب العام أكبر من طول قسم رمز الحساب العام: {0}.", "en": "GL Code Section Value length cannot be larger than the GL Code Section length: {0}.", "tr": "GL Kodu Bölüm Değeri uzunluğu GL Kodu Bölüm uzunluğundan daha büyük olamaz: {0}." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_LENGTH_CANNOT_BE_LARGER_THAN_THE_GL_CODE_SECTION_LENGTH" }, { "code": "ERR_ACCTNG_61", "status": 400, "message": { "ar": "لا يمكن أن تحتوي قيمة القسم على مسافة بيضاء.", "en": "Section value cannot contain white space.", "tr": "Bölüm değeri boşluk içeremez." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_CANNOT_CONTAIN_WHITESPACE" }, { "code": "ERR_ACCTNG_63", "status": 400, "message": { "ar": "قسم رمز GL:{0} موجود في قسم الطفل، يجب تقديم 'parentValueId'.", "en": "GL Code Section:{0} is in child section position, 'parentValueId' must be provided.", "tr": "GL Code Bölüm:{0} alt bölüm konumunda, 'parentValueId' sağlanmalıdır." }, "message_available": true, "constant_name": "GL_CODE_SECTION_IS_IN_CHILD_SECTION_POSITION_PARENTVALUEID_MUST_BE_PROVIDED" }, { "code": "ERR_ACCTNG_69", "status": 400, "message": { "ar": "لم يتم العثور على قيمة قسم رمز الحساب العام. معرف قيمة قسم رمز الحساب العام = {0}.", "en": "GL Code Section Value not found. GL code section value id = {0}.", "tr": "GL Kodu Bölüm Değeri bulunamadı. GL kodu bölümü değeri kimliği = {0}." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_NOT_FOUND_VALUE_ID" }, { "code": "ERR_ACCTNG_70", "status": 400, "message": { "ar": "لا يمكن تحديث قيمة قسم رمز الحساب العام {0} المستخدم في رمز الحساب العام.", "en": "GL Code Section value {0} is used in GL Code. It cannot be updated.", "tr": "GL Kodu Bölüm değeri {0} GL Kodunda kullanılır. Güncellenemez." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_IS_USED_IN_GL_CODE_IT_CANNOT_BE_UPDATED" }, { "code": "ERR_ACCTNG_76", "status": 400, "message": { "ar": "لم يتم العثور على قيمة قسم رمز الحساب العام. معرف قيمة قسم رمز الحساب العام={0}.", "en": "GL Code Section Value not found. GL code section value id ={0}.", "tr": "GL Code Bölüm Değeri bulunamadı. GL kodu bölüm değeri id ={0}." }, "message_available": true, "constant_name": "SUITABLE_GL_CODE_SECTION_VALUE_NOT_FOUND" }, { "code": "ERR_ACCTNG_91", "status": 400, "message": { "ar": "لم يتم العثور على قيمة قسم رمز GL {0} في القسم {1}.", "en": "GL Code Section Value {0} in {1} section is not found.", "tr": "GL Kodu Bölüm {1} bölümünde Değer {0} bulunamadı." }, "message_available": true, "constant_name": "GL_CODE_SECTION_VALUE_IN_SECTION_IS_NOT_FOUND" } ] } } }, "/gl-codes": { "get": { "operationId": "get-gLCode-list-for-ledger", "tags": [ "gl-codes" ], "summary": "get-gLCode-list-for-ledger", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "glCodes": { "x-aura-type": "unresolved" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-gLCode-list-for-ledger", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-codes", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "GLCodeWithLedgerDto", "collection": true, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GLCodes", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/gl-codes/by-ledger-code/{ledgerCode}": { "get": { "operationId": "get-gLCode-by-ledger-code-list", "tags": [ "gl-codes" ], "summary": "get-gLCode-by-ledger-code-list", "parameters": [ { "name": "ledgerCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "ledgerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "glCodes": { "x-aura-type": "unresolved" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-gLCode-by-ledger-code-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "gl-codes/by-ledger-code/{ledgerCode}", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LedgerCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "GLCodeListDto", "payload": "GLCodeListDto", "collection": false, "members": [ { "name": "GLCodes", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_21", "status": 400, "message": { "ar": "السجل '{0}' غير موجود", "en": "Ledger '{0}' is not found", "tr": "'{0}' defteri bulunamadı" }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NOT_NULL" } ] } } }, "/interbranch-accounts": { "get": { "operationId": "get-interbranch-account-list", "tags": [ "interbranch-accounts" ], "summary": "get-interbranch-account-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "currencyGroup": { "x-aura-type": "unresolved" }, "currencyId": { "x-aura-type": "unresolved" }, "currencyType": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-interbranch-account-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "interbranch-accounts", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "InterbranchAccountDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-interbranch-account", "tags": [ "interbranch-accounts" ], "summary": "create-interbranch-account", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "type": "object", "properties": { "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } }, "required": [ "currencyGroup", "currencyNumber", "currencyType", "ledgerCode" ], "x-aura-field-code": "accounts" } } }, "required": [ "accounts" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-interbranch-account", "x-aura-domain": "accounting", "x-aura-raw-url-path": "interbranch-accounts", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_117", "status": 400, "message": { "ar": "لا يمكن استخدام دفاتر الحسابات من نوع \"الرئيسي\" في قيود المحاسبة.", "en": "'Main' type ledgers cannot be used in accounting entries.", "tr": "Muhasebe girişlerinde 'Ana' tipi defterler kullanılamaz." }, "message_available": true, "constant_name": "LEDGER_TYPE_CANNOT_BE_MAIN" }, { "code": "ERR_ACCTNG_200", "status": 400, "message": { "ar": "لا يُسمح بإنشاء حساب فرع داخلي أكثر من مرة بنفس قيم 'معرف العملة'، و'نوع العملة'، و'مجموعة العملة'.", "en": "It is not allowed to create more than one interbranch account with the same 'currencyId', 'currencyType' and 'currencyGroup'.", "tr": "Aynı 'currencyId', 'currencyType' ve 'currencyGroup' değerlerine sahip birden fazla şubelerarası hesap oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "CURRENCY_CANNOT_BE_SAME" }, { "code": "ERR_ACCTNG_21", "status": 400, "message": { "ar": "السجل '{0}' غير موجود", "en": "Ledger '{0}' is not found", "tr": "'{0}' defteri bulunamadı" }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NOT_NULL" } ] } } }, "/interbranch-accounts/{id}": { "put": { "operationId": "update-interbranch-account", "tags": [ "interbranch-accounts" ], "summary": "update-interbranch-account", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyGroup": { "x-aura-type": "unresolved" }, "currencyId": { "x-aura-type": "unresolved" }, "currencyType": { "x-aura-type": "unresolved" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } }, "required": [ "currencyGroup", "currencyId", "currencyType", "ledgerCode" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-interbranch-account", "x-aura-domain": "accounting", "x-aura-raw-url-path": "interbranch-accounts/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyType", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_117", "status": 400, "message": { "ar": "لا يمكن استخدام دفاتر الحسابات من نوع \"الرئيسي\" في قيود المحاسبة.", "en": "'Main' type ledgers cannot be used in accounting entries.", "tr": "Muhasebe girişlerinde 'Ana' tipi defterler kullanılamaz." }, "message_available": true, "constant_name": "LEDGER_TYPE_CANNOT_BE_MAIN" }, { "code": "ERR_ACCTNG_200", "status": 400, "message": { "ar": "لا يُسمح بإنشاء حساب فرع داخلي أكثر من مرة بنفس قيم 'معرف العملة'، و'نوع العملة'، و'مجموعة العملة'.", "en": "It is not allowed to create more than one interbranch account with the same 'currencyId', 'currencyType' and 'currencyGroup'.", "tr": "Aynı 'currencyId', 'currencyType' ve 'currencyGroup' değerlerine sahip birden fazla şubelerarası hesap oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "CURRENCY_CANNOT_BE_SAME" }, { "code": "ERR_ACCTNG_201", "status": 400, "message": { "ar": "لم يتم العثور على حساب الفرع بالمعرف المعطى: '{0}'.", "en": "Interbranch account is not found with the given id: '{0}'.", "tr": "Belirtilen kimliğe sahip Şubeler arası hesap bulunamadı: '{0}'." }, "message_available": true, "constant_name": "INTER_BRANCH_ACCOUNT_COULD_NOT_BE_FOUND" } ] } } }, "/key-formats/by-code/{code}/reset-counter": { "put": { "operationId": "accounting-reset-key-format-counter-by-code", "tags": [ "key-formats" ], "summary": "accounting-reset-key-format-counter-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Present in the route template but not declared as a Route-bound field in the catalog.", "x-aura-source": "route-template-only" } ], "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-reset-key-format-counter-by-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "key-formats/by-code/{code}/reset-counter", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_KYGNR_1", "status": 400, "message": null, "message_available": false, "constant_name": "KEY_FORMAT_NOT_FOUND_BY_CODE" } ] } } }, "/ledger-balances/by-account-number/{accountNumber}": { "get": { "operationId": "get-ledger-balance-by-account-number", "tags": [ "ledger-balances" ], "summary": "get-ledger-balance-by-account-number", "parameters": [ { "name": "accountNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "accountNumber" } }, { "name": "balanceDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "balanceDate" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "balanceDate": { "type": "string", "format": "date", "x-aura-field-code": "balanceDate" }, "ledgers": { "type": "array", "items": { "type": "object", "properties": { "balances": { "type": "array", "items": { "type": "object", "properties": { "creditBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "creditBalance" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "debitBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "debitBalance" }, "totalBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "totalBalance" } }, "x-aura-field-code": "balances" } }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } }, "x-aura-field-code": "ledgers" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-balance-by-account-number", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-balances/by-account-number/{accountNumber}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BalanceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerBalanceDto", "payload": "LedgerBalanceDto", "collection": false, "members": [ { "name": "BalanceDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "Ledgers", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/ledger-balances/details": { "get": { "operationId": "get-ledger-balance-detail", "tags": [ "ledger-balances" ], "summary": "get-ledger-balance-detail", "parameters": [ { "name": "accountNumber", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "accountNumber" } }, { "name": "beginDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "balanceBeginDate" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "balanceEndDate" } }, { "name": "ledgerCodeBegin", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "ledgerCodeBegin" } }, { "name": "ledgerCodeEnd", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "ledgerCodeEnd" } }, { "name": "ledgerCodeList", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "x-aura-field-code": "ledgerCodeList" } } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "organizationCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "organizationCode" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } }, { "name": "withPreviousBalance", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "withPreviousBalance" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 12 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "accountingEntryId" }, "balanceType": { "type": "integer", "format": "int32", "x-aura-field-code": "balanceType" }, "creditAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "creditAmount" }, "creditBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "creditBalance" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "debitAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "debitAmount" }, "debitBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "debitBalance" }, "description": { "type": "string", "x-aura-field-code": "accountingEntryDetailDescription" }, "financialTransactionCode": { "type": "string", "x-aura-field-code": "financialTransactionCode" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "ledgerName": { "type": "string", "x-aura-field-code": "ledgerName" }, "organizationCode": { "type": "string", "x-aura-field-code": "organizationCode" }, "reversalAccountingEntryId": { "type": "string", "format": "uuid", "x-aura-field-code": "reversalAccountingEntryId" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-balance-detail", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-balances/details", "x-aura-capabilities": { "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BeginDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerCodeBegin", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerCodeEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "WithPreviousBalance", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerBalanceDetailDto", "collection": true, "members": [ { "name": "TransactionDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BalanceType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DebitAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CreditAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DebitBalance", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CreditBalance", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "AccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ReversalAccountingEntryId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FinancialTransactionCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_175", "status": 400, "message": { "ar": "يجب أن يكون تاريخ الانتهاء أكبر من تاريخ البداية.", "en": "'endDate' must be bigger than 'beginDate'.", "tr": "'endDate' 'beginDate' den büyük olmalı." }, "message_available": true, "constant_name": "END_DATE_MUST_BE_BIGGER_BEGIN_DATE" }, { "code": "ERR_ACCTNG_190", "status": 400, "message": { "ar": "غير مسموح بالاستعلام عن رصيد مؤجل لمزيد من التاريخ.", "en": "It is not allowed to query a future dated balance.", "tr": "İleri tarihli bakiye sorgulamaya izin verilmez." }, "message_available": true, "constant_name": "DATE_CANNOT_BE_GREATER_THAN_TODAY" } ] } } }, "/ledger-code-matrix": { "get": { "operationId": "get-ledger-matrix-list", "tags": [ "ledger-code-matrix" ], "summary": "get-ledger-matrix-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "description": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "ledgerMatrixFields": { "type": "array", "items": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldDescription" }, "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" }, "ledgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" }, "name": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldName" } }, "x-aura-field-code": "ledgerMatrixValues" } }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-matrix-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerMatrixDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerMatrixFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-ledger-matrix", "tags": [ "ledger-code-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Creates ledger matrix", "description": "Invokes the `create-ledger-matrix` service definition through `POST /ledger-code-matrix`.\n\nTurkish display name: Ledger matrix oluşturur", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "ledgerMatrixDescription" }, "name": { "type": "string", "x-aura-field-code": "ledgerMatrixName" } }, "required": [ "description", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-ledger-matrix", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_95", "status": 400, "message": { "ar": "غير مسموح بإنشاء أكثر من جدول بنفس الاسم. الاسم: '{0}'.", "en": "It is not allowed to create more than one table with the same name. Name: '{0}'.", "tr": "Aynı isimde birden fazla tablo oluşturulmasına izin verilmez. Ad: '{0}'." }, "message_available": true, "constant_name": "LEDGER_MATRIX_ALREADY_EXISTS" } ] } } }, "/ledger-code-matrix/{id}": { "delete": { "operationId": "delete-ledger-matrix", "tags": [ "ledger-code-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Deleting Record From Ledger Matrix Table", "description": "Invokes the `delete-ledger-matrix` service definition through `DELETE /ledger-code-matrix/{id}`.\n\nTurkish display name: Ledger Matrix Tablosundan Kayıt Siler", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-ledger-matrix", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" }, { "code": "ERR_ACCTNG_98", "status": 400, "message": { "ar": "جدول المصفوفة يحتوي على أعمدة. لا يمكن حذفه.", "en": "Matrix table has columns. It cannot be deleted.", "tr": "Matris tablosunun sütunları vardır. Silinemez." }, "message_available": true, "constant_name": "MATRIX_TABLE_CANNOT_BE_DELETED" } ] } }, "get": { "operationId": "get-ledger-matrix-by-id", "tags": [ "ledger-code-matrix" ], "summary": "get-ledger-matrix-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "ledgerMatrixDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" }, "name": { "type": "string", "x-aura-field-code": "ledgerMatrixName" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-matrix-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerMatrixDto", "payload": "LedgerMatrixDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerMatrixFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } }, "put": { "operationId": "update-ledger-matrix", "tags": [ "ledger-code-matrix" ], "summary": "update-ledger-matrix", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "ledgerMatrixDescription" }, "name": { "type": "string", "x-aura-field-code": "ledgerMatrixName" } }, "required": [ "description", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-ledger-matrix", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_95", "status": 400, "message": { "ar": "غير مسموح بإنشاء أكثر من جدول بنفس الاسم. الاسم: '{0}'.", "en": "It is not allowed to create more than one table with the same name. Name: '{0}'.", "tr": "Aynı isimde birden fazla tablo oluşturulmasına izin verilmez. Ad: '{0}'." }, "message_available": true, "constant_name": "LEDGER_MATRIX_ALREADY_EXISTS" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } } }, "/ledger-code-matrix/{id}/by-field-id/{fieldId}": { "get": { "operationId": "get-ledger-matrix-field-by-id", "tags": [ "ledger-code-matrix" ], "summary": "get-ledger-matrix-field-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldDescription" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" }, "ledgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" }, "ledgerMatrixValues": { "type": "array", "items": { "type": "object", "properties": { "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "mainLedgerCode": { "type": "string", "x-aura-field-code": "mainLedgerCode" }, "valueId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixValueId" } }, "x-aura-field-code": "ledgerMatrixValues" } }, "name": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldName" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-matrix-field-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/by-field-id/{fieldId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerMatrixFieldByIdDto", "payload": "LedgerMatrixFieldByIdDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LedgerMatrixId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerMatrixValues", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_108", "status": 400, "message": { "ar": "لم يتم العثور على حقل مصفوفة دفتر الأستاذ بالمعرف المحدد '{0}'.", "en": "Ledger Matrix Field is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Genel Muhasebe Matrisi Alanı bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } } }, "/ledger-code-matrix/{id}/fields": { "get": { "operationId": "get-ledger-matrix-field-by-ledger-matrix-id", "tags": [ "ledger-code-matrix" ], "summary": "get-ledger-matrix-field-by-ledger-matrix-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 4 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldDescription" }, "fieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" }, "ledgerMatrixId": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" }, "name": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldName" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-matrix-field-by-ledger-matrix-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerMatrixFieldDto", "collection": true, "members": [ { "name": "LedgerMatrixId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-ledger-matrix-field", "tags": [ "ledger-code-matrix" ], "summary": "create-ledger-matrix-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldDescription" }, "name": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldName" } }, "required": [ "description", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-ledger-matrix-field", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_100", "status": 400, "message": { "ar": "لا يُسمح بإنشاء أكثر من عمود بنفس الاسم '{0}' في جدول واحد.", "en": "It is not allowed to create more than one column with the same name '{0}' in one table.", "tr": "Bir tabloda '{0}' aynı adı taşıyan birden fazla sütunun oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_ALREADY_EXISTS" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } } }, "/ledger-code-matrix/{id}/fields/{fieldId}": { "delete": { "operationId": "delete-ledger-matrix-field", "tags": [ "ledger-code-matrix" ], "summary": "delete-ledger-matrix-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-ledger-matrix-field", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields/{fieldId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_103", "status": 400, "message": { "ar": "لا يمكن حذف عمود جدول المصفوفة '{0}' المستخدم في المعاملة '{1}'.", "en": "Matrix table column '{0}' is used in Transaction '{1}'. It cannot be deleted.", "tr": "'{0}' matris tablosu sütunu, '{1}' İşleminde kullanılıyor. Silinemez." }, "message_available": true, "constant_name": null }, { "code": "ERR_ACCTNG_108", "status": 400, "message": { "ar": "لم يتم العثور على حقل مصفوفة دفتر الأستاذ بالمعرف المحدد '{0}'.", "en": "Ledger Matrix Field is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Genel Muhasebe Matrisi Alanı bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" }, { "code": "ERR_ACCTNG_97", "status": 400, "message": { "ar": "عمود جدول المصفوفة يحتوي على نقطة. لا يمكن حذفه.", "en": "Matrix table column has. It cannot be deleted.", "tr": "Matris tablosu sütunu. Silinemez." }, "message_available": true, "constant_name": null } ] } }, "get": { "operationId": "get-ledger-matrix-value-list", "tags": [ "ledger-code-matrix" ], "summary": "get-ledger-matrix-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "mainLedgerCode": { "type": "string", "x-aura-field-code": "mainLedgerCode" }, "valueId": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-matrix-value-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields/{fieldId}", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerMatrixValueDto", "collection": true, "members": [ { "name": "ValueId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "MainLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_108", "status": 400, "message": { "ar": "لم يتم العثور على حقل مصفوفة دفتر الأستاذ بالمعرف المحدد '{0}'.", "en": "Ledger Matrix Field is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Genel Muhasebe Matrisi Alanı bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } }, "put": { "operationId": "update-ledger-matrix-field", "tags": [ "ledger-code-matrix" ], "summary": "update-ledger-matrix-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldDescription" }, "name": { "type": "string", "x-aura-field-code": "ledgerMatrixFieldName" } }, "required": [ "description", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-ledger-matrix-field", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields/{fieldId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_100", "status": 400, "message": { "ar": "لا يُسمح بإنشاء أكثر من عمود بنفس الاسم '{0}' في جدول واحد.", "en": "It is not allowed to create more than one column with the same name '{0}' in one table.", "tr": "Bir tabloda '{0}' aynı adı taşıyan birden fazla sütunun oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_ALREADY_EXISTS" }, { "code": "ERR_ACCTNG_108", "status": 400, "message": { "ar": "لم يتم العثور على حقل مصفوفة دفتر الأستاذ بالمعرف المحدد '{0}'.", "en": "Ledger Matrix Field is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Genel Muhasebe Matrisi Alanı bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } } }, "/ledger-code-matrix/{id}/fields/{fieldId}/values": { "post": { "operationId": "create-ledger-matrix-value", "tags": [ "ledger-code-matrix" ], "summary": "create-ledger-matrix-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ledgers": { "type": "array", "items": { "type": "object", "properties": { "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "mainLedgerCode": { "type": "string", "x-aura-field-code": "mainLedgerCode" } }, "required": [ "ledgerCode", "mainLedgerCode" ], "x-aura-field-code": "ledgers" } } }, "required": [ "ledgers" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-ledger-matrix-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields/{fieldId}/values", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" } } }, "/ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}": { "delete": { "operationId": "delete-ledger-matrix-value", "tags": [ "ledger-code-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Deletes ledger matrix value", "description": "Invokes the `delete-ledger-matrix-value` service definition through `DELETE /ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}`.\n\nTurkish display name: Ledger matrix value siler", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixValueId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 3, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-ledger-matrix-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FieldId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_108", "status": 400, "message": { "ar": "لم يتم العثور على حقل مصفوفة دفتر الأستاذ بالمعرف المحدد '{0}'.", "en": "Ledger Matrix Field is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle Genel Muhasebe Matrisi Alanı bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_COLUMN_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_112", "status": 400, "message": { "ar": "لم يتم العثور على قيمة المصفوفة بالمعرف المُعطى '{0}'.", "en": "Matrix value is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle matris değeri bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_VALUE_IS_NOT_FOUND" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } }, "put": { "operationId": "update-ledger-matrix-value", "tags": [ "ledger-code-matrix" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Updates ledger matrix value", "description": "Invokes the `update-ledger-matrix-value` service definition through `PUT /ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}`.\n\nTurkish display name: Ledger matrix value günceller", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixId" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixFieldId" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerMatrixValueId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "mainLedgerCode": { "type": "string", "x-aura-field-code": "mainLedgerCode" } }, "required": [ "ledgerCode", "mainLedgerCode" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 3, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-ledger-matrix-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/fields/{fieldId}/values/{valueId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ValueId", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "MainLedgerCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_112", "status": 400, "message": { "ar": "لم يتم العثور على قيمة المصفوفة بالمعرف المُعطى '{0}'.", "en": "Matrix value is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle matris değeri bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_VALUE_IS_NOT_FOUND" } ] } } }, "/ledger-code-matrix/{id}/values/{mainLedgerCode}": { "get": { "operationId": "get-ledger-matrix-value-by-main-ledger-code", "tags": [ "ledger-code-matrix" ], "summary": "get-ledger-matrix-value-by-main-ledger-code", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "mainLedgerCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "mainLedgerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "fieldId": { "x-aura-type": "unresolved" }, "fieldName": { "x-aura-type": "unresolved" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-matrix-value-by-main-ledger-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-code-matrix/{id}/values/{mainLedgerCode}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "MainLedgerCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "LedgerMatrixValueLedgerDto", "collection": true, "members": [ { "name": "FieldId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FieldName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_106", "status": 400, "message": { "ar": "لم يتم العثور على قيمة المصفوفة مع الدفتر الرئيسي المعطى '{0}'.", "en": "Matrix value is not found with the given main ledger '{0}'.", "tr": "Verilen ana defter '{0}' ile matris değeri bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_VALUE_IS_NOT_FOUND_FOR_LEDGER" }, { "code": "ERR_ACCTNG_96", "status": 400, "message": { "ar": "لم يتم العثور على مصفوفة السجل بالمعرف المقدم '{0}'.", "en": "Ledger matrix is not found with given id '{0}'.", "tr": "Verilen '{0}' kimliğiyle genel muhasebe matrisi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_MATRIX_TABLE_NOT_FOUND" } ] } } }, "/ledger-level-formats": { "delete": { "operationId": "delete-ledger-level-format", "tags": [ "ledger-level-formats" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Deletes ledger level format", "description": "Invokes the `delete-ledger-level-format` service definition through `DELETE /ledger-level-formats`.\n\nTurkish display name: Ledger level format listesini siler", "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-ledger-level-format", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-level-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_7", "status": 400, "message": { "ar": "ملف تنسيق مستوى الدفتر غير موجود.", "en": "Ledger level format not found.", "tr": "Defter düzeyinde format bulunamadı." }, "message_available": true, "constant_name": "LEDGER_LEVEL_FORMAT_NOT_FOUND" }, { "code": "ERR_ACCTNG_8", "status": 400, "message": { "ar": "نموذج مستوى دفتر الأستاذ يُستخدم لإنشاء رمز دفتر الأستاذ. لا يمكن حذفه.", "en": "Ledger Level Format is used to create LedgerCode. It cannot be deleted.", "tr": "LedgerCode oluşturmak için Ledger Düzey Formatı kullanılır. Silinemez." }, "message_available": true, "constant_name": "LEDGER_LEVEL_FORMAT_IS_USED_TO_CREATE_LEDGERID_CANNOT_BE_DELETED" } ] } }, "get": { "operationId": "get-ledger-level-format-list", "tags": [ "ledger-level-formats" ], "summary": "get-ledger-level-format-list", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "cumulativeLength": { "type": "integer", "format": "int32", "x-aura-field-code": "cumulativeLength" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isFreeLength": { "type": "boolean", "x-aura-field-code": "isFreeLength" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "levelLength": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevelLength" }, "levelSeparator": { "type": "string", "x-aura-field-code": "separator" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-level-format-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-level-formats", "x-aura-capabilities": { "caching": true, "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerLevelFormatDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LedgerLevel", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LevelLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LevelSeparator", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CumulativeLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsFreeLength", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "create-ledger-level-format", "tags": [ "ledger-level-formats" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "It creates the ledger level format", "description": "Invokes the `create-ledger-level-format` service definition through `POST /ledger-level-formats`.\n\nTurkish display name: Ledger Seviye Formatını tanımlar", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isFreeLength": { "type": "boolean", "x-aura-field-code": "isFreeLength" }, "ledgerLevelList": { "type": "array", "items": { "type": "object", "properties": { "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "levelLength": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevelLength" } }, "required": [ "ledgerLevel" ], "x-aura-field-code": "ledgerLevels" } }, "levelSeparator": { "type": "string", "x-aura-field-code": "levelSeparator" } }, "required": [ "isFreeLength", "ledgerLevelList" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-ledger-level-format", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-level-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_90", "status": 400, "message": { "ar": "صيغة مستوى السجل موجودة بالفعل. يرجى محاولة التحديث.", "en": "Ledger level format already exists. Please try to update.", "tr": "Genel muhasebe düzeyi biçimi zaten mevcut. Lütfen güncellemeyi deneyin." }, "message_available": true, "constant_name": "LEDGER_LEVEL_FORMAT_ALREADY_EXISTS" } ] } }, "put": { "operationId": "update-ledger-level-format", "tags": [ "ledger-level-formats" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Update ledger level format", "description": "Invokes the `update-ledger-level-format` service definition through `PUT /ledger-level-formats`.\n\nTurkish display name: Ledger seviye formatını günceller.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isFreeLength": { "type": "boolean", "x-aura-field-code": "isFreeLength" }, "ledgerLevelList": { "type": "array", "items": { "type": "object", "properties": { "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "levelLength": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevelLength" } }, "required": [ "ledgerLevel" ], "x-aura-field-code": "ledgerLevels" } }, "levelSeparator": { "type": "string", "x-aura-field-code": "levelSeparator" } }, "required": [ "isFreeLength", "ledgerLevelList" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-ledger-level-format", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-level-formats", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_4", "status": 400, "message": { "ar": "يتم استخدام صيغة مستوى دفتر الأستاذ لإنشاء رمز دفتر الأستاذ. لا يمكن تحديثها.", "en": "Ledger Level Format is used to create LedgerCode. It cannot be updated.", "tr": "LedgerCode oluşturmak için Ledger Düzey Formatı kullanılır. Güncellenemez." }, "message_available": true, "constant_name": "LEDGER_LEVEL_FORMAT_IS_USED_TO_CREATE_LEDGERID_CANNOT_BE_UPDATED" }, { "code": "ERR_ACCTNG_7", "status": 400, "message": { "ar": "ملف تنسيق مستوى الدفتر غير موجود.", "en": "Ledger level format not found.", "tr": "Defter düzeyinde format bulunamadı." }, "message_available": true, "constant_name": "LEDGER_LEVEL_FORMAT_NOT_FOUND" } ] } } }, "/ledger-level-formats/{ledgerLevel}": { "get": { "operationId": "get-ledger-level-format-by-level", "tags": [ "ledger-level-formats" ], "summary": "get-ledger-level-format-by-level", "parameters": [ { "name": "ledgerLevel", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "cumulativeLength": { "type": "integer", "format": "int32", "x-aura-field-code": "cumulativeLength" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isFreeLength": { "type": "boolean", "x-aura-field-code": "isFreeLength" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "levelLength": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevelLength" }, "levelSeparator": { "type": "string", "x-aura-field-code": "separator" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-level-format-by-level", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledger-level-formats/{ledgerLevel}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LedgerLevel", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerLevelFormatDto", "payload": "LedgerLevelFormatDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LedgerLevel", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LevelLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LevelSeparator", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CumulativeLength", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsFreeLength", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_3", "status": 400, "message": { "ar": "لم يتم العثور على مستوى السجل.", "en": "Ledger level not found.", "tr": "Defter düzeyi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_LEVEL_MUST_BE_NOT_NULL" } ] } } }, "/ledgers": { "get": { "operationId": "get-ledger-list", "tags": [ "ledgers" ], "summary": "get-ledger-list", "parameters": [ { "name": "beginLedgerCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "ledgerCode" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "ledgerCodeBegin", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "ledgerCodeBegin" } }, { "name": "ledgerCodeEnd", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "ledgerCodeEnd" } }, { "name": "ledgerCodeList", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "x-aura-field-code": "ledgerCodeList" } } }, { "name": "ledgerIds", "in": "query", "required": false, "schema": { "type": "array", "items": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerIdList" } } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 10 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "category": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCategory" }, "character": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCharacter" }, "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "customerOption": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCustomerOption" }, "extendedProperties": { "x-aura-type": "unresolved" }, "hasNegativeBalance": { "type": "boolean", "x-aura-field-code": "hasNegativeBalance" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerId" }, "isManualEntry": { "type": "boolean", "x-aura-field-code": "isManualEntry" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "mainCategory": { "type": "integer", "format": "int32", "x-aura-field-code": "mainLedgerCategory" }, "name": { "type": "string", "x-aura-field-code": "ledgerName" }, "paddedLedgerCode": { "type": "integer", "format": "int64", "x-aura-field-code": "paddedLedgerCode" }, "passiveDate": { "type": "string", "format": "date-time", "x-aura-field-code": "ledgerPassiveDate" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerStatus" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerType" }, "validFrom": { "type": "string", "format": "date", "x-aura-field-code": "validFrom" }, "validTo": { "type": "string", "format": "date", "x-aura-field-code": "validTo" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledgers", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LedgerCodeBegin", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerCodeEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeginLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerDto", "collection": true, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerLevel", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PassiveDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MainCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Category", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Character", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsManualEntry", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CustomerOption", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasNegativeBalance", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaddedLedgerCode", "declared_type": "long", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_22", "status": 400, "message": { "ar": "يجب أن يكون 'ledgerCodeEnd' أكبر من 'ledgerCodeBegin'.", "en": "'ledgerCodeEnd' must be bigger than 'ledgerCodeBegin'.", "tr": "'ledgerCodeEnd', 'ledgerCodeBegin'den büyük olmalıdır." }, "message_available": true, "constant_name": "END_LERGER_MUST_BE_BIGGER_BEGIN_LEDGER" } ] } }, "post": { "operationId": "create-ledger", "tags": [ "ledgers" ], "summary": "create-ledger", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCategory" }, "character": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCharacter" }, "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "customerOption": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCustomerOption" }, "hasNegativeBalance": { "type": "boolean", "x-aura-field-code": "hasNegativeBalance" }, "isManualEntry": { "type": "boolean", "x-aura-field-code": "isManualEntry" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "mainCategory": { "type": "integer", "format": "int32", "x-aura-field-code": "mainLedgerCategory" }, "name": { "type": "string", "x-aura-field-code": "ledgerName" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerType" }, "validFrom": { "type": "string", "format": "date", "x-aura-field-code": "validFrom" }, "validTo": { "type": "string", "format": "date", "x-aura-field-code": "validTo" } }, "required": [ "ledgerCode", "ledgerLevel", "name", "type" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 15, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-ledger", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledgers", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "structure", "declared_type": "CreateLedgerDto", "payload": "CreateLedgerDto", "collection": false, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_10", "status": 400, "message": { "ar": "لا يمكن إنشاء دفتر الأستاذ الأدنى مستوى إذا كانت قيمة \"النوع\" لدفتر الأستاذ الأعلى مستوى هي \"فرعي\".", "en": "Lower level ledger cannot be created if its higher level ledger's 'type' value is 'Sub'.", "tr": "Daha yüksek seviyeli defterin 'tip' değeri 'Alt' ise, düşük seviyeli defter oluşturulamaz." }, "message_available": true, "constant_name": "LOWER_LEDGER_TYPE_MUST_BE_MAIN" }, { "code": "ERR_ACCTNG_11", "status": 400, "message": { "ar": "يجب أن يكون طول \"ledgerId\" متوافقًا مع مستوى دفتر الأستاذ.", "en": "Length of the 'ledgerId' must be compatible with Ledger level.", "tr": "'LedgerId' uzunluğunun Ledger düzeyiyle uyumlu olması gerekir." }, "message_available": true, "constant_name": "LEDGER_LEVEL_LENGTH_MUST_BE_LEDGER_CODE_LENGTH" }, { "code": "ERR_ACCTNG_14", "status": 400, "message": { "ar": "السجل موجود بالفعل. رمز السجل: {0}.", "en": "Ledger already exists. LedgerCode: {0}.", "tr": "Defter zaten mevcut. Defter Kodu: {0}." }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NULL" }, { "code": "ERR_ACCTNG_15", "status": 400, "message": { "ar": "يجب أن يكون رمز دفتر الأستاذ متوافقًا مع تنسيق مستوى دفتر الأستاذ.", "en": "Ledger code must be compatible with the Ledger Level Format.", "tr": "Defter kodu, Defter Düzey Formatı ile uyumlu olmalıdır." }, "message_available": true, "constant_name": "LEDGER_LEVEL_FORMAT_NOT_VALID" }, { "code": "ERR_ACCTNG_20", "status": 400, "message": { "ar": "لم يتم العثور على دفتر账 السابق.", "en": "Previous ledger could not be found.", "tr": "Önceki defter bulunamadı." }, "message_available": true, "constant_name": "PREVIOUS_LEDGER_MUST_BE_NOT_NULL" }, { "code": "ERR_ACCTNG_3", "status": 400, "message": { "ar": "لم يتم العثور على مستوى السجل.", "en": "Ledger level not found.", "tr": "Defter düzeyi bulunamadı." }, "message_available": true, "constant_name": "LEDGER_LEVEL_MUST_BE_NOT_NULL" }, { "code": "ERR_ACCTNG_9", "status": 400, "message": { "ar": "لا يمكن إنشاء دفتر الأستاذ الأدنى بدون دفتر الأستاذ الأعلى له. رمز الدفتر: {0}.", "en": "Lower level ledger cannot be created withouth its higher level. LedgerCode: {0}.", "tr": "Daha düşük seviyeli defter, daha yüksek seviyesi olmadan oluşturulamaz. Defter Kodu: {0}." }, "message_available": true, "constant_name": "PREVIOUS_LEDGER_LEVEL_MUST_BE_NOT_NULL" } ] } } }, "/ledgers/by-ledger-code/{ledgerCode}": { "delete": { "operationId": "delete-ledger", "tags": [ "ledgers" ], "summary": "delete-ledger", "parameters": [ { "name": "ledgerCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "ledgerCode" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-ledger", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledgers/by-ledger-code/{ledgerCode}", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } }, "get": { "operationId": "get-ledger-by-ledger-code", "tags": [ "ledgers" ], "summary": "get-ledger-by-ledger-code", "parameters": [ { "name": "ledgerCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "ledgerCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCategory" }, "character": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCharacter" }, "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "customerOption": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCustomerOption" }, "extendedProperties": { "type": "array", "items": { "type": "object", "x-aura-field-code": "extendedProperties" } }, "hasNegativeBalance": { "type": "boolean", "x-aura-field-code": "hasNegativeBalance" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerId" }, "isManualEntry": { "type": "boolean", "x-aura-field-code": "isManualEntry" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "mainCategory": { "type": "integer", "format": "int32", "x-aura-field-code": "mainLedgerCategory" }, "name": { "type": "string", "x-aura-field-code": "ledgerName" }, "paddedLedgerCode": { "type": "integer", "format": "int64", "x-aura-field-code": "paddedLedgerCode" }, "passiveDate": { "type": "string", "format": "date-time", "x-aura-field-code": "ledgerPassiveDate" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerStatus" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerType" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-by-ledger-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledgers/by-ledger-code/{ledgerCode}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LedgerCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerDto", "payload": "LedgerDto", "collection": false, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerLevel", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PassiveDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MainCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Category", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Character", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsManualEntry", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CustomerOption", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasNegativeBalance", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaddedLedgerCode", "declared_type": "long", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_21", "status": 400, "message": { "ar": "السجل '{0}' غير موجود", "en": "Ledger '{0}' is not found", "tr": "'{0}' defteri bulunamadı" }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NOT_NULL" } ] } } }, "/ledgers/{id}": { "delete": { "operationId": "delete-ledger-by-id", "tags": [ "ledgers" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Delete Ledger", "description": "Invokes the `delete-ledger-by-id` service definition through `DELETE /ledgers/{id}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerId" }, "description": "MERGED TEMPLATE — this parameter does not mean the same thing for every method on this path. `PUT` takes the catalog field `ledgerCode` (string), while `DELETE` takes `ledgerId` (string/uuid). The two catalog rows declared different templates; OpenAPI 3.1 §4.8.8 makes them one path, so the name was unified and the difference in meaning survives only here. Do NOT reuse a value across these methods.", "x-aura-merged-parameter-conflict": { "published_as": "id", "this_method_expects": { "catalog_name": "ledgerId", "type": "string", "format": "uuid" }, "conflicting_methods": { "delete": { "catalog_name": "ledgerId", "type": "string", "format": "uuid" }, "put": { "catalog_name": "ledgerCode", "type": "string", "format": null } } } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-ledger-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledgers/{id}", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } }, "get": { "operationId": "get-ledger-by-id", "tags": [ "ledgers" ], "summary": "get-ledger-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerId" }, "description": "MERGED TEMPLATE — this parameter does not mean the same thing for every method on this path. `PUT` takes the catalog field `ledgerCode` (string), while `GET` takes `ledgerId` (string/uuid). The two catalog rows declared different templates; OpenAPI 3.1 §4.8.8 makes them one path, so the name was unified and the difference in meaning survives only here. Do NOT reuse a value across these methods.", "x-aura-merged-parameter-conflict": { "published_as": "id", "this_method_expects": { "catalog_name": "ledgerId", "type": "string", "format": "uuid" }, "conflicting_methods": { "get": { "catalog_name": "ledgerId", "type": "string", "format": "uuid" }, "put": { "catalog_name": "ledgerCode", "type": "string", "format": null } } } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCategory" }, "character": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCharacter" }, "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "customerOption": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCustomerOption" }, "extendedProperties": { "x-aura-type": "unresolved" }, "hasNegativeBalance": { "type": "boolean", "x-aura-field-code": "hasNegativeBalance" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerId" }, "isManualEntry": { "type": "boolean", "x-aura-field-code": "isManualEntry" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "mainCategory": { "type": "integer", "format": "int32", "x-aura-field-code": "mainLedgerCategory" }, "name": { "type": "string", "x-aura-field-code": "ledgerName" }, "paddedLedgerCode": { "type": "integer", "format": "int64", "x-aura-field-code": "paddedLedgerCode" }, "passiveDate": { "type": "string", "format": "date-time", "x-aura-field-code": "ledgerPassiveDate" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerStatus" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerType" }, "validFrom": { "type": "string", "format": "date", "x-aura-field-code": "validFrom" }, "validTo": { "type": "string", "format": "date", "x-aura-field-code": "validTo" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-ledger-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledgers/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "LedgerDto", "payload": "LedgerDto", "collection": false, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerLevel", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PassiveDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MainCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Category", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Character", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsManualEntry", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CustomerOption", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasNegativeBalance", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaddedLedgerCode", "declared_type": "long", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_26", "status": 400, "message": { "ar": "لم يتم العثور على سجل بالدليل المعطى: '{0}'.", "en": "Ledger is not found with the given id : '{0}'.", "tr": "Belirtilen kimliğe sahip defter bulunamadı: '{0}'." }, "message_available": true, "constant_name": "LEDGER_NOT_FOUND_BY_ID" } ] } }, "put": { "operationId": "update-ledger", "tags": [ "ledgers" ], "summary": "update-ledger", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "ledgerCode" }, "x-aura-catalog-parameter-name": "ledgerCode", "description": "MERGED TEMPLATE — this parameter does not mean the same thing for every method on this path. `PUT` takes the catalog field `ledgerCode` (string), while `DELETE` takes `ledgerId` (string/uuid). The two catalog rows declared different templates; OpenAPI 3.1 §4.8.8 makes them one path, so the name was unified and the difference in meaning survives only here. Do NOT reuse a value across these methods.\n\nMERGED TEMPLATE — this parameter does not mean the same thing for every method on this path. `PUT` takes the catalog field `ledgerCode` (string), while `GET` takes `ledgerId` (string/uuid). The two catalog rows declared different templates; OpenAPI 3.1 §4.8.8 makes them one path, so the name was unified and the difference in meaning survives only here. Do NOT reuse a value across these methods.", "x-aura-merged-parameter-conflict": { "published_as": "id", "this_method_expects": { "catalog_name": "ledgerCode", "type": "string", "format": null }, "conflicting_methods": { "get": { "catalog_name": "ledgerId", "type": "string", "format": "uuid" }, "put": { "catalog_name": "ledgerCode", "type": "string", "format": null } } } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCategory" }, "character": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCharacter" }, "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "customerOption": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCustomerOption" }, "hasNegativeBalance": { "type": "boolean", "x-aura-field-code": "hasNegativeBalance" }, "isManualEntry": { "type": "boolean", "x-aura-field-code": "isManualEntry" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "mainCategory": { "type": "integer", "format": "int32", "x-aura-field-code": "mainLedgerCategory" }, "name": { "type": "string", "x-aura-field-code": "ledgerName" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerStatus" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerType" }, "validFrom": { "type": "string", "format": "date", "x-aura-field-code": "validFrom" }, "validTo": { "type": "string", "format": "date", "x-aura-field-code": "validTo" } }, "required": [ "ledgerLevel", "name", "type" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 15, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-ledger", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledgers/{ledgerCode}", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_21", "status": 400, "message": { "ar": "السجل '{0}' غير موجود", "en": "Ledger '{0}' is not found", "tr": "'{0}' defteri bulunamadı" }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NOT_NULL" }, { "code": "ERR_ACCTNG_29", "status": 400, "message": { "ar": "السجل يُستخدم في القيد المحاسبي. لا يمكن تحديثه كـ \"الرئيسي\".", "en": "Ledger is used in accounting entry. It cannot be updated as 'Main'.", "tr": "Muhasebe girişinde defter kullanılır. 'Ana' olarak güncellenemez." }, "message_available": true, "constant_name": "LEDGER_IS_USED_IN_ACCOUNTING_ENTRY_IT_CANNOT_BE_UPDATED" }, { "code": "ERR_ACCTNG_30", "status": 400, "message": { "ar": "دفتر الأستاذ الرئيسي {0} لديه دفاتر فرعية أدنى. لا يمكن تحديثه كـ 'فرعي'.", "en": "'Main' ledger {0} has lower ledgers. It cannot be updated as 'Sub'.", "tr": "'Ana' defter {0}'in alt defterleri var. 'Alt' olarak güncellenemez." }, "message_available": true, "constant_name": "MAIN_LEDGER_CANNOT_BE_UPDATED_SUB" } ] }, "x-aura-path-template-merged": { "catalog_template": "/ledgers/{ledgerCode}", "published_template": "/ledgers/{id}", "renamed": { "ledgerCode": "id" }, "reason": "OpenAPI 3.1 §4.8.8 — paths differing only in template variable names are identical and MUST NOT coexist. A path parameter name is local to the template and positional on the wire, so this rename does not change the request; the catalog names are preserved on each parameter and here." } } }, "/ledgers/{ledgerCode}/sub-ledgers": { "get": { "operationId": "get-lower-ledger-list-by-ledger-code", "tags": [ "ledgers" ], "summary": "get-lower-ledger-list-by-ledger-code", "parameters": [ { "name": "ledgerCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "ledgerCode" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "category": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCategory" }, "character": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCharacter" }, "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "customerOption": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCustomerOption" }, "extendedPropertyValues": { "type": "array", "items": { "type": "object", "properties": { "extendedPropertyName": { "type": "string", "x-aura-field-code": "extendedPropertyName" }, "extendedPropertyValue": { "type": "string", "x-aura-field-code": "extendedPropertyValue" } }, "x-aura-field-code": "extendedPropertyValues" } }, "hasNegativeBalance": { "type": "boolean", "x-aura-field-code": "hasNegativeBalance" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "ledgerId" }, "isManualEntry": { "type": "boolean", "x-aura-field-code": "isManualEntry" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "name": { "type": "string", "x-aura-field-code": "ledgerName" }, "paddedLedgerCode": { "type": "integer", "format": "int64", "x-aura-field-code": "paddedLedgerCode" }, "passiveDate": { "type": "string", "format": "date-time", "x-aura-field-code": "ledgerPassiveDate" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerStatus" }, "type": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerType" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-lower-ledger-list-by-ledger-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "ledgers/{ledgerCode}/sub-ledgers", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "LedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Filter", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderBy", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderSort", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "PageSize", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LedgerDto", "collection": true, "members": [ { "name": "LedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LedgerLevel", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PassiveDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "MainCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Category", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Character", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsManualEntry", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "CustomerOption", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "HasNegativeBalance", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ParentLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaddedLedgerCode", "declared_type": "long", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/localizations": { "get": { "operationId": "accounting-get-localization-list", "tags": [ "localizations" ], "summary": "accounting-get-localization-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "type": { "type": "string", "x-aura-field-code": "type" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-localization-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LocalizationDto", "collection": true, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "accounting-create-localization", "tags": [ "localizations" ], "summary": "accounting-create-localization", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "localizationCode" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } }, "type": { "type": "string", "x-aura-field-code": "localizationType" } }, "required": [ "code", "translations", "type" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-create-localization", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_1", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/by-code/{code}": { "get": { "operationId": "accounting-get-localization-id-by-code", "tags": [ "localizations" ], "summary": "accounting-get-localization-id-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "localizationCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "type": { "x-aura-type": "unresolved" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-localization-id-by-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations/by-code/{code}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "LocalizationDto", "payload": "LocalizationDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/{id}": { "delete": { "operationId": "accounting-delete-localization", "tags": [ "localizations" ], "summary": "accounting-delete-localization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-delete-localization", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "get": { "operationId": "accounting-get-localization-by-id", "tags": [ "localizations" ], "summary": "accounting-get-localization-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "type": { "x-aura-type": "unresolved" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-localization-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "LocalizationDto", "payload": "LocalizationDto", "collection": false, "members": [ { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "put": { "operationId": "accounting-update-localization", "tags": [ "localizations" ], "summary": "accounting-update-localization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } }, "type": { "type": "string", "x-aura-field-code": "localizationType" } }, "required": [ "translations", "type" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-update-localization", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/{id}/translations": { "get": { "operationId": "accounting-get-localization-translation-by-localization-id", "tags": [ "localizations" ], "summary": "accounting-get-localization-translation-by-localization-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "context": { "x-aura-type": "unresolved" }, "languageCode": { "x-aura-type": "unresolved" }, "translationId": { "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-localization-translation-by-localization-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations/{id}/translations", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "LocalizationTranslationDto", "collection": true, "members": [ { "name": "TranslationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "LanguageCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "post": { "operationId": "accounting-create-localization-translation", "tags": [ "localizations" ], "summary": "accounting-create-localization-translation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "translations": { "type": "object", "properties": { "context": { "x-aura-type": "unresolved" }, "languageCode": { "x-aura-type": "unresolved" } }, "required": [ "context", "languageCode" ], "x-aura-type": "unresolved" } }, "required": [ "translations" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-create-localization-translation", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations/{id}/translations", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_2", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/{id}/translations/{translationId}": { "delete": { "operationId": "accounting-delete-localization-translation", "tags": [ "localizations" ], "summary": "accounting-delete-localization-translation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "localizationId" } }, { "name": "translationId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-delete-localization-translation", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations/{id}/translations/{translationId}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LCLZ_4", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "put": { "operationId": "accounting-update-localization-translation", "tags": [ "localizations" ], "summary": "accounting-update-localization-translation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "translationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "translationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" } }, "required": [ "context" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-update-localization-translation", "x-aura-domain": "accounting", "x-aura-raw-url-path": "localizations/{id}/translations/{translationId}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null }, { "code": "ERR_LCLZ_4", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/parameters": { "get": { "operationId": "accounting-get-parameter-list", "tags": [ "parameters" ], "summary": "accounting-get-parameter-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "filter" } }, { "name": "orderBy", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderBy" } }, { "name": "orderSort", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "orderSort" } }, { "name": "pageIndex", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageIndex" } }, { "name": "pageSize", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "pageSize" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 5 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parameterFields": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ParameterFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } }, "post": { "operationId": "accounting-create-parameter", "tags": [ "parameters" ], "summary": "accounting-create-parameter", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "parameterCode" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "parameterName" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "required": [ "code", "translations" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. An exact, uniquely bound route registration classifies this response as a single-record.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-create-parameter", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration classifies this response as a single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_1", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_ALREADY_EXISTS" } ] } } }, "/parameters/by-code/{code}": { "get": { "operationId": "accounting-get-parameter-by-code", "tags": [ "parameters" ], "summary": "accounting-get-parameter-by-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parameterFields": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "x-aura-type": "unresolved" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-by-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/by-code/{code}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "ParameterDto", "payload": "ParameterDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ParameterFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_12", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_NOT_FOUND" } ] } } }, "/parameters/by-code/{code}/default-value": { "get": { "operationId": "accounting-get-parameter-default-value-by-parameter-code", "tags": [ "parameters" ], "summary": "accounting-get-parameter-default-value-by-parameter-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-default-value-by-parameter-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/by-code/{code}/default-value", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `string`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.", "declared_type": "string", "payload": "string" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_12", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_NOT_FOUND" }, { "code": "ERR_PRMTR_14", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_DEFAULT_VALUE_BY_CODE_NOT_EXISTS" } ] } } }, "/parameters/by-code/{code}/values": { "get": { "operationId": "accounting-get-parameter-value-list-by-parameter-code", "tags": [ "parameters" ], "summary": "accounting-get-parameter-value-list-by-parameter-code", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "code" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "context": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "paramKey": { "x-aura-type": "unresolved" }, "sortOrder": { "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "context": { "x-aura-type": "unresolved" }, "languageCode": { "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-value-list-by-parameter-code", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/by-code/{code}/values", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterValueDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParamKey", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_12", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_CODE_NOT_FOUND" } ] } } }, "/parameters/{id}": { "delete": { "operationId": "accounting-delete-parameter", "tags": [ "parameters" ], "summary": "accounting-delete-parameter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-delete-parameter", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "get": { "operationId": "accounting-get-parameter-by-id", "tags": [ "parameters" ], "summary": "accounting-get-parameter-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true }, "parameterFields": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "x-aura-type": "unresolved" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "ParameterDto", "payload": "ParameterDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ParameterFields", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "put": { "operationId": "accounting-update-parameter", "tags": [ "parameters" ], "summary": "accounting-update-parameter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "type": "string", "x-aura-field-code": "parameterName" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "required": [ "translations" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-update-parameter", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } } }, "/parameters/{id}/default-value": { "get": { "operationId": "accounting-get-parameter-default-value", "tags": [ "parameters" ], "summary": "accounting-get-parameter-default-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-default-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/default-value", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `string`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON string. This is a complete answer read from the declaration, not a gap.", "declared_type": "string", "payload": "string" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_13", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_DEFAULT_VALUE_BY_ID_NOT_EXISTS" }, { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } } }, "/parameters/{id}/field-values/{fieldValueId}": { "delete": { "operationId": "accounting-delete-parameter-field-value", "tags": [ "parameters" ], "summary": "accounting-delete-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "fieldValueId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-delete-parameter-field-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/field-values/{fieldValueId}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_10", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_FIELD_VALUE_NOT_EXISTS" }, { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "put": { "operationId": "accounting-update-parameter-field-value", "tags": [ "parameters" ], "summary": "accounting-update-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "fieldValueId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldValue": { "x-aura-type": "unresolved" }, "isActive": { "x-aura-type": "unresolved" } }, "required": [ "fieldValue", "isActive" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-update-parameter-field-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/field-values/{fieldValueId}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_10", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_FIELD_VALUE_NOT_EXISTS" }, { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } } }, "/parameters/{id}/fields": { "get": { "operationId": "accounting-get-parameter-field-list", "tags": [ "parameters" ], "summary": "accounting-get-parameter-field-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-field-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/fields", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterFieldDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "post": { "operationId": "accounting-create-parameter-field", "tags": [ "parameters" ], "summary": "accounting-create-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "isActive": { "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "required": [ "languageCode", "name" ], "x-aura-type": "unresolved" } }, "required": [ "code", "isActive", "translations" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 3, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-create-parameter-field", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/fields", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_3", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_FIELD_CODE_ALREADY_EXISTS" } ] } } }, "/parameters/{id}/fields/{fieldId}": { "delete": { "operationId": "accounting-delete-parameter-field", "tags": [ "parameters" ], "summary": "accounting-delete-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-delete-parameter-field", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/fields/{fieldId}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_5", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_FIELD_NOT_EXISTS" } ] } }, "put": { "operationId": "accounting-update-parameter-field", "tags": [ "parameters" ], "summary": "accounting-update-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isActive": { "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "languageCode": { "x-aura-type": "unresolved" }, "name": { "type": "string", "x-aura-field-code": "name", "x-aura-maskable": true } }, "required": [ "languageCode", "name" ], "x-aura-type": "unresolved" } }, "required": [ "isActive", "translations" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-update-parameter-field", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/fields/{fieldId}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_5", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_FIELD_NOT_EXISTS" } ] } } }, "/parameters/{id}/values": { "get": { "operationId": "accounting-get-parameter-value-list", "tags": [ "parameters" ], "summary": "accounting-get-parameter-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "context": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "isActive": { "x-aura-type": "unresolved" }, "paramKey": { "x-aura-type": "unresolved" }, "sortOrder": { "x-aura-type": "unresolved" }, "translations": { "type": "object", "properties": { "context": { "x-aura-type": "unresolved" }, "languageCode": { "x-aura-type": "unresolved" } }, "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-value-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/values", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterValueDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParamKey", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Context", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SortOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsActive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Translations", "declared_type": "IEnumerable", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "post": { "operationId": "accounting-create-parameter-value", "tags": [ "parameters" ], "summary": "accounting-create-parameter-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "paramKey": { "type": "integer", "format": "int32", "x-aura-field-code": "paramKey" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } } }, "required": [ "context", "paramKey", "translations" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 5, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-create-parameter-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/values", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_7", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_VALUE_WITH_KEY_ALREADY_EXISTS" } ] } } }, "/parameters/{id}/values/{valueId}": { "delete": { "operationId": "accounting-delete-parameter-value", "tags": [ "parameters" ], "summary": "accounting-delete-parameter-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-delete-parameter-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/values/{valueId}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_4", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_VALUE_NOT_EXISTS" } ] } }, "put": { "operationId": "accounting-update-parameter-value", "tags": [ "parameters" ], "summary": "accounting-update-parameter-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "sortOrder": { "type": "number", "x-aura-field-code": "sortOrder" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string", "x-aura-field-code": "context" }, "languageCode": { "type": "string", "x-aura-field-code": "languageCode" } }, "required": [ "context", "languageCode" ], "x-aura-field-code": "translations" } } }, "required": [ "context", "translations" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 4, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-update-parameter-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/values/{valueId}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_4", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_VALUE_NOT_EXISTS" } ] } } }, "/parameters/{id}/values/{valueId}/field-values": { "get": { "operationId": "accounting-get-parameter-field-value-list", "tags": [ "parameters" ], "summary": "accounting-get-parameter-field-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "id" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "name": "includeInactive", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "includeInactive" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 1 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. Returns a collection of records. Of 135 operations in this state that were probed (measured against a reference deployment on parameterless GET routes only), 118 answered and 118 returned a bare JSON array.", "content": { "application/json": { "schema": { "type": "array", "description": "Array of catalog-declared response records.", "items": { "type": "object", "properties": { "fieldValue": { "x-aura-type": "unresolved" }, "isActive": { "x-aura-type": "unresolved" }, "parameterFieldId": { "x-aura-type": "unresolved" }, "parameterFieldValueId": { "x-aura-type": "unresolved" }, "parameterValueId": { "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-get-parameter-field-value-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/values/{valueId}/field-values", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ParameterFieldValueDto", "collection": true, "members": [ { "name": "ParameterFieldValueId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParameterValueId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ParameterFieldId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FieldValue", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "post": { "operationId": "accounting-create-parameter-field-value", "tags": [ "parameters" ], "summary": "accounting-create-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterId" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldValues": { "type": "object", "properties": { "fieldValue": { "x-aura-type": "unresolved" }, "isActive": { "x-aura-type": "unresolved" }, "parameterFieldId": { "x-aura-type": "unresolved" } }, "required": [ "fieldValue", "isActive", "parameterFieldId" ], "x-aura-type": "unresolved" } }, "required": [ "fieldValues" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 1, "claim": 0, "form": 0, "header": 0, "path": 2, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "accounting-create-parameter-field-value", "x-aura-domain": "accounting", "x-aura-raw-url-path": "parameters/{id}/values/{valueId}/field-values", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" }, { "code": "ERR_PRMTR_4", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_VALUE_NOT_EXISTS" } ] } } }, "/position-accounts": { "post": { "operationId": "create-position-account", "tags": [ "position-accounts" ], "summary": "create-position-account", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "currency_group", "values": [ { "value": 1, "name": "FX" }, { "value": 2, "name": "PM" } ] } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "currency_type", "values": [ { "value": 1, "name": "local" }, { "value": 2, "name": "foreign" }, { "value": 3, "name": "all" } ] } }, "foreignPositionLedgerCode": { "type": "string", "x-aura-field-code": "foreignPositionLedgerCode" }, "gainAccountLedgerCode": { "type": "string", "x-aura-field-code": "gainAccountLedgerCode" }, "localPositionLedgerCode": { "type": "string", "x-aura-field-code": "localPositionLedgerCode" }, "lossAccountLedgerCode": { "type": "string", "x-aura-field-code": "lossAccountLedgerCode" } }, "required": [ "currencyGroup", "currencyNumber", "currencyType", "foreignPositionLedgerCode", "gainAccountLedgerCode", "localPositionLedgerCode", "lossAccountLedgerCode" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-position-account", "x-aura-domain": "accounting", "x-aura-raw-url-path": "position-accounts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CurrencyType", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ForeignPositionLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LocalPositionLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "GainAccountLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LossAccountLedgerCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "AuraCommandDto", "payload": "AuraCommandDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_117", "status": 400, "message": { "ar": "لا يمكن استخدام دفاتر الحسابات من نوع \"الرئيسي\" في قيود المحاسبة.", "en": "'Main' type ledgers cannot be used in accounting entries.", "tr": "Muhasebe girişlerinde 'Ana' tipi defterler kullanılamaz." }, "message_available": true, "constant_name": "LEDGER_TYPE_CANNOT_BE_MAIN" }, { "code": "ERR_ACCTNG_203", "status": 400, "message": { "ar": "الآن يُسمح بامتلاك أكثر من حساب مركز واحد بنفس دفتر مركز الموقع المحلي:'{0}'.", "en": "It is now allowed to have one than one position accounts with the same local Position Ledger:'{0}'.", "tr": "Artık aynı yerel Pozisyon Defteri:'{0}' ile birden fazla pozisyon hesabına sahip olunmasına izin veriliyor.\n" }, "message_available": true, "constant_name": "LOCAL_CURRENCY_POSITION_LEDGER_CODE_MUST_BE_UNIQUE" }, { "code": "ERR_ACCTNG_205", "status": 400, "message": { "ar": "لا يُسمح بإنشاء أكثر من حساب مركز واحد بنفس قيم 'معرّف العملة' و'نوع العملة' و'مجموعة العملة'.", "en": "It is not allowed to create more than one position account with the same 'currencyId', 'currencyType' and 'currencyGroup'.", "tr": "Aynı 'currencyId', 'currencyType' ve 'currencyGroup' değerlerine sahip birden fazla pozisyon hesabı oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "POSITION_CURRENCY_MUST_BE_UNIQUE" }, { "code": "ERR_ACCTNG_208", "status": 400, "message": { "ar": "مسموح الآن أن يكون لديك أكثر من حساب واحد للموقف مع نفس سجل الموقف الأجنبي: '{0}'.", "en": "It is now allowed to have one than one position accounts with the same foreign Position Ledger:'{0}'.", "tr": "Artık aynı yabancı Pozisyon Defteri:'{0}' ile birden fazla pozisyon hesabına sahip olunmasına izin veriliyor.\n" }, "message_available": true, "constant_name": "FOREIGN_CURRENCY_POSITION_LEDGER_CODE_MUST_BE_UNIQUE" }, { "code": "ERR_ACCTNG_21", "status": 400, "message": { "ar": "السجل '{0}' غير موجود", "en": "Ledger '{0}' is not found", "tr": "'{0}' defteri bulunamadı" }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NOT_NULL" }, { "code": "ERR_ACCTNG_239", "status": 400, "message": { "en": "Currency is not found." }, "message_available": true, "constant_name": "CURRENCY_NUMBER_IS_NOT_VALID" } ] } } }, "/position-accounts/by-currency-id/{currencyId}": { "get": { "operationId": "get-position-account-by-currency-id", "tags": [ "position-accounts" ], "summary": "get-position-account-by-currency-id", "parameters": [ { "name": "currencyId", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The schema is an `anyOf` over three envelopes: the record, a bare array of it, and a page `{total, data[]}` carrying the same record.", "content": { "application/json": { "schema": { "description": "Response whose record fields are declared but whose outer cardinality is not established by the catalog.", "anyOf": [ { "type": "object", "properties": { "currencyGroup": { "x-aura-type": "unresolved" }, "currencyId": { "x-aura-type": "unresolved" }, "currencyType": { "x-aura-type": "unresolved" }, "foreignPositionLedgerCode": { "x-aura-type": "unresolved" }, "gainAccountLedgerCode": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "localPositionLedgerCode": { "x-aura-type": "unresolved" }, "lossAccountLedgerCode": { "x-aura-type": "unresolved" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "currencyGroup": { "x-aura-type": "unresolved" }, "currencyId": { "x-aura-type": "unresolved" }, "currencyType": { "x-aura-type": "unresolved" }, "foreignPositionLedgerCode": { "x-aura-type": "unresolved" }, "gainAccountLedgerCode": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "localPositionLedgerCode": { "x-aura-type": "unresolved" }, "lossAccountLedgerCode": { "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "type": "object", "description": "Paged response envelope observed on the BFF response path.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "properties": { "data": { "type": "array", "description": "Response records carried by this page.", "items": { "type": "object", "properties": { "currencyGroup": { "x-aura-type": "unresolved" }, "currencyId": { "x-aura-type": "unresolved" }, "currencyType": { "x-aura-type": "unresolved" }, "foreignPositionLedgerCode": { "x-aura-type": "unresolved" }, "gainAccountLedgerCode": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "localPositionLedgerCode": { "x-aura-type": "unresolved" }, "lossAccountLedgerCode": { "x-aura-type": "unresolved" } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "total": { "type": "integer", "format": "int64", "description": "Total matching records, ignoring paging.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } }, "required": [ "data" ] } ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-position-account-by-currency-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "position-accounts/by-currency-id/{currencyId}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/position-accounts/by-currency-number/{currencyNumber}": { "get": { "operationId": "get-position-account-by-currency-number", "tags": [ "position-accounts" ], "summary": "get-position-account-by-currency-number", "parameters": [ { "name": "currencyNumber", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "currencyNumber" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType" }, "foreignPositionLedgerCode": { "type": "string", "x-aura-field-code": "foreignPositionLedgerCode" }, "gainAccountLedgerCode": { "type": "string", "x-aura-field-code": "gainAccountLedgerCode" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "id" }, "localPositionLedgerCode": { "type": "string", "x-aura-field-code": "localPositionLedgerCode" }, "lossAccountLedgerCode": { "type": "string", "x-aura-field-code": "lossAccountLedgerCode" } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-position-account-by-currency-number", "x-aura-domain": "accounting", "x-aura-raw-url-path": "position-accounts/by-currency-number/{currencyNumber}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PositionAccountDto", "payload": "PositionAccountDto", "collection": false, "members": [ { "name": "CurrencyType", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ForeignPositionLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocalPositionLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GainAccountLedgerCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LossAccountLedgerCode", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_207", "status": 400, "message": { "ar": "لا يتم العثور على حساب الموقع باستخدام معرف العملة المعطى: '{0}'.", "en": "Position account is not found with the given currency Id: '{0}'.", "tr": "Belirtilen para birimi kimliğine sahip pozisyon hesabı bulunamadı: '{0}'." }, "message_available": true, "constant_name": "POSITION_ACCOUNT_BY_CURRENCY_ID_MUST_CONTAINS_A_SINGLE_VALUE" } ] } } }, "/position-accounts/fx-revaluations": { "post": { "operationId": "fx-position-revaluation", "tags": [ "position-accounts" ], "summary": "fx-position-revaluation", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "exchangeRateType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeRateType" }, "exchangeSpreadType": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" } }, "required": [ "exchangeRateType", "exchangeSpreadType" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "fx-position-revaluation", "x-aura-domain": "accounting", "x-aura-raw-url-path": "position-accounts/fx-revaluations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ExchangeSpreadType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExchangeRateType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" } } }, "/position-accounts/{id}": { "delete": { "operationId": "delete-position-account", "tags": [ "position-accounts" ], "summary": "delete-position-account", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "positionAccountId" } } ], "x-aura-request-binding": { "method": "DELETE", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "delete-position-account", "x-aura-domain": "accounting", "x-aura-raw-url-path": "position-accounts/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_244", "status": 400, "message": null, "message_available": false, "constant_name": "POSITION_ACCOUNT_NOT_FOUND" } ] } }, "put": { "operationId": "update-position-account", "tags": [ "position-accounts" ], "summary": "update-position-account", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "positionAccountId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyGroup": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyGroup", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "currency_group", "values": [ { "value": 1, "name": "FX" }, { "value": 2, "name": "PM" } ] } }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "currencyType": { "type": "integer", "format": "int32", "x-aura-field-code": "currencyType", "x-aura-parameter-enumeration": { "state": "resolved", "parameter": "currency_type", "values": [ { "value": 1, "name": "local" }, { "value": 2, "name": "foreign" }, { "value": 3, "name": "all" } ] } }, "foreignPositionLedgerCode": { "type": "string", "x-aura-field-code": "foreignPositionLedgerCode" }, "gainAccountLedgerCode": { "type": "string", "x-aura-field-code": "gainAccountLedgerCode" }, "localPositionLedgerCode": { "type": "string", "x-aura-field-code": "localPositionLedgerCode" }, "lossAccountLedgerCode": { "type": "string", "x-aura-field-code": "lossAccountLedgerCode" } }, "required": [ "currencyGroup", "currencyNumber", "currencyType", "foreignPositionLedgerCode", "gainAccountLedgerCode", "localPositionLedgerCode", "lossAccountLedgerCode" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 7, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-position-account", "x-aura-domain": "accounting", "x-aura-raw-url-path": "position-accounts/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyType", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyGroup", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ForeignPositionLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LocalPositionLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "GainAccountLedgerCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LossAccountLedgerCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_117", "status": 400, "message": { "ar": "لا يمكن استخدام دفاتر الحسابات من نوع \"الرئيسي\" في قيود المحاسبة.", "en": "'Main' type ledgers cannot be used in accounting entries.", "tr": "Muhasebe girişlerinde 'Ana' tipi defterler kullanılamaz." }, "message_available": true, "constant_name": "LEDGER_TYPE_CANNOT_BE_MAIN" }, { "code": "ERR_ACCTNG_203", "status": 400, "message": { "ar": "الآن يُسمح بامتلاك أكثر من حساب مركز واحد بنفس دفتر مركز الموقع المحلي:'{0}'.", "en": "It is now allowed to have one than one position accounts with the same local Position Ledger:'{0}'.", "tr": "Artık aynı yerel Pozisyon Defteri:'{0}' ile birden fazla pozisyon hesabına sahip olunmasına izin veriliyor.\n" }, "message_available": true, "constant_name": "LOCAL_CURRENCY_POSITION_LEDGER_CODE_MUST_BE_UNIQUE" }, { "code": "ERR_ACCTNG_205", "status": 400, "message": { "ar": "لا يُسمح بإنشاء أكثر من حساب مركز واحد بنفس قيم 'معرّف العملة' و'نوع العملة' و'مجموعة العملة'.", "en": "It is not allowed to create more than one position account with the same 'currencyId', 'currencyType' and 'currencyGroup'.", "tr": "Aynı 'currencyId', 'currencyType' ve 'currencyGroup' değerlerine sahip birden fazla pozisyon hesabı oluşturulmasına izin verilmez." }, "message_available": true, "constant_name": "POSITION_CURRENCY_MUST_BE_UNIQUE" }, { "code": "ERR_ACCTNG_206", "status": 400, "message": { "ar": "لم يتم العثور على حساب الموضع بالمعرف المقدم: '{0}'.", "en": "Position account is not found with given Id: '{0}'.", "tr": "Belirtilen kimliğe sahip pozisyon hesabı bulunamadı: '{0}'." }, "message_available": true, "constant_name": "POSITION_ACCOUNT_MUST_EXITS" }, { "code": "ERR_ACCTNG_208", "status": 400, "message": { "ar": "مسموح الآن أن يكون لديك أكثر من حساب واحد للموقف مع نفس سجل الموقف الأجنبي: '{0}'.", "en": "It is now allowed to have one than one position accounts with the same foreign Position Ledger:'{0}'.", "tr": "Artık aynı yabancı Pozisyon Defteri:'{0}' ile birden fazla pozisyon hesabına sahip olunmasına izin veriliyor.\n" }, "message_available": true, "constant_name": "FOREIGN_CURRENCY_POSITION_LEDGER_CODE_MUST_BE_UNIQUE" }, { "code": "ERR_ACCTNG_21", "status": 400, "message": { "ar": "السجل '{0}' غير موجود", "en": "Ledger '{0}' is not found", "tr": "'{0}' defteri bulunamadı" }, "message_available": true, "constant_name": "LEDGER_MUST_BE_NOT_NULL" } ] } } }, "/previous-entries": { "put": { "operationId": "update-previous-entry", "tags": [ "previous-entries" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Update previous accounting entry status", "description": "Invokes the `update-previous-entry` service definition through `PUT /previous-entries`.\n\nTurkish display name: Geriye dönük fiş işlemleri statü güncelle", "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT. The response type this route registers was read from the service's own source and is published on this operation as `x-aura-code-response`.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-previous-entry", "x-aura-domain": "accounting", "x-aura-raw-url-path": "previous-entries", "x-aura-request-contract": { "state": "no-members" }, "x-aura-code-response": { "state": "empty-body", "note": "The registration passes ONE generic argument, which is the request type. There is no second argument because there is no response type to name: the constraint on that overload is `ICommand`/`IQuery`, both of which extend `IRequest`, so the framework binds the result to `Unit` and `InvokeRequestAsync` returns before writing anything to the body.", "declared_type": "Unit", "body": "empty", "success_status": 200, "derivation": "arity-1 registration; ICommand/IQuery : IRequest, and the framework returns before writing a body", "payload": "Unit" }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_247", "status": 400, "message": null, "message_available": false, "constant_name": "PREVIOUS_ENTRY_CAN_BE_PROCESSED_AFTER_DAILY_CREATED" } ] } } }, "/template-definitions": { "get": { "operationId": "get-template-definition-list", "tags": [ "template-definitions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Get Template Definition List", "description": "Invokes the `get-template-definition-list` service definition through `GET /template-definitions`.", "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-template-definition-list", "x-aura-domain": "accounting", "x-aura-raw-url-path": "template-definitions", "x-aura-capabilities": { "filtering": true, "ordering": true, "paging": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "create-template-definition", "tags": [ "template-definitions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "create-template-definition", "description": "Invokes the `create-template-definition` service definition through `POST /template-definitions`.", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "statementTemplateDescription" }, "name": { "type": "string", "x-aura-field-code": "statementTemplateName" } }, "required": [ "description", "name" ] } } } }, "x-aura-request-binding": { "method": "POST", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "create-template-definition", "x-aura-domain": "accounting", "x-aura-raw-url-path": "template-definitions", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/template-definitions/{id}": { "get": { "operationId": "get-template-definition-by-id", "tags": [ "template-definitions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Get Template Definition By Id", "description": "Invokes the `get-template-definition-by-id` service definition through `GET /template-definitions/{id}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-template-definition-by-id", "x-aura-domain": "accounting", "x-aura-raw-url-path": "template-definitions/{id}", "x-aura-capabilities": { "filtering": true, "ordering": true, "note": "Platform-provided behaviours declared on the catalog entry. The catalog does not record the parameter names the platform uses for them, so they are not rendered as parameters here." }, "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "update-template-definition", "tags": [ "template-definitions" ], "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" }, "summary": "Update Template Definition", "description": "Invokes the `update-template-definition` service definition through `PUT /template-definitions/{id}`.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "financialStatementTemplateId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "x-aura-field-code": "statementTemplateDescription" }, "name": { "type": "string", "x-aura-field-code": "statementTemplateName" } }, "required": [ "description", "name" ] } } } }, "x-aura-request-binding": { "method": "PUT", "admits": [ "route", "header", "claim", "body", "form" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 2, "claim": 0, "form": 0, "header": 0, "path": 1, "query": 0 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares no response fields for this operation. The body is UNKNOWN CONTENT.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "update-template-definition", "x-aura-domain": "accounting", "x-aura-raw-url-path": "template-definitions/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/trial-balance": { "get": { "operationId": "get-trial-balance", "tags": [ "trial-balance" ], "summary": "get-trial-balance", "parameters": [ { "name": "beginDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "balanceBeginDate" } }, { "name": "currencyNumber", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "currencyNumber" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "balanceEndDate" } }, { "name": "exchangeRateType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeRateType" } }, { "name": "exchangeSpreadType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "exchangeSpreadType" } }, { "name": "excludeYearEndClosingEntry", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "excludeYearEndClosingEntry" } }, { "name": "isEvaluationDateToday", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "isEvaluationDateToday" } }, { "name": "ledgerCodeBegin", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "ledgerCodeBegin" } }, { "name": "ledgerCodeEnd", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "ledgerCodeEnd" } }, { "name": "ledgerLevel", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" } }, { "name": "organizationCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "organizationCode" } }, { "name": "showZeroBalance", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "showZeroBalance" } }, { "name": "withAccountNumber", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "withAccountNumber" } }, { "name": "withGLCode", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "withGLCode" } }, { "name": "withOrganizationCode", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "withOrganizationCode" } } ], "x-aura-request-binding": { "method": "GET", "admits": [ "route", "query", "header", "claim" ], "binder_filters_by_binding_source": true, "declared_root_fields_by_binding_source": { "body": 0, "claim": 0, "form": 0, "header": 0, "path": 0, "query": 15 }, "dropped_binding_sources": [], "dropped_field_names": {}, "dropped_mandatory_field_names": [], "verdict": "all-declared-sources-admitted", "basis": "Read from the platform's service-invocation layer, which selects binding sources by the contract row's usage type and operation type and then keeps only fields bound to one of them.", "http_edge_note": null }, "responses": { "200": { "description": "Success. The catalog declares this returns a single record. Of 25 operations in this state with a probeable route, 8 answered and 6 returned a single record — the other two returned a collection and a bare boolean.", "content": { "application/json": { "schema": { "type": "object", "properties": { "beginDate": { "type": "string", "format": "date", "x-aura-field-code": "balanceBeginDate" }, "endDate": { "type": "string", "format": "date", "x-aura-field-code": "balanceEndDate" }, "trialBalances": { "type": "array", "items": { "type": "object", "properties": { "balances": { "type": "array", "items": { "type": "object", "properties": { "creditBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "creditBalance" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "debitBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "debitBalance" }, "glCodes": { "type": "array", "items": { "type": "object", "properties": { "accounts": { "type": "array", "items": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "creditBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "creditBalance" }, "debitBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "debitBalance" }, "totalCredit": { "type": "number", "format": "decimal", "x-aura-field-code": "totalCredit" }, "totalDebit": { "type": "number", "format": "decimal", "x-aura-field-code": "totalDebit" } }, "x-aura-field-code": "accounts" } }, "code": { "type": "string", "x-aura-field-code": "code" }, "creditBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "creditBalance" }, "currencyNumber": { "type": "string", "x-aura-field-code": "currencyNumber" }, "debitBalance": { "type": "number", "format": "decimal", "x-aura-field-code": "debitBalance" }, "totalCredit": { "type": "number", "format": "decimal", "x-aura-field-code": "totalCredit" }, "totalDebit": { "type": "number", "format": "decimal", "x-aura-field-code": "totalDebit" } }, "x-aura-field-code": "glCodeBalances" } }, "totalCredit": { "type": "number", "format": "decimal", "x-aura-field-code": "totalCredit" }, "totalDebit": { "type": "number", "format": "decimal", "x-aura-field-code": "totalDebit" } }, "x-aura-field-code": "balances" } }, "ledgerCharacter": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerCharacter" }, "ledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" }, "ledgerLevel": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerLevel" }, "ledgerName": { "type": "string", "x-aura-field-code": "ledgerName" }, "ledgerType": { "type": "integer", "format": "int32", "x-aura-field-code": "ledgerType" }, "parentledgerCode": { "type": "string", "x-aura-field-code": "ledgerCode" } }, "x-aura-field-code": "trialBalance" } } } } } }, "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, "400": { "$ref": "#/components/responses/Error400", "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one." }, "408": { "$ref": "#/components/responses/Error408", "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`." }, "409": { "$ref": "#/components/responses/Error409", "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`." }, "500": { "$ref": "#/components/responses/Error500", "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`." }, "502": { "$ref": "#/components/responses/Error502", "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`." }, "default": { "description": "Error.\n\n**Platform error envelope:** The platform error envelope. The status is chosen by the KIND of failure, not by the error code, so one code can arrive with different statuses and one status covers many codes. Where this operation is known to raise specific codes they are listed under `x-aura-error-codes`; that list is what was found by reading its handler and validators, not a closed set.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } }, "x-aura-service-code": "get-trial-balance", "x-aura-domain": "accounting", "x-aura-raw-url-path": "trial-balance", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BeginDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerLevel", "declared_type": null, "nullable": true, "collection": false }, { "name": "LedgerCodeBegin", "declared_type": null, "nullable": false, "collection": false }, { "name": "LedgerCodeEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "WithGLCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "WithAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrganizationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShowZeroBalance", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsEvaluationDateToday", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExchangeSpreadType", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExchangeRateType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "TrialBalanceDto", "payload": "TrialBalanceDto", "collection": false, "members": [ { "name": "BeginDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "EndDate", "declared_type": "DateOnly", "nullable": false, "collection": false }, { "name": "TrialBalances", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." }, "x-aura-error-codes": { "note": "Error codes this operation is known to raise, read from the handler and its validators. `message_available` says whether the error catalog carries text for a code at this ref — many are raised by code that has no seeded definition here, and for those the code itself is all the platform publishes. This is what was FOUND, not a closed list: an operation may raise a code through a path this scan does not follow.", "codes": [ { "code": "ERR_ACCTNG_175", "status": 400, "message": { "ar": "يجب أن يكون تاريخ الانتهاء أكبر من تاريخ البداية.", "en": "'endDate' must be bigger than 'beginDate'.", "tr": "'endDate' 'beginDate' den büyük olmalı." }, "message_available": true, "constant_name": "END_DATE_MUST_BE_BIGGER_BEGIN_DATE" }, { "code": "ERR_ACCTNG_190", "status": 400, "message": { "ar": "غير مسموح بالاستعلام عن رصيد مؤجل لمزيد من التاريخ.", "en": "It is not allowed to query a future dated balance.", "tr": "İleri tarihli bakiye sorgulamaya izin verilmez." }, "message_available": true, "constant_name": "DATE_CANNOT_BE_GREATER_THAN_TODAY" }, { "code": "ERR_ACCTNG_204", "status": 400, "message": { "ar": "لم يتم العثور على سعر الصرف لـ '{0}'.", "en": "Exchange rate is not found for '{0}'.", "tr": "'{0}' için döviz kuru bulunamadı.\n" }, "message_available": true, "constant_name": "EXCHANGE_RATE_CURRENCY_NOT_FOUND" }, { "code": "ERR_ACCTNG_22", "status": 400, "message": { "ar": "يجب أن يكون 'ledgerCodeEnd' أكبر من 'ledgerCodeBegin'.", "en": "'ledgerCodeEnd' must be bigger than 'ledgerCodeBegin'.", "tr": "'ledgerCodeEnd', 'ledgerCodeBegin'den büyük olmalıdır." }, "message_available": true, "constant_name": "END_LERGER_MUST_BE_BIGGER_BEGIN_LEDGER" } ] } } } }, "x-aura-collapsed-targets": { "note": "These operations are served by this domain but are documented under the forwarder that fronts them, because a forwarder and its target are one logical API and only the caller-facing path is an address. They are listed here so an endpoint of this service is findable from this service's document.", "count": 14 }, "components": { "schemas": { "PlatformError": { "type": "object", "title": "PlatformError", "description": "The body a mapped failure returns. One `error` object; `error.code` is the only place the code appears. Not every failure carries it — see the individual statuses.", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message" ], "properties": { "code": { "type": "string", "description": "The platform error code. It is the identifier on the wire; a human-readable message for it is NOT guaranteed. The error catalog carries the codes seeded for this snapshot, with whichever of the published languages each one has text for, and many codes raised by services have no seeded entry at all. Where this portal knows which operations raise a code, they list it under `x-aura-error-codes`, each entry saying whether a message exists for it." }, "message": { "type": "string", "description": "The resolved message for the code, in the language the request asked for." }, "validationErrors": { "type": "array", "description": "Present on a validation failure only: one entry per rule that failed, each carrying its own code.", "items": { "type": "object", "additionalProperties": true } }, "businessErrors": { "type": "array", "description": "Present on a bulk failure only: one code/message pair per failed item.", "items": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } } } } } } } } }, "responses": { "Error400": { "description": "Raised by: AuraValidationException, BatchException, BulkBusinessException, BusinessException, ChannelException, ChannelNotFoundException, JsonException, PartnerCodeNotFoundException, PartnerCodeNullException, PartnerException. Fixed codes for this status: ERR_AURA_30, ERR_AURA_31, ERR_AURA_32, ERR_AURA_39, ERR_AURA_4, ERR_AURA_5, VALIDATION_ERROR. Usually carries the error envelope, but 1 of the 10 failure classes mapped to this status do not — a client that always parses `error.code` must tolerate a body without one.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error408": { "description": "Raised by: AuraTimeoutException. Fixed code for this status: ERR_AURA_33. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error409": { "description": "Raised by: DbUpdateConcurrencyException, IdempotencyException. Fixed codes for this status: ERR_AURA_1, ERR_AURA_3. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error500": { "description": "Raised by: AuraException. Fixed code for this status: ERROR. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } }, "Error502": { "description": "Raised by: AuraResponseTooLargeException. Fixed code for this status: ERR_AURA_41. Carries the error envelope; read `error.code`.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PlatformError" } } } } } } }