{ "openapi": "3.1.0", "info": { "title": "Foreign Trade", "version": "8fc585f1046d", "summary": "DgCore platform API surface for the Foreign Trade domain.", "description": "The Foreign Trade domain: 278 operations across 41 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}/foreign-trade-service", "description": "The full route is `https:///foreign-trade-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-histories", "description": "Operations addressed under `/accounting-histories` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "caches", "description": "Operations addressed under `/caches` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "cash-declaration-account-activities", "description": "Operations addressed under `/cash-declaration-account-activities` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "cash-declarations", "description": "Operations addressed under `/cash-declarations` — 5 operations.", "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": "custom-declarations", "description": "Operations addressed under `/custom-declarations` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-binders", "description": "Operations addressed under `/export-binders` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-document-customs", "description": "Operations addressed under `/export-document-customs` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-documents", "description": "Operations addressed under `/export-documents` — 13 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-lc-delivery-documents", "description": "Operations addressed under `/export-lc-delivery-documents` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-lc-document-goods-details", "description": "Operations addressed under `/export-lc-document-goods-details` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-lc-documents", "description": "Operations addressed under `/export-lc-documents` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-letter-credits", "description": "Operations addressed under `/export-letter-credits` — 8 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-payment-acceptance-usings", "description": "Operations addressed under `/export-payment-acceptance-usings` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-payment-acceptances", "description": "Operations addressed under `/export-payment-acceptances` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-payments", "description": "Operations addressed under `/export-payments` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "export-reports", "description": "Operations addressed under `/export-reports` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-binders", "description": "Operations addressed under `/import-binders` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-documents", "description": "Operations addressed under `/import-documents` — 17 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-lc-delivery-documents", "description": "Operations addressed under `/import-lc-delivery-documents` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-lc-document-goods-details", "description": "Operations addressed under `/import-lc-document-goods-details` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-lc-documents", "description": "Operations addressed under `/import-lc-documents` — 12 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-letter-credits", "description": "Operations addressed under `/import-letter-credits` — 10 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "import-transfers", "description": "Operations addressed under `/import-transfers` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "incoming-letter-of-guarantees", "description": "Operations addressed under `/incoming-letter-of-guarantees` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "kernel", "description": "Operations addressed under `/kernel` — 2 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": "mock-endpoint", "description": "Operations addressed under `/mock-endpoint` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "outgoing-letter-of-guarantees", "description": "Operations addressed under `/outgoing-letter-of-guarantees` — 1 operation.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "parameters", "description": "Operations addressed under `/parameters` — 19 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "pre-documents", "description": "Operations addressed under `/pre-documents` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "product-infos", "description": "Operations addressed under `/product-infos` — 6 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "reference-numbers", "description": "Operations addressed under `/reference-numbers` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "swift-bic-banks", "description": "Operations addressed under `/swift-bic-banks` — 11 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "swift-incomings", "description": "Operations addressed under `/swift-incomings` — 7 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "swift-mts", "description": "Operations addressed under `/swift-mts` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "swift-mx-schemas", "description": "Operations addressed under `/swift-mx-schemas` — 2 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "swift-others", "description": "Operations addressed under `/swift-others` — 5 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "swift-outgoings", "description": "Operations addressed under `/swift-outgoings` — 3 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "swift-transfers", "description": "Operations addressed under `/swift-transfers` — 36 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } }, { "name": "term-details", "description": "Operations addressed under `/term-details` — 12 operations.", "x-aura-documentation": { "language": "en", "status": "structural-fallback", "source": "catalog-structure" } } ], "paths": { "/accounting-histories": { "get": { "operationId": "get-all-accounting-histories", "tags": [ "accounting-histories" ], "summary": "get-all-accounting-histories", "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-all-accounting-histories", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "accounting-histories", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "post": { "operationId": "create-accounting-histories", "tags": [ "accounting-histories" ], "summary": "create-accounting-histories", "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.", "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-histories", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "accounting-histories", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/accounting-histories/{id}": { "delete": { "operationId": "delete-accounting-histories", "tags": [ "accounting-histories" ], "summary": "delete-accounting-histories", "parameters": [ { "name": "id", "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": "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.", "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-histories", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "accounting-histories/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "get-by-id-accounting-histories", "tags": [ "accounting-histories" ], "summary": "get-by-id-accounting-histories", "parameters": [ { "name": "id", "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": "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-by-id-accounting-histories", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "accounting-histories/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "update-accounting-histories", "tags": [ "accounting-histories" ], "summary": "update-accounting-histories", "parameters": [ { "name": "id", "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.", "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-histories", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "accounting-histories/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/caches/keys": { "get": { "operationId": "foreign-trade-get-cache-key-list", "tags": [ "caches" ], "summary": "foreign-trade-get-cache-key-list", "parameters": [ { "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": 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. 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": "foreign-trade-get-cache-key-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "caches/keys", "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": "CacheKeyDto", "collection": true, "members": [ { "name": "Key", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsSharedBetweenApplications", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsSharedBetweenTenants", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Mode", "declared_type": "CacheMode", "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 } } }, "/caches/refresh": { "post": { "operationId": "foreign-trade-refresh-cache", "tags": [ "caches" ], "summary": "foreign-trade-refresh-cache", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "isSharedBetweenApplications": { "type": "boolean", "x-aura-field-code": "isSharedBetweenApplications" }, "isSharedBetweenTenants": { "type": "boolean", "x-aura-field-code": "isSharedBetweenTenants" }, "key": { "x-aura-type": "unresolved" }, "mode": { "x-aura-type": "unresolved" } }, "required": [ "isSharedBetweenApplications", "isSharedBetweenTenants", "key", "mode" ] } } } }, "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. 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": "foreign-trade-refresh-cache", "x-aura-domain": "foreign-trade", "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" } ] } } }, "/cash-declaration-account-activities": { "get": { "operationId": "get-cash-declaration-account-activity-list", "tags": [ "cash-declaration-account-activities" ], "summary": "get-cash-declaration-account-activity-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-cash-declaration-account-activity-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declaration-account-activities", "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": "CashDeclarationAccountActivityDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargedPerson", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DepositedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DepositedCurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashDeclarationId", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-cash-declaration-account-activity", "tags": [ "cash-declaration-account-activities" ], "summary": "create-cash-declaration-account-activity", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "cashDeclarationId": { "type": "string", "format": "uuid", "x-aura-field-code": "cashDeclarationId" }, "chargedPerson": { "type": "string", "x-aura-field-code": "chargedPerson" }, "depositedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "depositedAmount" }, "depositedCurrencyCode": { "type": "string", "x-aura-field-code": "depositedCurrencyCode" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "required": [ "cashDeclarationId", "chargedPerson", "depositedAmount", "depositedCurrencyCode", "reference" ] } } } }, "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. 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-cash-declaration-account-activity", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declaration-account-activities", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CashDeclarationId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargedPerson", "declared_type": null, "nullable": false, "collection": false }, { "name": "DepositedAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DepositedCurrencyCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CashDeclarationAccountActivityDto", "payload": "CashDeclarationAccountActivityDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargedPerson", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DepositedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DepositedCurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashDeclarationId", "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 } } }, "/cash-declaration-account-activities/{id}": { "delete": { "operationId": "delete-cash-declaration-account-activity", "tags": [ "cash-declaration-account-activities" ], "summary": "delete-cash-declaration-account-activity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashDeclarationAccountActivityId" } } ], "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-cash-declaration-account-activity", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declaration-account-activities/{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_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "CASH_DECLARATION_ACCOUNT_ACTIVITY_NOT_FOUND" } ] } }, "get": { "operationId": "get-cash-declaration-account-activity-by-id", "tags": [ "cash-declaration-account-activities" ], "summary": "get-cash-declaration-account-activity-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashDeclarationAccountActivityId" } } ], "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-cash-declaration-account-activity-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declaration-account-activities/{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": "CashDeclarationAccountActivityDto", "payload": "CashDeclarationAccountActivityDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargedPerson", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DepositedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DepositedCurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashDeclarationId", "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_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "CASH_DECLARATION_ACCOUNT_ACTIVITY_NOT_FOUND" } ] } }, "put": { "operationId": "update-cash-declaration-account-activity", "tags": [ "cash-declaration-account-activities" ], "summary": "update-cash-declaration-account-activity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashDeclarationAccountActivityId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "chargedPerson": { "type": "string", "x-aura-field-code": "chargedPerson" }, "depositedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "depositedAmount" }, "depositedCurrencyCode": { "type": "string", "x-aura-field-code": "depositedCurrencyCode" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "required": [ "chargedPerson", "depositedAmount", "depositedCurrencyCode", "reference" ] } } } }, "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-cash-declaration-account-activity", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declaration-account-activities/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargedPerson", "declared_type": null, "nullable": false, "collection": false }, { "name": "DepositedAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DepositedCurrencyCode", "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_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "CASH_DECLARATION_ACCOUNT_ACTIVITY_NOT_FOUND" } ] } } }, "/cash-declarations": { "get": { "operationId": "get-all-cash-declaration-form-list", "tags": [ "cash-declarations" ], "summary": "get-all-cash-declaration-form-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-all-cash-declaration-form-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declarations", "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": "CashDeclarationDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NbfVerificationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashDeclarationFormDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IssuingCustomsAuthority", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OriginCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OnBehalf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "City", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Address", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Confirmed", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PurposeofUsage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DepositedAmountSum", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "RemainingBalance", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CashDeclarationAccountActivities", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-cash-declaration-form", "tags": [ "cash-declarations" ], "summary": "create-cash-declaration-form", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "address": { "type": "string", "x-aura-field-code": "address" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "cashDeclarationAccountActivityInputModelList": { "type": "array", "items": { "type": "object", "properties": { "chargedPerson": { "type": "string", "x-aura-field-code": "chargedPerson" }, "depositedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "depositedAmount" }, "depositedCurrencyCode": { "type": "string", "x-aura-field-code": "depositedCurrencyCode" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "required": [ "chargedPerson", "depositedAmount", "depositedCurrencyCode", "reference" ], "x-aura-field-code": "cashDeclarationAccountActivityInputModelList" } }, "cashDeclarationFormDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cashDeclarationFormDate" }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "confirmed": { "type": "boolean", "x-aura-field-code": "confirmed" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "issuingCustomsAuthority": { "type": "string", "x-aura-field-code": "issuingCustomsAuthority" }, "nbfVerificationCode": { "type": "string", "x-aura-field-code": "nbfVerificationCode" }, "onBehalf": { "type": "string", "x-aura-field-code": "onBehalf" }, "originCountry": { "type": "string", "x-aura-field-code": "originCountry" }, "purposeOfUsage": { "type": "string", "x-aura-field-code": "purposeOfUsage" }, "registrationNumber": { "type": "string", "x-aura-field-code": "registrationNumber" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" } }, "required": [ "accountNumber", "address", "amount", "cashDeclarationAccountActivityInputModelList", "cashDeclarationFormDate", "city", "confirmed", "currencyCode", "customerId", "issuingCustomsAuthority", "nbfVerificationCode", "onBehalf", "originCountry", "purposeOfUsage", "registrationNumber", "taxNumber" ] } } } }, "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": 16, "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-cash-declaration-form", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declarations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "NbfVerificationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CashDeclarationFormDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "IssuingCustomsAuthority", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "OriginCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "OnBehalf", "declared_type": null, "nullable": false, "collection": false }, { "name": "TaxNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "City", "declared_type": null, "nullable": false, "collection": false }, { "name": "Address", "declared_type": null, "nullable": false, "collection": false }, { "name": "Confirmed", "declared_type": null, "nullable": false, "collection": false }, { "name": "PurposeOfUsage", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "CashDeclarationDto", "payload": "CashDeclarationDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NbfVerificationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashDeclarationFormDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IssuingCustomsAuthority", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OriginCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OnBehalf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "City", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Address", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Confirmed", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PurposeofUsage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DepositedAmountSum", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "RemainingBalance", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CashDeclarationAccountActivities", "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 }, "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_FRGN_TRD_37", "status": 400, "message": null, "message_available": false, "constant_name": "ACCOUNT_ACTIVITY_REFERENCE_ALREADY_EXISTS" } ] } } }, "/cash-declarations/{id}": { "delete": { "operationId": "delete-cash-declaration-form", "tags": [ "cash-declarations" ], "summary": "delete-cash-declaration-form", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashDeclarationId" } } ], "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-cash-declaration-form", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declarations/{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_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "CASH_DECLARATION_FORM_NOT_FOUND" } ] } }, "get": { "operationId": "get-cash-declaration-form-by-id", "tags": [ "cash-declarations" ], "summary": "get-cash-declaration-form-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashDeclarationId" } } ], "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-cash-declaration-form-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declarations/{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": "CashDeclarationDto", "payload": "CashDeclarationDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NbfVerificationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CashDeclarationFormDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IssuingCustomsAuthority", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OriginCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OnBehalf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "City", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Address", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Confirmed", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PurposeofUsage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DepositedAmountSum", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "RemainingBalance", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CashDeclarationAccountActivities", "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 }, "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_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "CASH_DECLARATION_FORM_NOT_FOUND" } ] } }, "put": { "operationId": "update-cash-declaration-form", "tags": [ "cash-declarations" ], "summary": "update-cash-declaration-form", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashDeclarationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "address": { "type": "string", "x-aura-field-code": "address" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "cashDeclarationAccountActivityInputModelList": { "type": "array", "items": { "type": "object", "properties": { "chargedPerson": { "type": "string", "x-aura-field-code": "chargedPerson" }, "depositedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "depositedAmount" }, "depositedCurrencyCode": { "type": "string", "x-aura-field-code": "depositedCurrencyCode" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "required": [ "chargedPerson", "depositedAmount", "depositedCurrencyCode", "reference" ], "x-aura-field-code": "cashDeclarationAccountActivityInputModelList" } }, "cashDeclarationFormDate": { "type": "string", "format": "date-time", "x-aura-field-code": "cashDeclarationFormDate" }, "city": { "type": "string", "x-aura-field-code": "city", "x-aura-maskable": true }, "confirmed": { "type": "boolean", "x-aura-field-code": "confirmed" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "issuingCustomsAuthority": { "type": "string", "x-aura-field-code": "issuingCustomsAuthority" }, "nbfVerificationCode": { "type": "string", "x-aura-field-code": "nbfVerificationCode" }, "onBehalf": { "type": "string", "x-aura-field-code": "onBehalf" }, "originCountry": { "type": "string", "x-aura-field-code": "originCountry" }, "purposeofUsage": { "type": "string", "x-aura-field-code": "purposeofUsage" }, "registrationNumber": { "type": "string", "x-aura-field-code": "registrationNumber" }, "taxNumber": { "type": "string", "x-aura-field-code": "taxNumber" } }, "required": [ "accountNumber", "address", "amount", "cashDeclarationAccountActivityInputModelList", "cashDeclarationFormDate", "city", "confirmed", "currencyCode", "customerId", "issuingCustomsAuthority", "nbfVerificationCode", "onBehalf", "originCountry", "purposeofUsage", "registrationNumber", "taxNumber" ] } } } }, "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": 16, "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-cash-declaration-form", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "cash-declarations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "RegistrationNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "NbfVerificationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CashDeclarationFormDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "IssuingCustomsAuthority", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "OriginCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "OnBehalf", "declared_type": null, "nullable": false, "collection": false }, { "name": "TaxNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "City", "declared_type": null, "nullable": false, "collection": false }, { "name": "Address", "declared_type": null, "nullable": false, "collection": false }, { "name": "Confirmed", "declared_type": null, "nullable": false, "collection": false }, { "name": "PurposeofUsage", "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_FRGN_TRD_37", "status": 400, "message": null, "message_available": false, "constant_name": "ACCOUNT_ACTIVITY_REFERENCE_ALREADY_EXISTS" }, { "code": "ERR_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "CASH_DECLARATION_FORM_NOT_FOUND" } ] } } }, "/compensating-transactions/commit": { "post": { "operationId": "foreign-trade-commit-compensating-transaction", "tags": [ "compensating-transactions" ], "summary": "foreign-trade-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": "foreign-trade-commit-compensating-transaction", "x-aura-domain": "foreign-trade", "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": "foreign-trade-rollback-compensating-transaction", "tags": [ "compensating-transactions" ], "summary": "foreign-trade-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": "foreign-trade-rollback-compensating-transaction", "x-aura-domain": "foreign-trade", "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" } } }, "/custom-declarations": { "get": { "operationId": "get-custom-declaration-list", "tags": [ "custom-declarations" ], "summary": "get-custom-declaration-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-custom-declaration-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "custom-declarations", "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": "CustomDeclarationDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DeclarationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeclarationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DeclarationDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomsGate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OtherBankId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OtherBranchId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "PaymentMethod", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FOBAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "FOBDolarAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ActualExportDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ExportPeriod", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ExtraTime", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DestinationCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ExpiryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ShipmentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DFIFFlag", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Importer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Manufacturer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedAt", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "UpdatedAt", "declared_type": "DateTime?", "nullable": true, "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 } }, "post": { "operationId": "create-custom-declaration", "tags": [ "custom-declarations" ], "summary": "create-custom-declaration", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "actualExportDate": { "type": "string", "format": "date-time", "x-aura-field-code": "actualExportDate" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customsGate": { "type": "string", "x-aura-field-code": "customsGate" }, "dFIFFlag": { "type": "boolean", "x-aura-field-code": "dFIFFlag" }, "declarationDate": { "type": "string", "format": "date-time", "x-aura-field-code": "declarationDate" }, "declarationNumber": { "type": "string", "x-aura-field-code": "declarationNumber" }, "declarationType": { "type": "string", "x-aura-field-code": "declarationType" }, "destinationCountryCode": { "type": "string", "x-aura-field-code": "destinationCountryCode" }, "expiryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "expiryDate" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "extraTime": { "type": "integer", "format": "int32", "x-aura-field-code": "extraTime" }, "fOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "fOBAmount" }, "fOBDolarAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "fOBDolarAmount" }, "goodsType": { "type": "string", "x-aura-field-code": "goodsType" }, "importer": { "type": "string", "x-aura-field-code": "importer" }, "manufacturer": { "type": "string", "x-aura-field-code": "manufacturer" }, "otherBankId": { "type": "string", "format": "uuid", "x-aura-field-code": "otherBankId" }, "otherBranchId": { "type": "string", "format": "uuid", "x-aura-field-code": "otherBranchId" }, "paymentMethod": { "type": "string", "x-aura-field-code": "paymentMethod" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "customDeclarationStatus" } }, "required": [ "actualExportDate", "amount", "currencyCode", "customerId", "customsGate", "dFIFFlag", "declarationDate", "declarationNumber", "declarationType", "destinationCountryCode", "expiryDate", "exportPeriod", "extraTime", "fOBAmount", "fOBDolarAmount", "goodsType", "importer", "manufacturer", "otherBankId", "otherBranchId", "paymentMethod", "remainingAmount", "shipmentType", "status" ] } } } }, "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": 24, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-custom-declaration", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "custom-declarations", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeclarationNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeclarationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeclarationDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomsGate", "declared_type": null, "nullable": false, "collection": false }, { "name": "OtherBankId", "declared_type": null, "nullable": true, "collection": false }, { "name": "OtherBranchId", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentMethod", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "FOBAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "FOBDolarAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "ActualExportDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportPeriod", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExtraTime", "declared_type": null, "nullable": false, "collection": false }, { "name": "DestinationCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExpiryDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipmentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DFIFFlag", "declared_type": null, "nullable": false, "collection": false }, { "name": "Importer", "declared_type": null, "nullable": false, "collection": false }, { "name": "Manufacturer", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/custom-declarations/{id}": { "delete": { "operationId": "delete-custom-declaration", "tags": [ "custom-declarations" ], "summary": "delete-custom-declaration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customDeclarationId" } } ], "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-custom-declaration", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "custom-declarations/{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_FRGN_TRD_69", "status": 400, "message": null, "message_available": false, "constant_name": "CUSTOM_DECLARATION_NOT_FOUND" } ] } }, "get": { "operationId": "get-custom-declaration-by-id", "tags": [ "custom-declarations" ], "summary": "get-custom-declaration-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customDeclarationId" } } ], "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-custom-declaration-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "custom-declarations/{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": "CustomDeclarationDto", "payload": "CustomDeclarationDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DeclarationNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeclarationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DeclarationDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomsGate", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OtherBankId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "OtherBranchId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "PaymentMethod", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FOBAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "FOBDolarAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ActualExportDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ExportPeriod", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ExtraTime", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DestinationCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ExpiryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ShipmentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DFIFFlag", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Importer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Manufacturer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedAt", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "UpdatedAt", "declared_type": "DateTime?", "nullable": true, "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_FRGN_TRD_69", "status": 400, "message": null, "message_available": false, "constant_name": "CUSTOM_DECLARATION_NOT_FOUND" } ] } }, "put": { "operationId": "update-custom-declaration", "tags": [ "custom-declarations" ], "summary": "update-custom-declaration", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "cashDeclarationId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "actualExportDate": { "type": "string", "format": "date-time", "x-aura-field-code": "actualExportDate" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customsGate": { "type": "string", "x-aura-field-code": "customsGate" }, "dFIFFlag": { "type": "boolean", "x-aura-field-code": "dFIFFlag" }, "declarationDate": { "type": "string", "format": "date-time", "x-aura-field-code": "declarationDate" }, "declarationNumber": { "type": "string", "x-aura-field-code": "declarationNumber" }, "declarationType": { "type": "string", "x-aura-field-code": "declarationType" }, "destinationCountryCode": { "type": "string", "x-aura-field-code": "destinationCountryCode" }, "expiryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "expiryDate" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "extraTime": { "type": "integer", "format": "int32", "x-aura-field-code": "extraTime" }, "fOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "fOBAmount" }, "fOBDolarAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "fOBDolarAmount" }, "goodsType": { "type": "string", "x-aura-field-code": "goodsType" }, "importer": { "type": "string", "x-aura-field-code": "importer" }, "manufacturer": { "type": "string", "x-aura-field-code": "manufacturer" }, "otherBankId": { "type": "string", "format": "uuid", "x-aura-field-code": "otherBankId" }, "otherBranchId": { "type": "string", "format": "uuid", "x-aura-field-code": "otherBranchId" }, "paymentMethod": { "type": "string", "x-aura-field-code": "paymentMethod" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "customDeclarationStatus" } }, "required": [ "actualExportDate", "amount", "currencyCode", "customerId", "customsGate", "dFIFFlag", "declarationDate", "declarationNumber", "declarationType", "destinationCountryCode", "expiryDate", "exportPeriod", "extraTime", "fOBAmount", "fOBDolarAmount", "goodsType", "importer", "manufacturer", "otherBankId", "otherBranchId", "paymentMethod", "remainingAmount", "shipmentType", "status" ] } } } }, "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": 24, "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-custom-declaration", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "custom-declarations/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeclarationNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeclarationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeclarationDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomsGate", "declared_type": null, "nullable": false, "collection": false }, { "name": "OtherBankId", "declared_type": null, "nullable": true, "collection": false }, { "name": "OtherBranchId", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentMethod", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "FOBAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "FOBDolarAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "ActualExportDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportPeriod", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExtraTime", "declared_type": null, "nullable": false, "collection": false }, { "name": "DestinationCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExpiryDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipmentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DFIFFlag", "declared_type": null, "nullable": false, "collection": false }, { "name": "Importer", "declared_type": null, "nullable": false, "collection": false }, { "name": "Manufacturer", "declared_type": null, "nullable": false, "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_FRGN_TRD_69", "status": 400, "message": null, "message_available": false, "constant_name": "CUSTOM_DECLARATION_NOT_FOUND" } ] } } }, "/export-binders": { "get": { "operationId": "get-export-binder-list", "tags": [ "export-binders" ], "summary": "get-export-binder-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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 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": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclerationFOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "customDeclerationFOBAmount" }, "customDeclerationsNumber": { "type": "string", "x-aura-field-code": "customDeclerationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclerationFOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "customDeclerationFOBAmount" }, "customDeclerationsNumber": { "type": "string", "x-aura-field-code": "customDeclerationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } } }, "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": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclerationFOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "customDeclerationFOBAmount" }, "customDeclerationsNumber": { "type": "string", "x-aura-field-code": "customDeclerationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } } }, "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-export-binder-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-binders", "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-export-binder", "tags": [ "export-binders" ], "summary": "create-export-binder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclerationFOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "customDeclerationFOBAmount" }, "customDeclerationsNumber": { "type": "string", "x-aura-field-code": "customDeclerationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } }, "required": [ "binderAmount", "binderStatus", "currencyCode", "customDeclerationFOBAmount", "customDeclerationsNumber", "customerId", "exportPeriod", "exporterAddress", "exporterName", "featuredTransactionType", "goodType", "importerAddress", "importerName", "loadingCountryCode", "paymentType", "referenceNumber", "shipmentType", "unLoadingCountryCode" ] } } } }, "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": 18, "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 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": "exportBinderId" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" } } }, "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": "exportBinderId" } } }, "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-export-binder", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-binders", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/export-binders/{id}": { "delete": { "operationId": "delete-export-binder", "tags": [ "export-binders" ], "summary": "delete-export-binder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" } } ], "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.", "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-export-binder", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-binders/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "get": { "operationId": "get-export-binder-by-id", "tags": [ "export-binders" ], "summary": "get-export-binder-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" } } ], "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": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclerationFOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "customDeclerationFOBAmount" }, "customDeclerationsNumber": { "type": "string", "x-aura-field-code": "customDeclerationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclerationFOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "customDeclerationFOBAmount" }, "customDeclerationsNumber": { "type": "string", "x-aura-field-code": "customDeclerationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } } }, "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": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclerationFOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "customDeclerationFOBAmount" }, "customDeclerationsNumber": { "type": "string", "x-aura-field-code": "customDeclerationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } } }, "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-export-binder-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-binders/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } }, "put": { "operationId": "update-export-binder", "tags": [ "export-binders" ], "summary": "update-export-binder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportBinderId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclerationFOBAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "customDeclerationFOBAmount" }, "customDeclerationsNumber": { "type": "string", "x-aura-field-code": "customDeclerationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exportPeriod": { "type": "integer", "format": "int32", "x-aura-field-code": "exportPeriod" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } }, "required": [ "binderAmount", "binderStatus", "currencyCode", "customDeclerationFOBAmount", "customDeclerationsNumber", "customerId", "exportPeriod", "exporterAddress", "exporterName", "featuredTransactionType", "goodType", "importerAddress", "importerName", "loadingCountryCode", "paymentType", "referenceNumber", "shipmentType", "unLoadingCountryCode" ] } } } }, "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": 18, "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-export-binder", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-binders/{id}", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/export-document-customs": { "get": { "operationId": "get-export-document-custom-list", "tags": [ "export-document-customs" ], "summary": "get-export-document-custom-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-export-document-custom-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-document-customs", "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": "ExportDocumentCustomDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomDeclarationNumber", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-export-document-custom", "tags": [ "export-document-customs" ], "summary": "create-export-document-custom", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customDeclarationDate": { "type": "string", "format": "date-time", "x-aura-field-code": "customDeclarationDate" }, "customDeclarationNumber": { "type": "string", "x-aura-field-code": "customDeclarationNumber" }, "exportDocumentId": { "x-aura-type": "unresolved" } }, "required": [ "customDeclarationDate", "customDeclarationNumber", "exportDocumentId" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-document-custom", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-document-customs", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomDeclarationDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomDeclarationNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportDocumentId", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/export-document-customs/{id}": { "delete": { "operationId": "delete-export-document-custom", "tags": [ "export-document-customs" ], "summary": "delete-export-document-custom", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportDocumentCustomId" } } ], "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-export-document-custom", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-document-customs/{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_FRGN_TRD_52", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_CUSTOM_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-document-custom-by-id", "tags": [ "export-document-customs" ], "summary": "get-export-document-custom-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportDocumentCustomId" } } ], "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-export-document-custom-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-document-customs/{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": "ExportDocumentCustomDto", "payload": "ExportDocumentCustomDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomDeclarationNumber", "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_FRGN_TRD_52", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_CUSTOM_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-document-custom", "tags": [ "export-document-customs" ], "summary": "update-export-document-custom", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportDocumentCustomId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customDeclarationDate": { "type": "string", "format": "date-time", "x-aura-field-code": "customDeclarationDate" }, "customDeclarationNumber": { "type": "string", "x-aura-field-code": "customDeclarationNumber" } }, "required": [ "customDeclarationDate", "customDeclarationNumber" ] } } } }, "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-export-document-custom", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-document-customs/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomDeclarationDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomDeclarationNumber", "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_FRGN_TRD_52", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_CUSTOM_NOT_FOUND" } ] } } }, "/export-documents": { "get": { "operationId": "get-export-document-list", "tags": [ "export-documents" ], "summary": "get-export-document-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-export-document-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents", "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": "ExportDocumentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Assignment", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "AssignmentAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Charge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Collateral", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CollateralAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CollectingBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectingBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectingBankCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CourrierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CourrierNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DeliveryPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DispatchDocumentDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DocumentCollectingBank", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FeedbackCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentBIC", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IncentiveDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiptDocumentDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ReceiptPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage74Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportReturnDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringImporterCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringImporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionDocumentData", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ExportDocumentCustoms", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "TermDetails", "declared_type": "IEnumerable", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-export-document", "tags": [ "export-documents" ], "summary": "create-export-document", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "assignment": { "type": "boolean", "x-aura-field-code": "assignment" }, "assignmentAmount": { "type": "number", "x-aura-field-code": "assignmentAmount" }, "charge": { "type": "string", "x-aura-field-code": "charge" }, "chargePayer": { "type": "string", "x-aura-field-code": "chargePayer" }, "collateral": { "type": "boolean", "x-aura-field-code": "collateral" }, "collateralAmount": { "type": "number", "x-aura-field-code": "collateralAmount" }, "collectingBankAddress": { "type": "string", "x-aura-field-code": "collectingBankAddress" }, "collectingBankCountry": { "type": "string", "x-aura-field-code": "collectingBankCountry" }, "collectingBankName": { "type": "string", "x-aura-field-code": "collectingBankName" }, "collectionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmount" }, "collectionDocumentData": { "type": "array", "items": { "type": "object", "properties": { "collectionDocumentDate": { "type": "string", "x-aura-field-code": "collectionDocumentDate" }, "collectionDocumentNumber": { "type": "string", "x-aura-field-code": "collectionDocumentNumber" }, "collectionDocumentType": { "type": "string", "x-aura-field-code": "collectionDocumentType" }, "collectionNumberOfCopies": { "type": "string", "x-aura-field-code": "collectionNumberOfCopies" }, "collectionNumberOfOriginals": { "type": "string", "x-aura-field-code": "collectionNumberOfOriginals" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "exportDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" }, "exportLetterCreditId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" }, "importLetterCreditId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "required": [ "collectionDocumentDate", "collectionDocumentNumber", "collectionDocumentType", "collectionNumberOfCopies", "collectionNumberOfOriginals", "collectionType", "exportDocumentId", "exportLetterCreditId", "importDocumentId", "importLetterCreditId", "reference" ], "x-aura-field-code": "collectionDocumentData" } }, "collectionEntryDate": { "type": "string", "x-aura-field-code": "collectionEntryDate" }, "collectionPlace": { "type": "string", "x-aura-field-code": "collectionPlace" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "correspondentBIC": { "type": "string", "x-aura-field-code": "correspondentBIC" }, "correspondentChargePayer": { "type": "string", "x-aura-field-code": "correspondentChargePayer" }, "courrierCompany": { "type": "string", "x-aura-field-code": "courrierCompany" }, "courrierNumber": { "type": "string", "x-aura-field-code": "courrierNumber" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "deliveryPlace": { "type": "string", "x-aura-field-code": "deliveryPlace" }, "description": { "type": "string", "x-aura-field-code": "description" }, "dispatchDocumentDate": { "type": "string", "x-aura-field-code": "dispatchDocumentDate" }, "documentCollectingBank": { "type": "string", "x-aura-field-code": "documentCollectingBank" }, "exportDocumentCustoms": { "type": "array", "items": { "type": "object", "properties": { "customDeclarationDate": { "type": "string", "format": "date-time", "x-aura-field-code": "customDeclarationDate" }, "customDeclarationNumber": { "type": "string", "x-aura-field-code": "customDeclarationNumber" }, "exportDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" } }, "required": [ "customDeclarationDate", "customDeclarationNumber", "exportDocumentId" ], "x-aura-field-code": "exportDocumentCustoms" } }, "exportReturnDescription": { "type": "string", "x-aura-field-code": "exportReturnDescription" }, "feedbackCharge": { "type": "string", "x-aura-field-code": "feedbackCharge" }, "fileStatus": { "type": "string", "x-aura-field-code": "fileStatus" }, "goodsOrigin": { "type": "string", "x-aura-field-code": "goodsOrigin" }, "goodsValue": { "type": "number", "format": "decimal", "x-aura-field-code": "goodsValue" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerCountry": { "type": "string", "x-aura-field-code": "importerCountry" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "incentive": { "type": "boolean", "x-aura-field-code": "incentive" }, "incentiveDocumentId": { "type": "string", "x-aura-field-code": "incentiveDocumentId" }, "incentiveDocumentType": { "type": "string", "x-aura-field-code": "incentiveDocumentType" }, "preDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "preDocumentId" }, "receiptDocumentDate": { "type": "string", "x-aura-field-code": "receiptDocumentDate" }, "receiptPlace": { "type": "string", "x-aura-field-code": "receiptPlace" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportDocumentStatus" }, "swiftMessage72Area": { "type": "string", "x-aura-field-code": "swiftMessage72Area" }, "swiftMessage74Area": { "type": "string", "x-aura-field-code": "swiftMessage74Area" }, "swiftMessage79Area": { "type": "string", "x-aura-field-code": "swiftMessage79Area" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "termDetails": { "type": "array", "items": { "type": "object", "properties": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportDocumentStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } }, "required": [ "acceptanceStatus", "accountingBusinessKey", "avalStatus", "chequeNumber", "exportDocumentId", "groupGuid", "importDocumentId", "maturityAmount", "maturityDueDate", "maturityInstrumentType", "maturityInstrumentTypeName", "maturityPaymentCondition", "maturityPaymentConditionDay", "maturityStartingDate", "policyCorrespondentReturnDate", "policyCustomerReturnDate", "policyDeliveryDate", "policyHolderOfDraft", "policyProtestType", "policyProtestTypeName", "policyReturnDate", "policyStatusOfDraft", "reference", "status", "termIndex", "termReturnDescription", "toTheOrderOfPolicy" ], "x-aura-field-code": "termDetails" } }, "transferringBankAddress": { "type": "string", "x-aura-field-code": "transferringBankAddress" }, "transferringBankBicCode": { "type": "string", "x-aura-field-code": "transferringBankBicCode" }, "transferringCharge": { "type": "string", "x-aura-field-code": "transferringCharge" }, "transferringChargePayer": { "type": "string", "x-aura-field-code": "transferringChargePayer" }, "transferringDescription": { "type": "string", "x-aura-field-code": "transferringDescription" }, "transferringImporterAddress": { "type": "string", "x-aura-field-code": "transferringImporterAddress" }, "transferringImporterCompany": { "type": "string", "x-aura-field-code": "transferringImporterCompany" }, "waveInfo": { "type": "string", "x-aura-field-code": "waveInfo" } }, "required": [ "accountNumber", "accountingBusinessKey", "assignment", "assignmentAmount", "charge", "chargePayer", "collateral", "collateralAmount", "collectingBankAddress", "collectingBankCountry", "collectingBankName", "collectionAmount", "collectionDocumentData", "collectionEntryDate", "collectionPlace", "collectionType", "correspondentBIC", "correspondentChargePayer", "courrierCompany", "courrierNumber", "currencyCode", "customerId", "deliveryPlace", "description", "dispatchDocumentDate", "documentCollectingBank", "exportDocumentCustoms", "exportReturnDescription", "feedbackCharge", "fileStatus", "goodsOrigin", "goodsValue", "groupGuid", "importerAddress", "importerCountry", "importerName", "incentive", "incentiveDocumentId", "incentiveDocumentType", "preDocumentId", "receiptDocumentDate", "receiptPlace", "reference", "relatedReference", "remainingAmount", "status", "swiftMessage72Area", "swiftMessage74Area", "swiftMessage79Area", "swiftMessageType", "termDetails", "transferringBankAddress", "transferringBankBicCode", "transferringCharge", "transferringChargePayer", "transferringDescription", "transferringImporterAddress", "transferringImporterCompany", "waveInfo" ] } } } }, "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": 59, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "Assignment", "declared_type": null, "nullable": false, "collection": false }, { "name": "AssignmentAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Charge", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "Collateral", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollateralAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectingBankAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectingBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectingBankCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "CourrierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "CourrierNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "DispatchDocumentDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentCollectingBank", "declared_type": null, "nullable": false, "collection": false }, { "name": "FeedbackCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentBIC", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": null, "nullable": false, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": null, "nullable": false, "collection": false }, { "name": "IncentiveDocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiptDocumentDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReceiptPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessage74Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportReturnDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringImporterCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringImporterAddress", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/export-documents/{id}": { "delete": { "operationId": "delete-export-document", "tags": [ "export-documents" ], "summary": "delete-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-document-by-id", "tags": [ "export-documents" ], "summary": "get-export-document-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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-export-document-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{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": "ExportDocumentDto", "payload": "ExportDocumentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Assignment", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "AssignmentAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Charge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Collateral", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CollateralAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CollectingBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectingBankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectingBankCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CourrierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CourrierNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "DeliveryPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DispatchDocumentDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DocumentCollectingBank", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FeedbackCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentBIC", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IncentiveDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiptDocumentDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ReceiptPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage74Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportReturnDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringImporterCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringImporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionDocumentData", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "ExportDocumentCustoms", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "TermDetails", "declared_type": "IEnumerable", "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 }, "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-document", "tags": [ "export-documents" ], "summary": "update-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "assignment": { "type": "boolean", "x-aura-field-code": "assignment" }, "assignmentAmount": { "type": "number", "x-aura-field-code": "assignmentAmount" }, "charge": { "type": "string", "x-aura-field-code": "charge" }, "chargePayer": { "type": "string", "x-aura-field-code": "chargePayer" }, "collateral": { "type": "boolean", "x-aura-field-code": "collateral" }, "collateralAmount": { "type": "number", "x-aura-field-code": "collateralAmount" }, "collectingBankAddress": { "type": "string", "x-aura-field-code": "collectingBankAddress" }, "collectingBankCountry": { "type": "string", "x-aura-field-code": "collectingBankCountry" }, "collectingBankName": { "type": "string", "x-aura-field-code": "collectingBankName" }, "collectionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmount" }, "collectionDocumentData": { "type": "array", "items": { "type": "object", "properties": { "collectionDocumentDate": { "type": "string", "x-aura-field-code": "collectionDocumentDate" }, "collectionDocumentNumber": { "type": "string", "x-aura-field-code": "collectionDocumentNumber" }, "collectionDocumentType": { "type": "string", "x-aura-field-code": "collectionDocumentType" }, "collectionNumberOfCopies": { "type": "string", "x-aura-field-code": "collectionNumberOfCopies" }, "collectionNumberOfOriginals": { "type": "string", "x-aura-field-code": "collectionNumberOfOriginals" }, "id": { "type": "string", "x-aura-field-code": "exportDocumentId" } }, "required": [ "collectionDocumentDate", "collectionDocumentNumber", "collectionDocumentType", "collectionNumberOfCopies", "collectionNumberOfOriginals", "id" ], "x-aura-field-code": "collectionDocumentData" } }, "collectionEntryDate": { "type": "string", "x-aura-field-code": "collectionEntryDate" }, "collectionPlace": { "type": "string", "x-aura-field-code": "collectionPlace" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "correspondentBIC": { "type": "string", "x-aura-field-code": "correspondentBIC" }, "correspondentChargePayer": { "type": "string", "x-aura-field-code": "correspondentChargePayer" }, "courrierCompany": { "type": "string", "x-aura-field-code": "courrierCompany" }, "courrierNumber": { "type": "string", "x-aura-field-code": "courrierNumber" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "deliveryPlace": { "type": "string", "x-aura-field-code": "deliveryPlace" }, "description": { "type": "string", "x-aura-field-code": "description" }, "dispatchDocumentDate": { "type": "string", "x-aura-field-code": "dispatchDocumentDate" }, "documentCollectingBank": { "type": "string", "x-aura-field-code": "documentCollectingBank" }, "exportDocumentCustoms": { "type": "array", "items": { "type": "object", "properties": { "customDeclarationDate": { "type": "string", "format": "date-time", "x-aura-field-code": "customDeclarationDate" }, "customDeclarationNumber": { "type": "string", "x-aura-field-code": "customDeclarationNumber" }, "exportDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" } }, "required": [ "customDeclarationDate", "customDeclarationNumber", "exportDocumentId" ], "x-aura-field-code": "exportDocumentCustoms" } }, "exportReturnDescription": { "type": "string", "x-aura-field-code": "exportReturnDescription" }, "feedbackCharge": { "type": "string", "x-aura-field-code": "feedbackCharge" }, "fileStatus": { "type": "string", "x-aura-field-code": "fileStatus" }, "goodsOrigin": { "type": "string", "x-aura-field-code": "goodsOrigin" }, "goodsValue": { "type": "number", "format": "decimal", "x-aura-field-code": "goodsValue" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerCountry": { "type": "string", "x-aura-field-code": "importerCountry" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "incentive": { "type": "boolean", "x-aura-field-code": "incentive" }, "incentiveDocumentId": { "type": "string", "x-aura-field-code": "incentiveDocumentId" }, "incentiveDocumentType": { "type": "string", "x-aura-field-code": "incentiveDocumentType" }, "preDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "preDocumentId" }, "receiptDocumentDate": { "type": "string", "x-aura-field-code": "receiptDocumentDate" }, "receiptPlace": { "type": "string", "x-aura-field-code": "receiptPlace" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportDocumentStatus" }, "swiftMessage72Area": { "type": "string", "x-aura-field-code": "swiftMessage72Area" }, "swiftMessage74Area": { "type": "string", "x-aura-field-code": "swiftMessage74Area" }, "swiftMessage79Area": { "type": "string", "x-aura-field-code": "swiftMessage79Area" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "termDetails": { "type": "array", "items": { "type": "object", "properties": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "x-aura-field-code": "exportDocumentId" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "guidField" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportDocumentStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } }, "required": [ "acceptanceStatus", "avalStatus", "chequeNumber", "maturityAmount", "maturityInstrumentType" ], "x-aura-field-code": "termDetails" } }, "transferringBankAddress": { "type": "string", "x-aura-field-code": "transferringBankAddress" }, "transferringBankBicCode": { "type": "string", "x-aura-field-code": "transferringBankBicCode" }, "transferringCharge": { "type": "string", "x-aura-field-code": "transferringCharge" }, "transferringChargePayer": { "type": "string", "x-aura-field-code": "transferringChargePayer" }, "transferringDescription": { "type": "string", "x-aura-field-code": "transferringDescription" }, "transferringImporterAddress": { "type": "string", "x-aura-field-code": "transferringImporterAddress" }, "transferringImporterCompany": { "type": "string", "x-aura-field-code": "transferringImporterCompany" }, "waveInfo": { "type": "string", "x-aura-field-code": "waveInfo" } }, "required": [ "accountNumber", "accountingBusinessKey", "assignment", "assignmentAmount", "charge", "chargePayer", "collateral", "collateralAmount", "collectingBankAddress", "collectingBankCountry", "collectingBankName", "collectionAmount", "collectionDocumentData", "collectionEntryDate", "collectionPlace", "collectionType", "correspondentBIC", "correspondentChargePayer", "courrierCompany", "courrierNumber", "currencyCode", "customerId", "deliveryPlace", "description", "dispatchDocumentDate", "documentCollectingBank", "exportDocumentCustoms", "exportReturnDescription", "feedbackCharge", "goodsOrigin", "goodsValue", "groupGuid", "importerAddress", "importerCountry", "importerName", "incentive", "incentiveDocumentId", "incentiveDocumentType", "preDocumentId", "receiptDocumentDate", "receiptPlace", "reference", "relatedReference", "remainingAmount", "swiftMessage72Area", "swiftMessage74Area", "swiftMessage79Area", "swiftMessageType", "termDetails", "transferringBankAddress", "transferringBankBicCode", "transferringCharge", "transferringChargePayer", "transferringDescription", "transferringImporterAddress", "transferringImporterCompany", "waveInfo" ] } } } }, "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": 59, "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-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "Assignment", "declared_type": null, "nullable": false, "collection": false }, { "name": "AssignmentAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Charge", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "Collateral", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollateralAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectingBankAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectingBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectingBankCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "CourrierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "CourrierNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "DispatchDocumentDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentCollectingBank", "declared_type": null, "nullable": false, "collection": false }, { "name": "FeedbackCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentBIC", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": null, "nullable": false, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": null, "nullable": false, "collection": false }, { "name": "IncentiveDocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiptDocumentDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReceiptPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessage74Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportReturnDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringImporterCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringImporterAddress", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-documents/{id}/cancel": { "post": { "operationId": "set-cancelled-export-document", "tags": [ "export-documents" ], "summary": "set-cancelled-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-cancelled-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}/cancel", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-documents/{id}/feedback": { "post": { "operationId": "set-feedback-export-document", "tags": [ "export-documents" ], "summary": "set-feedback-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-feedback-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}/feedback", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-documents/{id}/free-payment": { "post": { "operationId": "set-free-of-payment-export-document", "tags": [ "export-documents" ], "summary": "set-free-of-payment-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-free-of-payment-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}/free-payment", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-documents/{id}/process": { "post": { "operationId": "set-processing-export-document", "tags": [ "export-documents" ], "summary": "set-processing-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-processing-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}/process", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-documents/{id}/reject": { "post": { "operationId": "set-rejected-export-document", "tags": [ "export-documents" ], "summary": "set-rejected-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-rejected-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}/reject", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-documents/{id}/return": { "post": { "operationId": "set-returned-export-document", "tags": [ "export-documents" ], "summary": "set-returned-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "returnDescription": { "type": "string", "x-aura-field-code": "returnDescription" } }, "required": [ "returnDescription" ] } } } }, "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-returned-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}/return", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturnDescription", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-documents/{id}/transfer": { "post": { "operationId": "set-transferred-export-document", "tags": [ "export-documents" ], "summary": "set-transferred-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-transferred-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}/transfer", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-documents/{id}/wait-proceed": { "post": { "operationId": "set-waiting-for-proceed-export-document", "tags": [ "export-documents" ], "summary": "set-waiting-for-proceed-export-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportDocumentId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-waiting-for-proceed-export-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-documents/{id}/wait-proceed", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_44", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/export-lc-delivery-documents": { "get": { "operationId": "get-export-lCDelivery-document-list", "tags": [ "export-lc-delivery-documents" ], "summary": "get-export-lCDelivery-document-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-export-lCDelivery-document-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-delivery-documents", "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": "ExportLCDeliveryDocumentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DeliveryDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryDocumentTypeName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OriginalDocumentCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CopyDocumentCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DeliveryOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCDocumentId", "declared_type": "Guid?", "nullable": true, "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 } }, "post": { "operationId": "create-export-lCDelivery-document", "tags": [ "export-lc-delivery-documents" ], "summary": "create-export-lCDelivery-document", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "copyDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "copyDocumentCount" }, "deliveryDocumentType": { "type": "string", "x-aura-field-code": "deliveryDocumentType" }, "deliveryDocumentTypeName": { "type": "string", "x-aura-field-code": "deliveryDocumentTypeName" }, "deliveryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "deliveryOrder" }, "exportLCDocumentId": { "x-aura-type": "unresolved" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "originalDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "originalDocumentCount" } }, "required": [ "copyDocumentCount", "deliveryDocumentType", "deliveryDocumentTypeName", "deliveryOrder", "exportLCDocumentId", "invoiceDate", "invoiceNo", "originalDocumentCount" ] } } } }, "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": 8, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-lCDelivery-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-delivery-documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeliveryDocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryDocumentTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "OriginalDocumentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CopyDocumentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryOrder", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportLCDocumentId", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/export-lc-delivery-documents/{id}": { "delete": { "operationId": "delete-export-lCDelivery-document", "tags": [ "export-lc-delivery-documents" ], "summary": "delete-export-lCDelivery-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDeliveryDocumentId" } } ], "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-export-lCDelivery-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-delivery-documents/{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_FRGN_TRD_45", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DELIVERY_DOCUMENT_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-lCDelivery-document-by-id", "tags": [ "export-lc-delivery-documents" ], "summary": "get-export-lCDelivery-document-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDeliveryDocumentId" } } ], "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-export-lCDelivery-document-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-delivery-documents/{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": "ExportLCDeliveryDocumentDto", "payload": "ExportLCDeliveryDocumentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DeliveryDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryDocumentTypeName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OriginalDocumentCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CopyDocumentCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DeliveryOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCDocumentId", "declared_type": "Guid?", "nullable": true, "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_FRGN_TRD_45", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DELIVERY_DOCUMENT_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-lCDelivery-document", "tags": [ "export-lc-delivery-documents" ], "summary": "update-export-lCDelivery-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDeliveryDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "copyDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "copyDocumentCount" }, "deliveryDocumentType": { "type": "string", "x-aura-field-code": "deliveryDocumentType" }, "deliveryDocumentTypeName": { "type": "string", "x-aura-field-code": "deliveryDocumentTypeName" }, "deliveryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "deliveryOrder" }, "exportLCDocumentId": { "x-aura-type": "unresolved" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "originalDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "originalDocumentCount" } }, "required": [ "copyDocumentCount", "deliveryDocumentType", "deliveryDocumentTypeName", "deliveryOrder", "exportLCDocumentId", "invoiceDate", "invoiceNo", "originalDocumentCount" ] } } } }, "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": 8, "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-export-lCDelivery-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-delivery-documents/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryDocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryDocumentTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "OriginalDocumentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CopyDocumentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryOrder", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportLCDocumentId", "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_FRGN_TRD_45", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DELIVERY_DOCUMENT_NOT_FOUND" } ] } } }, "/export-lc-document-goods-details": { "get": { "operationId": "get-export-lCDocument-goods-detail-list", "tags": [ "export-lc-document-goods-details" ], "summary": "get-export-lCDocument-goods-detail-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-export-lCDocument-goods-detail-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-document-goods-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": "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": "ExportLCDocumentGoodsDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "GoodsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": "double?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalValueOfGoods", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MT700Message45ADetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrentStatusOf45ADetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCDocumentId", "declared_type": "Guid?", "nullable": true, "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 } }, "post": { "operationId": "create-export-lCDocument-goods-detail", "tags": [ "export-lc-document-goods-details" ], "summary": "create-export-lCDocument-goods-detail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "exportLCDocumentId": { "x-aura-type": "unresolved" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "x-aura-type": "unresolved" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "required": [ "currencyCode", "currentStatusOf45ADetail", "exportLCDocumentId", "goodsName", "mT700Message45ADetail", "quantity", "totalValueOfGoods", "unit", "unitPrice" ] } } } }, "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-lCDocument-goods-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-document-goods-details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "GoodsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalValueOfGoods", "declared_type": null, "nullable": false, "collection": false }, { "name": "MT700Message45ADetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrentStatusOf45ADetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportLCDocumentId", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/export-lc-document-goods-details/{id}": { "delete": { "operationId": "delete-export-lCDocument-goods-detail", "tags": [ "export-lc-document-goods-details" ], "summary": "delete-export-lCDocument-goods-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentGoodsDetailId" } } ], "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-export-lCDocument-goods-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-document-goods-details/{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_FRGN_TRD_47", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DOCUMENT_GOODS_DETAIL_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-lCDocument-goods-detail-by-id", "tags": [ "export-lc-document-goods-details" ], "summary": "get-export-lCDocument-goods-detail-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentGoodsDetailId" } } ], "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-export-lCDocument-goods-detail-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-document-goods-details/{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": "ExportLCDocumentGoodsDetailDto", "payload": "ExportLCDocumentGoodsDetailDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "GoodsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": "double?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalValueOfGoods", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MT700Message45ADetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrentStatusOf45ADetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCDocumentId", "declared_type": "Guid?", "nullable": true, "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_FRGN_TRD_47", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DOCUMENT_GOODS_DETAIL_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-lCDocument-goods-detail", "tags": [ "export-lc-document-goods-details" ], "summary": "update-export-lCDocument-goods-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentGoodsDetailId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "exportLCDocumentId": { "x-aura-type": "unresolved" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "x-aura-type": "unresolved" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "required": [ "currencyCode", "currentStatusOf45ADetail", "exportLCDocumentId", "goodsName", "mT700Message45ADetail", "quantity", "totalValueOfGoods", "unit", "unitPrice" ] } } } }, "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-export-lCDocument-goods-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-document-goods-details/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalValueOfGoods", "declared_type": null, "nullable": false, "collection": false }, { "name": "MT700Message45ADetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrentStatusOf45ADetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportLCDocumentId", "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_FRGN_TRD_47", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DOCUMENT_GOODS_DETAIL_NOT_FOUND" } ] } } }, "/export-lc-documents": { "get": { "operationId": "get-export-lCDocument-list", "tags": [ "export-lc-documents" ], "summary": "get-export-lCDocument-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. 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": "get-export-lCDocument-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-documents", "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": "ExportLCDocumentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DocumentNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DocumentSender", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentHolder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DocumentEntryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DueStartingDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PaymentDueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "OurBankCharge", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DocumentStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipperName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Notes", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDocumentExamRequired", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DiscrepancyStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NegotiationStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DueDateConfirmationStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift34AMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift34BMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift71DMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift77Message", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift72ZMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift73AMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift77JMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift79Message", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCDeliveryDocumentList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExportLCDocumentGoodsDetailList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExportLCDocumentReserveList", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-export-lCDocument", "tags": [ "export-lc-documents" ], "summary": "create-export-lCDocument", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "correspondentCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "correspondentCharge" }, "demandedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "demandedAmount" }, "dischargePort": { "type": "string", "x-aura-field-code": "dischargePort" }, "discrepancyStatus": { "type": "string", "x-aura-field-code": "discrepancyStatus" }, "documentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "documentAmount" }, "documentEntryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "documentEntryDate" }, "documentHolder": { "type": "string", "x-aura-field-code": "documentHolder" }, "documentNumber": { "x-aura-type": "unresolved" }, "documentSender": { "type": "string", "x-aura-field-code": "documentSender" }, "documentStatus": { "type": "string", "x-aura-field-code": "documentStatus" }, "dueDateConfirmationStatus": { "type": "string", "x-aura-field-code": "dueDateConfirmationStatus" }, "dueStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "dueStartingDate" }, "explanations": { "type": "string", "x-aura-field-code": "explanations" }, "exportLCDeliveryDocumentList": { "type": "array", "items": { "type": "object", "properties": { "copyDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "copyDocumentCount" }, "deliveryDocumentType": { "type": "string", "x-aura-field-code": "deliveryDocumentType" }, "deliveryDocumentTypeName": { "type": "string", "x-aura-field-code": "deliveryDocumentTypeName" }, "deliveryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "deliveryOrder" }, "exportLCDocumentId": { "x-aura-type": "unresolved" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "originalDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "originalDocumentCount" } }, "x-aura-field-code": "exportLCDeliveryDocumentList" } }, "exportLCDocumentGoodsDetailList": { "type": "array", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "exportLCDocumentId": { "x-aura-type": "unresolved" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "x-aura-type": "unresolved" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "x-aura-field-code": "exportLCDocumentGoodsDetailList" } }, "exportLCDocumentReserveList": { "type": "array", "items": { "type": "object", "properties": { "exportLCDocumentId": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" }, "isChecked": { "type": "boolean", "x-aura-field-code": "isChecked" }, "lcReserveENValue": { "type": "string", "x-aura-field-code": "lcReserveENValue" }, "lcReserveTRValue": { "type": "string", "x-aura-field-code": "lcReserveTRValue" } }, "x-aura-field-code": "exportLCDocumentReserveList" } }, "exportLCId": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLCId" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "isDocumentExamRequired": { "type": "boolean", "x-aura-field-code": "isDocumentExamRequired" }, "lcDocumentSwift34AMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift34AMessage" }, "lcDocumentSwift34BMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift34BMessage" }, "lcDocumentSwift71DMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift71DMessage" }, "lcDocumentSwift72ZMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift72ZMessage" }, "lcDocumentSwift73AMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift73AMessage" }, "lcDocumentSwift77JMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift77JMessage" }, "lcDocumentSwift77Message": { "type": "string", "x-aura-field-code": "lcDocumentSwift77Message" }, "lcDocumentSwift79Message": { "type": "string", "x-aura-field-code": "lcDocumentSwift79Message" }, "lcDocumentSwiftMessageType": { "type": "string", "x-aura-field-code": "lcDocumentSwiftMessageType" }, "loadingPort": { "type": "string", "x-aura-field-code": "loadingPort" }, "negotiationStatus": { "type": "string", "x-aura-field-code": "negotiationStatus" }, "notes": { "type": "string", "x-aura-field-code": "notes" }, "ourBankCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "ourBankCharge" }, "paymentDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "paymentDueDate" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "shipName": { "type": "string", "x-aura-field-code": "shipName" }, "shipperName": { "type": "string", "x-aura-field-code": "shipperName" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportLcDocumentStatus" } } } } } }, "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": 37, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DocumentNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentSender", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentHolder", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentEntryDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "DueStartingDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "OurBankCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipperName", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": null, "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Notes", "declared_type": null, "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDocumentExamRequired", "declared_type": null, "nullable": true, "collection": false }, { "name": "DiscrepancyStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "NegotiationStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "DueDateConfirmationStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportLCId", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift34AMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift34BMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift71DMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift77Message", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift72ZMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift73AMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift77JMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift79Message", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_51", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LETTER_CREDIT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "EXCEEDING_AVAILABLE_LC_AMOUNT" } ] } } }, "/export-lc-documents/count": { "get": { "operationId": "export-lc-document-list-count", "tags": [ "export-lc-documents" ], "summary": "export-lc-document-list-count", "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. 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": "export-lc-document-list-count", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-documents/count", "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 } ] }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `int`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON number, a 32-bit integer. This is a complete answer read from the declaration, not a gap.", "declared_type": "int", "payload": "int" } } }, "/export-lc-documents/{id}": { "delete": { "operationId": "delete-export-lCDocument", "tags": [ "export-lc-documents" ], "summary": "delete-export-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" } } ], "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-export-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-documents/{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_FRGN_TRD_46", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DOCUMENT_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-lCDocument-by-id", "tags": [ "export-lc-documents" ], "summary": "get-export-lCDocument-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" } } ], "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-export-lCDocument-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-documents/{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": "ExportLCDocumentDto", "payload": "ExportLCDocumentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DocumentNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DocumentSender", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentHolder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DocumentEntryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DueStartingDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PaymentDueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "OurBankCharge", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DocumentStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipperName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Notes", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDocumentExamRequired", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "DiscrepancyStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "NegotiationStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DueDateConfirmationStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift34AMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift34BMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift71DMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift77Message", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift72ZMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift73AMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift77JMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift79Message", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCDeliveryDocumentList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExportLCDocumentGoodsDetailList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ExportLCDocumentReserveList", "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 }, "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_FRGN_TRD_46", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DOCUMENT_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-lCDocument", "tags": [ "export-lc-documents" ], "summary": "update-export-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "correspondentCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "correspondentCharge" }, "demandedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "demandedAmount" }, "dischargePort": { "type": "string", "x-aura-field-code": "dischargePort" }, "discrepancyStatus": { "type": "string", "x-aura-field-code": "discrepancyStatus" }, "documentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "documentAmount" }, "documentEntryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "documentEntryDate" }, "documentHolder": { "type": "string", "x-aura-field-code": "documentHolder" }, "documentNumber": { "x-aura-type": "unresolved" }, "documentSender": { "type": "string", "x-aura-field-code": "documentSender" }, "documentStatus": { "type": "string", "x-aura-field-code": "documentStatus" }, "dueDateConfirmationStatus": { "type": "string", "x-aura-field-code": "dueDateConfirmationStatus" }, "dueStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "dueStartingDate" }, "explanations": { "type": "string", "x-aura-field-code": "explanations" }, "exportLCDeliveryDocumentList": { "type": "array", "items": { "type": "object", "properties": { "copyDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "copyDocumentCount" }, "deliveryDocumentType": { "type": "string", "x-aura-field-code": "deliveryDocumentType" }, "deliveryDocumentTypeName": { "type": "string", "x-aura-field-code": "deliveryDocumentTypeName" }, "deliveryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "deliveryOrder" }, "exportLCDocumentId": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "originalDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "originalDocumentCount" } }, "required": [ "copyDocumentCount", "deliveryDocumentType", "deliveryDocumentTypeName", "deliveryOrder", "exportLCDocumentId", "id", "invoiceDate", "invoiceNo", "originalDocumentCount" ], "x-aura-field-code": "exportLCDeliveryDocumentList" } }, "exportLCDocumentGoodsDetailList": { "type": "array", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "exportLCDocumentId": { "x-aura-type": "unresolved" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "x-aura-type": "unresolved" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "required": [ "currencyCode", "currentStatusOf45ADetail", "exportLCDocumentId", "goodsName", "id", "mT700Message45ADetail", "quantity", "totalValueOfGoods", "unit", "unitPrice" ], "x-aura-field-code": "exportLCDocumentGoodsDetailList" } }, "exportLCDocumentReserveList": { "type": "array", "items": { "type": "object", "properties": { "exportLCDocumentId": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" }, "isChecked": { "type": "boolean", "x-aura-field-code": "isChecked" }, "lcReserveENValue": { "type": "string", "x-aura-field-code": "lcReserveENValue" }, "lcReserveTRValue": { "type": "string", "x-aura-field-code": "lcReserveTRValue" } }, "required": [ "exportLCDocumentId", "id", "isChecked", "lcReserveENValue", "lcReserveTRValue" ], "x-aura-field-code": "exportLCDocumentReserveList" } }, "exportLCId": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLCId" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "isDocumentExamRequired": { "type": "boolean", "x-aura-field-code": "isDocumentExamRequired" }, "lcDocumentSwift34AMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift34AMessage" }, "lcDocumentSwift34BMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift34BMessage" }, "lcDocumentSwift71DMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift71DMessage" }, "lcDocumentSwift72ZMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift72ZMessage" }, "lcDocumentSwift73AMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift73AMessage" }, "lcDocumentSwift77JMessage": { "type": "string", "x-aura-field-code": "lcDocumentSwift77JMessage" }, "lcDocumentSwift77Message": { "type": "string", "x-aura-field-code": "lcDocumentSwift77Message" }, "lcDocumentSwift79Message": { "type": "string", "x-aura-field-code": "lcDocumentSwift79Message" }, "lcDocumentSwiftMessageType": { "type": "string", "x-aura-field-code": "lcDocumentSwiftMessageType" }, "loadingPort": { "type": "string", "x-aura-field-code": "loadingPort" }, "negotiationStatus": { "type": "string", "x-aura-field-code": "negotiationStatus" }, "notes": { "type": "string", "x-aura-field-code": "notes" }, "ourBankCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "ourBankCharge" }, "paymentDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "paymentDueDate" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "shipName": { "type": "string", "x-aura-field-code": "shipName" }, "shipperName": { "type": "string", "x-aura-field-code": "shipperName" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportLcDocumentStatus" } }, "required": [ "correspondentCharge", "demandedAmount", "dischargePort", "discrepancyStatus", "documentAmount", "documentEntryDate", "documentHolder", "documentNumber", "documentSender", "documentStatus", "dueDateConfirmationStatus", "dueStartingDate", "explanations", "exportLCDeliveryDocumentList", "exportLCDocumentGoodsDetailList", "exportLCDocumentReserveList", "exportLCId", "groupGuid", "isDocumentExamRequired", "lcDocumentSwift34AMessage", "lcDocumentSwift34BMessage", "lcDocumentSwift71DMessage", "lcDocumentSwift72ZMessage", "lcDocumentSwift73AMessage", "lcDocumentSwift77JMessage", "lcDocumentSwift77Message", "lcDocumentSwift79Message", "lcDocumentSwiftMessageType", "loadingPort", "negotiationStatus", "notes", "ourBankCharge", "paymentDueDate", "senderReference", "shipName", "shipperName", "status" ] } } } }, "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": 37, "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-export-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-documents/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentSender", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentHolder", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentEntryDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "DueStartingDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "OurBankCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipperName", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": null, "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Notes", "declared_type": null, "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDocumentExamRequired", "declared_type": null, "nullable": true, "collection": false }, { "name": "DiscrepancyStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "NegotiationStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "DueDateConfirmationStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportLCId", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift34AMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift34BMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift71DMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift77Message", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift72ZMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift73AMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift77JMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift79Message", "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_FRGN_TRD_46", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DOCUMENT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_51", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LETTER_CREDIT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "EXCEEDING_AVAILABLE_LC_AMOUNT" } ] } } }, "/export-lc-documents/{id}/add-due-date-confirmation": { "put": { "operationId": "set-export-lCDocument-add-due-date-confirmation", "tags": [ "export-lc-documents" ], "summary": "set-export-lCDocument-add-due-date-confirmation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "dueDateConfirmationStatus": { "type": "string", "x-aura-field-code": "dueDateConfirmationStatus" } }, "required": [ "dueDateConfirmationStatus" ] } } } }, "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": "set-export-lCDocument-add-due-date-confirmation", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-documents/{id}/add-due-date-confirmation", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DueDateConfirmationStatus", "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_FRGN_TRD_46", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DOCUMENT_NOT_FOUND" } ] } } }, "/export-lc-documents/{id}/status": { "post": { "operationId": "set-export-lCDocument-status", "tags": [ "export-lc-documents" ], "summary": "set-export-lCDocument-status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportLcDocumentStatus" } }, "required": [ "status" ] } } } }, "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": "set-export-lCDocument-status", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-lc-documents/{id}/status", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_46", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LC_DOCUMENT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_56", "status": 400, "message": null, "message_available": false, "constant_name": "ARGUMENT_CANNOT_BE_NULL_OR_EMPTY" }, { "code": "ERR_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_ARGUMENTS" } ] } } }, "/export-letter-credits": { "get": { "operationId": "get-export-letter-credit-list", "tags": [ "export-letter-credits" ], "summary": "get-export-letter-credit-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" } }, { "name": "transactionStartDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "transactionStartDate" } } ], "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. 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": "get-export-letter-credit-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-letter-credits", "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": "ExportLetterCreditDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DocumentaryCreditNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UpperTolerance", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LowerTolerance", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ApplicantNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicableRule", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DateOfExpiry", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "IssuingDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LCDueDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PlaceOfExpiry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdditionalAmountsNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantBankIdentifierCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraweePartyIdentifier", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IdentifierCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraftsNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MixedPaymentNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MixedPaymentDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartialShipmentCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TranshipmentCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Negotiation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ShipmentPeriodNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "GoodsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GoodsCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalGoodsAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DeliveryVehicle", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PlaceofFinalDestinationNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PlaceofTakinginChargeNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PortofDischargeNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PortofLoadingNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBeneficiaryNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBankOnlyNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargesNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AmountOfCharges", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Days", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PeriodforPresentationinDaysNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Instruction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequestedPartyIdentifier", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReimbursingBankPartyIdentifier", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdviseThroughPartyIdentifier", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendertoReceiverInformationNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionstothePayingNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdditionalConditionsMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentsRequiredMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipmentInfoMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IncomingMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsMailed", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "InstuctionFromTransferingBank", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstBeneficiary", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondBeneficiary", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsConfirmedByOurBank", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsNegotiable", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsRedClause", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RequestedChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "IsRedClauseIncluded", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RedClauseAmount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RelatedReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreAdviceRef", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableLCAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LCOpeningDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IsApplicantOurCustomer", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ApplicantCustomerNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsSwiftCreationAllowed", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferBankInstruction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Tolerance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ExportLCSwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCSwift57AMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCSwift71DMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DescriptionOfGoodsAndOrServices", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingSequenceOfTotalCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageContentTxt", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageContentHtml", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage", "declared_type": "SwiftOtherDto", "nullable": false, "collection": false }, { "name": "ExportLCGoodsDetailList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CollectionDocumentDataList", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-export-letter-credit", "tags": [ "export-letter-credits" ], "summary": "create-export-letter-credit", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "additionalAmountsNarrative": { "type": "string", "x-aura-field-code": "additionalAmountsNarrative" }, "additionalConditionsMessage": { "type": "string", "x-aura-field-code": "additionalConditionsMessage" }, "adviseThroughPartyIdentifier": { "type": "string", "x-aura-field-code": "adviseThroughPartyIdentifier" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "amountOfCharges": { "type": "number", "x-aura-field-code": "amountOfCharges" }, "applicableRule": { "type": "integer", "format": "int32", "x-aura-field-code": "applicableRule" }, "applicantBankIdentifierCode": { "type": "string", "x-aura-field-code": "applicantBankIdentifierCode" }, "applicantCountryCode": { "type": "string", "x-aura-field-code": "applicantCountryCode" }, "applicantCustomerNo": { "type": "integer", "format": "int32", "x-aura-field-code": "applicantCustomerNo" }, "applicantNameAndAddress": { "type": "string", "x-aura-field-code": "applicantNameAndAddress" }, "availableBICCode": { "type": "string", "x-aura-field-code": "availableBICCode" }, "availableLCAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "availableLCAmount" }, "beneficiaryNameAndAddress": { "type": "string", "x-aura-field-code": "beneficiaryNameAndAddress" }, "chargeDescription": { "type": "string", "x-aura-field-code": "chargeDescription" }, "chargesNarrative": { "type": "string", "x-aura-field-code": "chargesNarrative" }, "code": { "type": "string", "x-aura-field-code": "code" }, "collectionDocumentData": { "type": "array", "items": { "type": "object", "properties": { "collectionDocumentDate": { "type": "string", "x-aura-field-code": "collectionDocumentDate" }, "collectionDocumentNumber": { "type": "string", "x-aura-field-code": "collectionDocumentNumber" }, "collectionDocumentType": { "type": "string", "x-aura-field-code": "collectionDocumentType" }, "collectionNumberOfCopies": { "type": "string", "x-aura-field-code": "collectionNumberOfCopies" }, "collectionNumberOfOriginals": { "type": "string", "x-aura-field-code": "collectionNumberOfOriginals" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "exportDocumentId": { "type": "string", "x-aura-field-code": "exportDocumentId" }, "exportLetterCreditId": { "type": "string", "x-aura-field-code": "exportLetterCreditId" }, "id": { "type": "string", "x-aura-field-code": "exportLetterCreditId" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" }, "importLetterCreditId": { "type": "string", "x-aura-field-code": "importLetterCreditId" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "x-aura-field-code": "collectionDocumentData" } }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "dateOfExpiry": { "type": "string", "x-aura-field-code": "dateOfExpiry" }, "dateOfIssue": { "type": "string", "x-aura-field-code": "dateOfIssue" }, "days": { "type": "integer", "format": "int32", "x-aura-field-code": "days" }, "deliveryVehicle": { "type": "string", "x-aura-field-code": "deliveryVehicle" }, "descriptionOfGoodsAndOrServices": { "type": "string", "x-aura-field-code": "descriptionOfGoodsAndOrServices" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "documentaryCreditNumber": { "type": "string", "x-aura-field-code": "documentaryCreditNumber" }, "documentsRequiredMessage": { "type": "string", "x-aura-field-code": "documentsRequiredMessage" }, "draftsNarrative": { "type": "string", "x-aura-field-code": "draftsNarrative" }, "draweePartyIdentifier": { "type": "string", "x-aura-field-code": "draweePartyIdentifier" }, "explanation": { "type": "string", "x-aura-field-code": "explanation" }, "explanations": { "type": "string", "x-aura-field-code": "explanations" }, "exportLCGoodsDetail": { "type": "array", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "exportLCDocumentId": { "type": "string", "x-aura-field-code": "exportLCDocumentId" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "type": "integer", "format": "int32", "x-aura-field-code": "quantity" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "type": "integer", "format": "int32", "x-aura-field-code": "unit" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "x-aura-field-code": "exportLCGoodsDetail" } }, "exportLCSwift57AMessage": { "type": "string", "x-aura-field-code": "exportLCSwift57AMessage" }, "exportLCSwift71DMessage": { "type": "string", "x-aura-field-code": "exportLCSwift71DMessage" }, "exportLCSwiftMessageType": { "type": "string", "x-aura-field-code": "exportLCSwiftMessageType" }, "firstBeneficiary": { "type": "string", "x-aura-field-code": "firstBeneficiary" }, "goodsCurrency": { "type": "string", "x-aura-field-code": "goodsCurrency" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "identifierCode": { "type": "string", "x-aura-field-code": "identifierCode" }, "incomingMessageType": { "type": "string", "x-aura-field-code": "incomingMessageType" }, "instruction": { "type": "string", "x-aura-field-code": "instruction" }, "instructionstothePayingNarrative": { "type": "string", "x-aura-field-code": "instructionstothePayingNarrative" }, "instuctionFromTransferingBank": { "type": "string", "x-aura-field-code": "instuctionFromTransferingBank" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "isApplicantOurCustomer": { "type": "boolean", "x-aura-field-code": "isApplicantOurCustomer" }, "isConfirmedByOurBank": { "type": "string", "x-aura-field-code": "isConfirmedByOurBank" }, "isMailed": { "type": "boolean", "x-aura-field-code": "isMailed" }, "isNegotiable": { "type": "boolean", "x-aura-field-code": "isNegotiable" }, "isRedClause": { "type": "boolean", "x-aura-field-code": "isRedClause" }, "isRedClauseIncluded": { "type": "boolean", "x-aura-field-code": "isRedClauseIncluded" }, "isSwiftCreationAllowed": { "type": "boolean", "x-aura-field-code": "isSwiftCreationAllowed" }, "issuingDate": { "type": "string", "x-aura-field-code": "issuingDate" }, "lCDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lCDueDate" }, "lCOpeningDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lCOpeningDate" }, "latestDateofShipment": { "type": "string", "x-aura-field-code": "latestDateofShipment" }, "lowerTolerance": { "type": "integer", "format": "int32", "x-aura-field-code": "lowerTolerance" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "mixedPaymentDetails": { "type": "string", "x-aura-field-code": "mixedPaymentDetails" }, "mixedPaymentNarrative": { "type": "string", "x-aura-field-code": "mixedPaymentNarrative" }, "negotiation": { "type": "string", "x-aura-field-code": "negotiation" }, "partialShipmentCode": { "type": "string", "x-aura-field-code": "partialShipmentCode" }, "periodforPresentationinDaysNarrative": { "type": "string", "x-aura-field-code": "periodforPresentationinDaysNarrative" }, "placeOfExpiry": { "type": "string", "x-aura-field-code": "placeOfExpiry" }, "placeofFinalDestinationNarrative": { "type": "string", "x-aura-field-code": "placeofFinalDestinationNarrative" }, "placeofTakinginChargeNarrative": { "type": "string", "x-aura-field-code": "placeofTakinginChargeNarrative" }, "portofDischargeNarrative": { "type": "string", "x-aura-field-code": "portofDischargeNarrative" }, "portofLoadingNarrative": { "type": "string", "x-aura-field-code": "portofLoadingNarrative" }, "preAdviceRef": { "type": "string", "x-aura-field-code": "preAdviceRef" }, "quantity": { "type": "integer", "format": "int32", "x-aura-field-code": "quantity" }, "redClauseAmount": { "type": "integer", "format": "int32", "x-aura-field-code": "redClauseAmount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "reimbursingBankPartyIdentifier": { "type": "string", "x-aura-field-code": "reimbursingBankPartyIdentifier" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "remainingSequenceOfTotalCount": { "type": "integer", "format": "int32", "x-aura-field-code": "remainingSequenceOfTotalCount" }, "requestedChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedChargeAmount" }, "requestedPartyIdentifier": { "type": "string", "x-aura-field-code": "requestedPartyIdentifier" }, "secondBeneficiary": { "type": "string", "x-aura-field-code": "secondBeneficiary" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "sendertoReceiverInformationNarrative": { "type": "string", "x-aura-field-code": "sendertoReceiverInformationNarrative" }, "shipmentInfoMessage": { "type": "string", "x-aura-field-code": "shipmentInfoMessage" }, "shipmentPeriodNarrative": { "type": "string", "x-aura-field-code": "shipmentPeriodNarrative" }, "specialPaymentConditionsforBankOnlyNarrative": { "type": "string", "x-aura-field-code": "specialPaymentConditionsforBankOnlyNarrative" }, "specialPaymentConditionsforBeneficiaryNarrative": { "type": "string", "x-aura-field-code": "specialPaymentConditionsforBeneficiaryNarrative" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportLetterCreditStatus" }, "tolerance": { "type": "number", "x-aura-field-code": "tolerance" }, "totalGoodsAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalGoodsAmount" }, "transferBankBICCode": { "type": "string", "x-aura-field-code": "transferBankBICCode" }, "transferBankInstruction": { "type": "string", "x-aura-field-code": "transferBankInstruction" }, "transhipmentCode": { "type": "string", "x-aura-field-code": "transhipmentCode" }, "type": { "type": "string", "x-aura-field-code": "type" }, "unit": { "type": "integer", "format": "int32", "x-aura-field-code": "unit" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" }, "upperTolerance": { "type": "integer", "format": "int32", "x-aura-field-code": "upperTolerance" } } } } } }, "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": 99, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-letter-credits", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/export-letter-credits/maturity-tracking": { "get": { "operationId": "get-export-lc-maturity-tracking", "tags": [ "export-letter-credits" ], "summary": "get-export-lc-maturity-tracking", "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. 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": "get-export-lc-maturity-tracking", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-letter-credits/maturity-tracking", "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 }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentAmountStart", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentAmountEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "DemandedAmountStart", "declared_type": null, "nullable": false, "collection": false }, { "name": "DemandedAmountEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentDueDateStart", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDueDateEnd", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentEntryDateStart", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentEntryDateEnd", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentStatus", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "ExportLCMaturityTrackingDto", "collection": true, "members": [ { "name": "ExportLCDocumentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentEntryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DocumentNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentDueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DocumentStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PaymentStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/export-letter-credits/preview-mt700": { "post": { "operationId": "preview-mt-export-letter-credits", "tags": [ "export-letter-credits" ], "summary": "preview-mt-export-letter-credits", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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": "preview-mt-export-letter-credits", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-letter-credits/preview-mt700", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PreviewMT700Response", "payload": "PreviewMT700Response", "collection": false, "members": [ { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsValid", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "Errors", "declared_type": "List", "nullable": false, "collection": true }, { "name": "Warnings", "declared_type": "List", "nullable": false, "collection": true } ], "naming": "Member names are the service's declaration names." } } }, "/export-letter-credits/{id}": { "delete": { "operationId": "delete-export-letter-credit", "tags": [ "export-letter-credits" ], "summary": "delete-export-letter-credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportLetterCreditId" } } ], "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-export-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-letter-credits/{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_FRGN_TRD_51", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LETTER_CREDIT_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-letter-credit-by-id", "tags": [ "export-letter-credits" ], "summary": "get-export-letter-credit-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportLetterCreditId" } } ], "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-export-letter-credit-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-letter-credits/{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": "ExportLetterCreditDto", "payload": "ExportLetterCreditDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DocumentaryCreditNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UpperTolerance", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "LowerTolerance", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ApplicantNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Type", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicableRule", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DateOfIssue", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "DateOfExpiry", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "IssuingDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "LCDueDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "PlaceOfExpiry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdditionalAmountsNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ApplicantBankIdentifierCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraweePartyIdentifier", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IdentifierCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Code", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DraftsNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MixedPaymentNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MixedPaymentDetails", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PartialShipmentCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TranshipmentCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Negotiation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ShipmentPeriodNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "GoodsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GoodsCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalGoodsAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DeliveryVehicle", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PlaceofFinalDestinationNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PlaceofTakinginChargeNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PortofDischargeNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PortofLoadingNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBeneficiaryNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBankOnlyNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargesNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AmountOfCharges", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "Days", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PeriodforPresentationinDaysNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Instruction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RequestedPartyIdentifier", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReimbursingBankPartyIdentifier", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdviseThroughPartyIdentifier", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendertoReceiverInformationNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionstothePayingNarrative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AdditionalConditionsMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentsRequiredMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipmentInfoMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IncomingMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsMailed", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "InstuctionFromTransferingBank", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FirstBeneficiary", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SecondBeneficiary", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsConfirmedByOurBank", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsNegotiable", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IsRedClause", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RequestedChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "IsRedClauseIncluded", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "RedClauseAmount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "RelatedReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreAdviceRef", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvailableLCAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "LCOpeningDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IsApplicantOurCustomer", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ApplicantCustomerNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "IsSwiftCreationAllowed", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameAndAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferBankInstruction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Tolerance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "ExportLCSwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCSwift57AMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportLCSwift71DMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DescriptionOfGoodsAndOrServices", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingSequenceOfTotalCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageContentTxt", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageContentHtml", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage", "declared_type": "SwiftOtherDto", "nullable": false, "collection": false }, { "name": "ExportLCGoodsDetailList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "CollectionDocumentDataList", "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 }, "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_FRGN_TRD_51", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LETTER_CREDIT_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-letter-credit", "tags": [ "export-letter-credits" ], "summary": "update-export-letter-credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "additionalAmountsNarrative": { "type": "string", "x-aura-field-code": "additionalAmountsNarrative" }, "additionalConditionsMessage": { "type": "string", "x-aura-field-code": "additionalConditionsMessage" }, "adviseThroughPartyIdentifier": { "type": "string", "x-aura-field-code": "adviseThroughPartyIdentifier" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "amountOfCharges": { "type": "number", "x-aura-field-code": "amountOfCharges" }, "applicableRule": { "type": "integer", "format": "int32", "x-aura-field-code": "applicableRule" }, "applicantBankIdentifierCode": { "type": "string", "x-aura-field-code": "applicantBankIdentifierCode" }, "applicantCountryCode": { "type": "string", "x-aura-field-code": "applicantCountryCode" }, "applicantCustomerNo": { "type": "integer", "format": "int32", "x-aura-field-code": "applicantCustomerNo" }, "applicantNameAndAddress": { "type": "string", "x-aura-field-code": "applicantNameAndAddress" }, "availableBICCode": { "type": "string", "x-aura-field-code": "availableBICCode" }, "availableLCAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "availableLCAmount" }, "beneficiaryNameAndAddress": { "type": "string", "x-aura-field-code": "beneficiaryNameAndAddress" }, "chargeDescription": { "type": "string", "x-aura-field-code": "chargeDescription" }, "chargesNarrative": { "type": "string", "x-aura-field-code": "chargesNarrative" }, "code": { "type": "string", "x-aura-field-code": "code" }, "collectionDocumentDataList": { "type": "array", "items": { "type": "object", "properties": { "collectionDocumentDate": { "type": "string", "x-aura-field-code": "collectionDocumentDate" }, "collectionDocumentNumber": { "type": "string", "x-aura-field-code": "collectionDocumentNumber" }, "collectionDocumentType": { "type": "string", "x-aura-field-code": "collectionDocumentType" }, "collectionNumberOfCopies": { "type": "string", "x-aura-field-code": "collectionNumberOfCopies" }, "collectionNumberOfOriginals": { "type": "string", "x-aura-field-code": "collectionNumberOfOriginals" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "exportDocumentId": { "type": "string", "x-aura-field-code": "exportDocumentId" }, "exportLetterCreditId": { "type": "string", "x-aura-field-code": "exportLetterCreditId" }, "id": { "type": "string", "x-aura-field-code": "exportLetterCreditId" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" }, "importLetterCreditId": { "type": "string", "x-aura-field-code": "importLetterCreditId" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "required": [ "collectionDocumentDate", "collectionDocumentNumber", "collectionDocumentType", "collectionNumberOfCopies", "collectionNumberOfOriginals", "collectionType", "exportDocumentId", "exportLetterCreditId", "id", "importDocumentId", "importLetterCreditId", "reference" ], "x-aura-field-code": "collectionDocumentDataList" } }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "dateOfExpiry": { "type": "string", "x-aura-field-code": "dateOfExpiry" }, "dateOfIssue": { "type": "string", "x-aura-field-code": "dateOfIssue" }, "days": { "type": "integer", "format": "int32", "x-aura-field-code": "days" }, "deliveryVehicle": { "type": "string", "x-aura-field-code": "deliveryVehicle" }, "descriptionOfGoodsAndOrServices": { "type": "string", "x-aura-field-code": "descriptionOfGoodsAndOrServices" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "documentaryCreditNumber": { "type": "string", "x-aura-field-code": "documentaryCreditNumber" }, "documentsRequiredMessage": { "type": "string", "x-aura-field-code": "documentsRequiredMessage" }, "draftsNarrative": { "type": "string", "x-aura-field-code": "draftsNarrative" }, "draweePartyIdentifier": { "type": "string", "x-aura-field-code": "draweePartyIdentifier" }, "explanation": { "type": "string", "x-aura-field-code": "explanation" }, "explanations": { "type": "string", "x-aura-field-code": "explanations" }, "exportLCGoodsDetailList": { "type": "array", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "exportLCDocumentId": { "type": "string", "x-aura-field-code": "exportLCDocumentId" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "id": { "type": "string", "x-aura-field-code": "exportLetterCreditId" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "type": "integer", "format": "int32", "x-aura-field-code": "quantity" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "type": "integer", "format": "int32", "x-aura-field-code": "unit" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "required": [ "currencyCode", "currentStatusOf45ADetail", "exportLCDocumentId", "goodsName", "id", "mT700Message45ADetail", "quantity", "totalValueOfGoods", "unit", "unitPrice" ], "x-aura-field-code": "exportLCGoodsDetailList" } }, "exportLCSwift57AMessage": { "type": "string", "x-aura-field-code": "exportLCSwift57AMessage" }, "exportLCSwift71DMessage": { "type": "string", "x-aura-field-code": "exportLCSwift71DMessage" }, "exportLCSwiftMessageType": { "type": "string", "x-aura-field-code": "exportLCSwiftMessageType" }, "firstBeneficiary": { "type": "string", "x-aura-field-code": "firstBeneficiary" }, "goodsCurrency": { "type": "string", "x-aura-field-code": "goodsCurrency" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "identifierCode": { "type": "string", "x-aura-field-code": "identifierCode" }, "incomingMessageType": { "type": "string", "x-aura-field-code": "incomingMessageType" }, "instruction": { "type": "string", "x-aura-field-code": "instruction" }, "instructionstothePayingNarrative": { "type": "string", "x-aura-field-code": "instructionstothePayingNarrative" }, "instuctionFromTransferingBank": { "type": "string", "x-aura-field-code": "instuctionFromTransferingBank" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "isApplicantOurCustomer": { "type": "boolean", "x-aura-field-code": "isApplicantOurCustomer" }, "isConfirmedByOurBank": { "type": "string", "x-aura-field-code": "isConfirmedByOurBank" }, "isMailed": { "type": "boolean", "x-aura-field-code": "isMailed" }, "isNegotiable": { "type": "boolean", "x-aura-field-code": "isNegotiable" }, "isRedClause": { "type": "boolean", "x-aura-field-code": "isRedClause" }, "isRedClauseIncluded": { "type": "boolean", "x-aura-field-code": "isRedClauseIncluded" }, "isSwiftCreationAllowed": { "type": "boolean", "x-aura-field-code": "isSwiftCreationAllowed" }, "issuingDate": { "type": "string", "x-aura-field-code": "issuingDate" }, "lCDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lCDueDate" }, "lCOpeningDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lCOpeningDate" }, "latestDateofShipment": { "type": "string", "x-aura-field-code": "latestDateofShipment" }, "lowerTolerance": { "type": "integer", "format": "int32", "x-aura-field-code": "lowerTolerance" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "mixedPaymentDetails": { "type": "string", "x-aura-field-code": "mixedPaymentDetails" }, "mixedPaymentNarrative": { "type": "string", "x-aura-field-code": "mixedPaymentNarrative" }, "negotiation": { "type": "string", "x-aura-field-code": "negotiation" }, "partialShipmentCode": { "type": "string", "x-aura-field-code": "partialShipmentCode" }, "periodforPresentationinDaysNarrative": { "type": "string", "x-aura-field-code": "periodforPresentationinDaysNarrative" }, "placeOfExpiry": { "type": "string", "x-aura-field-code": "placeOfExpiry" }, "placeofFinalDestinationNarrative": { "type": "string", "x-aura-field-code": "placeofFinalDestinationNarrative" }, "placeofTakinginChargeNarrative": { "type": "string", "x-aura-field-code": "placeofTakinginChargeNarrative" }, "portofDischargeNarrative": { "type": "string", "x-aura-field-code": "portofDischargeNarrative" }, "portofLoadingNarrative": { "type": "string", "x-aura-field-code": "portofLoadingNarrative" }, "preAdviceRef": { "type": "string", "x-aura-field-code": "preAdviceRef" }, "quantity": { "type": "integer", "format": "int32", "x-aura-field-code": "quantity" }, "redClauseAmount": { "type": "integer", "format": "int32", "x-aura-field-code": "redClauseAmount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "reimbursingBankPartyIdentifier": { "type": "string", "x-aura-field-code": "reimbursingBankPartyIdentifier" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "remainingSequenceOfTotalCount": { "type": "integer", "format": "int32", "x-aura-field-code": "remainingSequenceOfTotalCount" }, "requestedChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "requestedChargeAmount" }, "requestedPartyIdentifier": { "type": "string", "x-aura-field-code": "requestedPartyIdentifier" }, "secondBeneficiary": { "type": "string", "x-aura-field-code": "secondBeneficiary" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "sendertoReceiverInformationNarrative": { "type": "string", "x-aura-field-code": "sendertoReceiverInformationNarrative" }, "shipmentInfoMessage": { "type": "string", "x-aura-field-code": "shipmentInfoMessage" }, "shipmentPeriodNarrative": { "type": "string", "x-aura-field-code": "shipmentPeriodNarrative" }, "specialPaymentConditionsforBankOnlyNarrative": { "type": "string", "x-aura-field-code": "specialPaymentConditionsforBankOnlyNarrative" }, "specialPaymentConditionsforBeneficiaryNarrative": { "type": "string", "x-aura-field-code": "specialPaymentConditionsforBeneficiaryNarrative" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportLetterCreditStatus" }, "tolerance": { "type": "number", "x-aura-field-code": "tolerance" }, "totalGoodsAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalGoodsAmount" }, "transferBankBICCode": { "type": "string", "x-aura-field-code": "transferBankBICCode" }, "transferBankInstruction": { "type": "string", "x-aura-field-code": "transferBankInstruction" }, "transhipmentCode": { "type": "string", "x-aura-field-code": "transhipmentCode" }, "type": { "type": "string", "x-aura-field-code": "type" }, "unit": { "type": "integer", "format": "int32", "x-aura-field-code": "unit" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" }, "upperTolerance": { "type": "integer", "format": "int32", "x-aura-field-code": "upperTolerance" } }, "required": [ "accountNumber", "additionalAmountsNarrative", "additionalConditionsMessage", "adviseThroughPartyIdentifier", "amount", "amountOfCharges", "applicableRule", "applicantBankIdentifierCode", "applicantCountryCode", "applicantCustomerNo", "applicantNameAndAddress", "availableBICCode", "availableLCAmount", "beneficiaryNameAndAddress", "chargeDescription", "chargesNarrative", "code", "collectionDocumentDataList", "correspondentBankBICCode", "currency", "customerId", "customerName", "dateOfExpiry", "dateOfIssue", "days", "deliveryVehicle", "descriptionOfGoodsAndOrServices", "documentType", "documentaryCreditNumber", "documentsRequiredMessage", "draftsNarrative", "draweePartyIdentifier", "explanation", "explanations", "exportLCGoodsDetailList", "exportLCSwift57AMessage", "exportLCSwift71DMessage", "exportLCSwiftMessageType", "firstBeneficiary", "goodsCurrency", "goodsName", "groupGuid", "identifierCode", "incomingMessageType", "instruction", "instructionstothePayingNarrative", "instuctionFromTransferingBank", "invoiceDate", "invoiceNo", "isApplicantOurCustomer", "isConfirmedByOurBank", "isMailed", "isNegotiable", "isRedClause", "isRedClauseIncluded", "isSwiftCreationAllowed", "issuingDate", "lCDueDate", "lCOpeningDate", "latestDateofShipment", "lowerTolerance", "messageContentHtml", "messageContentTxt", "mixedPaymentDetails", "mixedPaymentNarrative", "negotiation", "partialShipmentCode", "periodforPresentationinDaysNarrative", "placeOfExpiry", "placeofFinalDestinationNarrative", "placeofTakinginChargeNarrative", "portofDischargeNarrative", "portofLoadingNarrative", "preAdviceRef", "quantity", "redClauseAmount", "reference", "reimbursingBankPartyIdentifier", "relatedReference", "remainingSequenceOfTotalCount", "requestedChargeAmount", "requestedPartyIdentifier", "secondBeneficiary", "senderBankBICCode", "sendertoReceiverInformationNarrative", "shipmentInfoMessage", "shipmentPeriodNarrative", "specialPaymentConditionsforBankOnlyNarrative", "specialPaymentConditionsforBeneficiaryNarrative", "status", "tolerance", "totalGoodsAmount", "transferBankBICCode", "transferBankInstruction", "transhipmentCode", "type", "unit", "unitPrice", "upperTolerance" ] } } } }, "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": 99, "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-export-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-letter-credits/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentaryCreditNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UpperTolerance", "declared_type": null, "nullable": true, "collection": false }, { "name": "LowerTolerance", "declared_type": null, "nullable": true, "collection": false }, { "name": "ApplicantNameAndAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicantCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Type", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRule", "declared_type": null, "nullable": true, "collection": false }, { "name": "DateOfIssue", "declared_type": null, "nullable": true, "collection": false }, { "name": "DateOfExpiry", "declared_type": null, "nullable": true, "collection": false }, { "name": "IssuingDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "LCDueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PlaceOfExpiry", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdditionalAmountsNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicantBankIdentifierCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraweePartyIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentifierCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraftsNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "MixedPaymentNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "MixedPaymentDetails", "declared_type": null, "nullable": false, "collection": false }, { "name": "PartialShipmentCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TranshipmentCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Negotiation", "declared_type": null, "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": null, "nullable": true, "collection": false }, { "name": "ShipmentPeriodNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "GoodsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": true, "collection": false }, { "name": "GoodsCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalGoodsAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryVehicle", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PlaceofFinalDestinationNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "PlaceofTakinginChargeNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "PortofDischargeNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "PortofLoadingNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBeneficiaryNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBankOnlyNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargesNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "AmountOfCharges", "declared_type": null, "nullable": true, "collection": false }, { "name": "Days", "declared_type": null, "nullable": true, "collection": false }, { "name": "PeriodforPresentationinDaysNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "Instruction", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequestedPartyIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReimbursingBankPartyIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdviseThroughPartyIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendertoReceiverInformationNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionstothePayingNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdditionalConditionsMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentsRequiredMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipmentInfoMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "IncomingMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsMailed", "declared_type": null, "nullable": true, "collection": false }, { "name": "InstuctionFromTransferingBank", "declared_type": null, "nullable": false, "collection": false }, { "name": "FirstBeneficiary", "declared_type": null, "nullable": false, "collection": false }, { "name": "SecondBeneficiary", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsConfirmedByOurBank", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsNegotiable", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsRedClause", "declared_type": null, "nullable": true, "collection": false }, { "name": "RequestedChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsRedClauseIncluded", "declared_type": null, "nullable": true, "collection": false }, { "name": "RedClauseAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RelatedReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreAdviceRef", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableLCAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "LCOpeningDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsApplicantOurCustomer", "declared_type": null, "nullable": true, "collection": false }, { "name": "ApplicantCustomerNo", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsSwiftCreationAllowed", "declared_type": null, "nullable": true, "collection": false }, { "name": "Explanation", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameAndAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferBankInstruction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Tolerance", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExportLCSwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportLCSwift57AMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportLCSwift71DMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "DescriptionOfGoodsAndOrServices", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemainingSequenceOfTotalCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageContentTxt", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageContentHtml", "declared_type": null, "nullable": false, "collection": false }, { "name": "Explanations", "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_FRGN_TRD_51", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LETTER_CREDIT_NOT_FOUND" } ] } } }, "/export-letter-credits/{id}/status": { "put": { "operationId": "set-export-letter-credit-status", "tags": [ "export-letter-credits" ], "summary": "set-export-letter-credit-status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "exportLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportLetterCreditStatus" } }, "required": [ "status" ] } } } }, "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": "set-export-letter-credit-status", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-letter-credits/{id}/status", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_51", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_LETTER_CREDIT_NOT_FOUND" } ] } } }, "/export-payment-acceptance-usings": { "get": { "operationId": "get-all-export-payment-acceptance-using", "tags": [ "export-payment-acceptance-usings" ], "summary": "get-all-export-payment-acceptance-using", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-all-export-payment-acceptance-using", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptance-usings", "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": "ExportPaymentAcceptanceUsingDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ExportPaymentAcceptanceId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UsingId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "UsingReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UsingDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "UsingAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-export-payment-acceptance-using", "tags": [ "export-payment-acceptance-usings" ], "summary": "create-export-payment-acceptance-using", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "x-aura-field-code": "currency" }, "exportPaymentAcceptanceId": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentAcceptanceId" }, "usingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usingAmount" }, "usingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "usingDate" }, "usingId": { "type": "integer", "format": "int32", "x-aura-field-code": "usingId" }, "usingReference": { "type": "string", "x-aura-field-code": "usingReference" } }, "required": [ "currency", "exportPaymentAcceptanceId", "usingAmount", "usingDate", "usingId", "usingReference" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-payment-acceptance-using", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptance-usings", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ExportPaymentAcceptanceId", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsingId", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsingReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsingDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsingAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/export-payment-acceptance-usings/get-available-amount": { "get": { "operationId": "get-available-amount", "tags": [ "export-payment-acceptance-usings" ], "summary": "get-available-amount", "parameters": [ { "name": "fxEntryMethod", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "fxEntryMethod" } }, { "name": "usingReference", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "usingReference" } } ], "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": 2 }, "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": "get-available-amount", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptance-usings/get-available-amount", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "UsingReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "FxEntryMethod", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `decimal`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON number. This is a complete answer read from the declaration, not a gap.", "declared_type": "decimal", "payload": "decimal" } } }, "/export-payment-acceptance-usings/{id}": { "delete": { "operationId": "delete-export-payment-acceptance-using", "tags": [ "export-payment-acceptance-usings" ], "summary": "delete-export-payment-acceptance-using", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentAcceptanceUsingId" } } ], "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-export-payment-acceptance-using", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptance-usings/{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_FRGN_TRD_39", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_ACCEPTANCE_USING_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-payment-acceptance-using-by-id", "tags": [ "export-payment-acceptance-usings" ], "summary": "get-export-payment-acceptance-using-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentAcceptanceUsingId" } } ], "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-export-payment-acceptance-using-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptance-usings/{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": "ExportPaymentAcceptanceUsingDto", "payload": "ExportPaymentAcceptanceUsingDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ExportPaymentAcceptanceId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "UsingId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "UsingReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UsingDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "UsingAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "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_FRGN_TRD_39", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_ACCEPTANCE_USING_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-payment-acceptance-using", "tags": [ "export-payment-acceptance-usings" ], "summary": "update-export-payment-acceptance-using", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentAcceptanceUsingId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currency": { "type": "string", "x-aura-field-code": "currency" }, "usingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usingAmount" }, "usingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "usingDate" }, "usingId": { "type": "integer", "format": "int32", "x-aura-field-code": "usingId" }, "usingReference": { "type": "string", "x-aura-field-code": "usingReference" } }, "required": [ "currency", "usingAmount", "usingDate", "usingId", "usingReference" ] } } } }, "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. 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-export-payment-acceptance-using", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptance-usings/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsingId", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsingReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsingDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "UsingAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "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_FRGN_TRD_39", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_ACCEPTANCE_USING_NOT_FOUND" } ] } } }, "/export-payment-acceptances": { "get": { "operationId": "get-export-payment-acceptance-list", "tags": [ "export-payment-acceptances" ], "summary": "get-export-payment-acceptance-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-export-payment-acceptance-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptances", "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": "ExportPaymentAcceptanceDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FxEntryMethod", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FxAccountNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TLAccountNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TCMBCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TCMBHourlyRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TLAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencySupport", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomDeclarationCheck", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomDeclarationProcessAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DiscountAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DiscountCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DiscountDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DiscountReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LiableBankId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PercentageOfSell", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TCMBSalesAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ExportCustomDeclarationInquiryId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportCustomDeclarationInquiryId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportCustomsSumInvoiceAmountUsd", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ImportCustomsSumInvoiceAmountUsd", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencySupportAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportCustomsDeclerationComponentId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ImportCustomsDeclerationComponentId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CreatedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ModifiedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportPaymentAcceptanceUsings", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-export-payment-acceptance", "tags": [ "export-payment-acceptances" ], "summary": "create-export-payment-acceptance", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "currencySupport": { "type": "boolean", "x-aura-field-code": "currencySupport" }, "currencySupportAmount": { "type": "number", "x-aura-field-code": "currencySupportAmount" }, "customDeclarationCheck": { "type": "boolean", "x-aura-field-code": "customDeclarationCheck" }, "customDeclarationProcessAmount": { "type": "number", "x-aura-field-code": "customDeclarationProcessAmount" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "description": { "type": "string", "x-aura-field-code": "description" }, "discountAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "discountAmount" }, "discountCurrency": { "type": "string", "x-aura-field-code": "discountCurrency" }, "discountDate": { "type": "string", "x-aura-field-code": "discountDate" }, "discountReason": { "type": "string", "x-aura-field-code": "discountReason" }, "exportCustomDeclarationInquiryId": { "type": "string", "x-aura-field-code": "exportCustomDeclarationInquiryId" }, "exportCustomsDeclerationComponentId": { "type": "integer", "format": "int32", "x-aura-field-code": "exportCustomsDeclerationComponentId" }, "exportCustomsSumInvoiceAmountUsd": { "type": "number", "x-aura-field-code": "exportCustomsSumInvoiceAmountUsd" }, "fxAccountNo": { "type": "number", "x-aura-field-code": "fxAccountNo" }, "fxEntryMethod": { "type": "string", "x-aura-field-code": "fxEntryMethod" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importCustomDeclarationInquiryId": { "type": "string", "x-aura-field-code": "importCustomDeclarationInquiryId" }, "importCustomsDeclerationComponentId": { "type": "integer", "format": "int32", "x-aura-field-code": "importCustomsDeclerationComponentId" }, "importCustomsSumInvoiceAmountUsd": { "type": "number", "x-aura-field-code": "importCustomsSumInvoiceAmountUsd" }, "liableBankId": { "type": "string", "x-aura-field-code": "liableBankId" }, "percentageOfSell": { "type": "number", "x-aura-field-code": "percentageOfSell" }, "tCMBCurrency": { "type": "string", "x-aura-field-code": "tCMBCurrency" }, "tCMBHourlyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "tCMBHourlyRate" }, "tCMBSalesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "tCMBSalesAmount" }, "tLAccountNo": { "type": "integer", "format": "int32", "x-aura-field-code": "tLAccountNo" }, "tLAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "tLAmount" } } } } } }, "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": 29, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-payment-acceptance", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptances", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FxEntryMethod", "declared_type": null, "nullable": false, "collection": false }, { "name": "FxAccountNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "TLAccountNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "TCMBCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TCMBHourlyRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "TLAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportCustomDeclarationInquiryId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportCustomDeclarationInquiryId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "PercentageOfSell", "declared_type": null, "nullable": false, "collection": false }, { "name": "TCMBSalesAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencySupportAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomDeclarationProcessAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DiscountDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencySupport", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomDeclarationCheck", "declared_type": null, "nullable": false, "collection": false }, { "name": "LiableBankId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DiscountAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DiscountCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportCustomsSumInvoiceAmountUsd", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportCustomsSumInvoiceAmountUsd", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "DiscountReason", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportCustomsDeclerationComponentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ImportCustomsDeclerationComponentId", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/export-payment-acceptances/get-used-amount": { "get": { "operationId": "get-used-amount-for-custom-declaration", "tags": [ "export-payment-acceptances" ], "summary": "get-used-amount-for-custom-declaration", "parameters": [ { "name": "customDeclarationInquiryId", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "customDeclarationInquiryId" } } ], "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": 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": "get-used-amount-for-custom-declaration", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptances/get-used-amount", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomDeclarationInquiryId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "declared-non-dto", "note": "The route returns `decimal`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON number. This is a complete answer read from the declaration, not a gap.", "declared_type": "decimal", "payload": "decimal" } } }, "/export-payment-acceptances/{id}": { "delete": { "operationId": "delete-export-payment-acceptance", "tags": [ "export-payment-acceptances" ], "summary": "delete-export-payment-acceptance", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentAcceptanceId" } } ], "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-export-payment-acceptance", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptances/{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_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_ACCEPTANCE_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-payment-acceptance-by-id", "tags": [ "export-payment-acceptances" ], "summary": "get-export-payment-acceptance-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentAcceptanceId" } } ], "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-export-payment-acceptance-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptances/{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": "ExportPaymentAcceptanceDto", "payload": "ExportPaymentAcceptanceDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FxEntryMethod", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FxAccountNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TLAccountNo", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "TCMBCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TCMBHourlyRate", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TLAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencySupport", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomDeclarationCheck", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "CustomDeclarationProcessAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DiscountAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DiscountCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DiscountDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DiscountReason", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LiableBankId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PercentageOfSell", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TCMBSalesAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ExportCustomDeclarationInquiryId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportCustomDeclarationInquiryId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportCustomsSumInvoiceAmountUsd", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ImportCustomsSumInvoiceAmountUsd", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencySupportAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportCustomsDeclerationComponentId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ImportCustomsDeclerationComponentId", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CreatedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ModifiedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExportPaymentAcceptanceUsings", "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 }, "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_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_ACCEPTANCE_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-payment-acceptance", "tags": [ "export-payment-acceptances" ], "summary": "update-export-payment-acceptance", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentAcceptanceId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "currencySupport": { "type": "boolean", "x-aura-field-code": "currencySupport" }, "currencySupportAmount": { "x-aura-type": "unresolved" }, "customDeclarationCheck": { "type": "boolean", "x-aura-field-code": "customDeclarationCheck" }, "customDeclarationProcessAmount": { "x-aura-type": "unresolved" }, "description": { "x-aura-type": "unresolved" }, "discountAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "discountAmount" }, "discountCurrency": { "type": "string", "x-aura-field-code": "discountCurrency" }, "discountDate": { "x-aura-type": "unresolved" }, "discountReason": { "type": "string", "x-aura-field-code": "discountReason" }, "exportCustomDeclarationInquiryId": { "type": "string", "x-aura-field-code": "exportCustomDeclarationInquiryId" }, "exportCustomsDeclerationComponentId": { "type": "integer", "format": "int32", "x-aura-field-code": "exportCustomsDeclerationComponentId" }, "fxAccountNo": { "x-aura-type": "unresolved" }, "fxEntryMethod": { "type": "string", "x-aura-field-code": "fxEntryMethod" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importCustomDeclarationInquiryId": { "type": "string", "x-aura-field-code": "importCustomDeclarationInquiryId" }, "importCustomsDeclerationComponentId": { "type": "integer", "format": "int32", "x-aura-field-code": "importCustomsDeclerationComponentId" }, "liableBankId": { "type": "string", "x-aura-field-code": "liableBankId" }, "tCMBCurrency": { "type": "string", "x-aura-field-code": "tCMBCurrency" }, "tCMBHourlyRate": { "type": "number", "format": "decimal", "x-aura-field-code": "tCMBHourlyRate" }, "tLAccountNo": { "type": "integer", "format": "int32", "x-aura-field-code": "tLAccountNo" }, "tLAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "tLAmount" } }, "required": [ "amount", "currencySupport", "currencySupportAmount", "customDeclarationCheck", "customDeclarationProcessAmount", "description", "discountAmount", "discountCurrency", "discountDate", "discountReason", "exportCustomDeclarationInquiryId", "exportCustomsDeclerationComponentId", "fxAccountNo", "fxEntryMethod", "groupGuid", "importCustomDeclarationInquiryId", "importCustomsDeclerationComponentId", "liableBankId", "tCMBCurrency", "tCMBHourlyRate", "tLAccountNo", "tLAmount" ] } } } }, "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": 22, "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-export-payment-acceptance", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payment-acceptances/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FxEntryMethod", "declared_type": null, "nullable": false, "collection": false }, { "name": "FxAccountNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "TLAccountNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "TCMBCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TCMBHourlyRate", "declared_type": null, "nullable": false, "collection": false }, { "name": "TLAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportCustomDeclarationInquiryId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportCustomDeclarationInquiryId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExportCustomsDeclerationComponentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ImportCustomsDeclerationComponentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencySupportAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomDeclarationProcessAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencySupport", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomDeclarationCheck", "declared_type": null, "nullable": false, "collection": false }, { "name": "DiscountDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "DiscountAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DiscountCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "DiscountReason", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "LiableBankId", "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_FRGN_TRD_38", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_ACCEPTANCE_NOT_FOUND" } ] } } }, "/export-payments": { "get": { "operationId": "get-export-payment-list", "tags": [ "export-payments" ], "summary": "get-export-payment-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-export-payment-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payments", "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": "ExportPaymentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BinderId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PapersId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PreFinansInd", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrencyIncomeType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "DTHAccountNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ManufacturerTransferInd", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ManufacturerCustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ManufacturerAccountNumber", "declared_type": "long?", "nullable": true, "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 } }, "post": { "operationId": "create-export-payment", "tags": [ "export-payments" ], "summary": "create-export-payment", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "x-aura-type": "unresolved" }, "binderId": { "type": "string", "format": "uuid", "x-aura-field-code": "binderId" }, "currencyIncomeType": { "type": "string", "x-aura-field-code": "currencyIncomeType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "dTHAccountNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "dTHAccountNumber" }, "manufacturerAccountNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "manufacturerAccountNumber" }, "manufacturerCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "manufacturerCustomerId" }, "manufacturerTransferInd": { "type": "boolean", "x-aura-field-code": "manufacturerTransferInd" }, "papersId": { "type": "string", "format": "uuid", "x-aura-field-code": "papersId" }, "paymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "paymentAmount" }, "preFinansInd": { "type": "boolean", "x-aura-field-code": "preFinansInd" }, "swiftTransferId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "accountNumber", "binderId", "currencyIncomeType", "customerId", "dTHAccountNumber", "manufacturerAccountNumber", "manufacturerCustomerId", "manufacturerTransferInd", "papersId", "paymentAmount", "preFinansInd", "swiftTransferId" ] } } } }, "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": 12, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-export-payment", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payments", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BinderId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PapersId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreFinansInd", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyIncomeType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "DTHAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ManufacturerTransferInd", "declared_type": null, "nullable": true, "collection": false }, { "name": "ManufacturerCustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ManufacturerAccountNumber", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/export-payments/{id}": { "delete": { "operationId": "delete-export-payment", "tags": [ "export-payments" ], "summary": "delete-export-payment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentId" } } ], "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-export-payment", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payments/{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_FRGN_TRD_37", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_NOT_FOUND" } ] } }, "get": { "operationId": "get-export-payment-by-id", "tags": [ "export-payments" ], "summary": "get-export-payment-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentId" } } ], "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-export-payment-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payments/{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": "ExportPaymentDto", "payload": "ExportPaymentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BinderId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PapersId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PreFinansInd", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CurrencyIncomeType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "DTHAccountNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ManufacturerTransferInd", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "ManufacturerCustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ManufacturerAccountNumber", "declared_type": "long?", "nullable": true, "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_FRGN_TRD_37", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_NOT_FOUND" } ] } }, "put": { "operationId": "update-export-payment", "tags": [ "export-payments" ], "summary": "update-export-payment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "exportPaymentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "x-aura-type": "unresolved" }, "binderId": { "type": "string", "format": "uuid", "x-aura-field-code": "binderId" }, "currencyIncomeType": { "type": "string", "x-aura-field-code": "currencyIncomeType" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "dTHAccountNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "dTHAccountNumber" }, "manufacturerAccountNumber": { "type": "integer", "format": "int64", "x-aura-field-code": "manufacturerAccountNumber" }, "manufacturerCustomerId": { "type": "string", "format": "uuid", "x-aura-field-code": "manufacturerCustomerId" }, "manufacturerTransferInd": { "type": "boolean", "x-aura-field-code": "manufacturerTransferInd" }, "papersId": { "type": "string", "format": "uuid", "x-aura-field-code": "papersId" }, "paymentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "paymentAmount" }, "preFinansInd": { "type": "boolean", "x-aura-field-code": "preFinansInd" }, "swiftTransferId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "accountNumber", "binderId", "currencyIncomeType", "customerId", "dTHAccountNumber", "manufacturerAccountNumber", "manufacturerCustomerId", "manufacturerTransferInd", "papersId", "paymentAmount", "preFinansInd", "swiftTransferId" ] } } } }, "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": 12, "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-export-payment", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-payments/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "BinderId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PapersId", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreFinansInd", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyIncomeType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "DTHAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ManufacturerTransferInd", "declared_type": null, "nullable": true, "collection": false }, { "name": "ManufacturerCustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ManufacturerAccountNumber", "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_FRGN_TRD_37", "status": 400, "message": null, "message_available": false, "constant_name": "EXPORT_PAYMENT_NOT_FOUND" } ] } } }, "/export-reports/to-export-abandon": { "post": { "operationId": "to-export-abandon", "tags": [ "export-reports" ], "summary": "to-export-abandon", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binderId": { "type": "string", "format": "uuid", "x-aura-field-code": "binderId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "operationType": { "type": "integer", "format": "int32", "x-aura-field-code": "operationType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportReportStatus" }, "values": { "x-aura-type": "unresolved" } }, "required": [ "binderId", "customerId", "operationType", "status", "values" ] } } } }, "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. 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": "to-export-abandon", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-reports/to-export-abandon", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BinderId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "Values", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExportReportDto", "payload": "ExportReportDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BinderId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Values", "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 } } }, "/export-reports/to-export-other": { "post": { "operationId": "to-export-other", "tags": [ "export-reports" ], "summary": "to-export-other", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binderId": { "type": "string", "format": "uuid", "x-aura-field-code": "binderId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "operationType": { "type": "integer", "format": "int32", "x-aura-field-code": "operationType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportReportStatus" }, "values": { "x-aura-type": "unresolved" } }, "required": [ "binderId", "customerId", "operationType", "status", "values" ] } } } }, "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. 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": "to-export-other", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-reports/to-export-other", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BinderId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "Values", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExportReportDto", "payload": "ExportReportDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BinderId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Values", "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 } } }, "/export-reports/to-export-report": { "post": { "operationId": "to-export-report", "tags": [ "export-reports" ], "summary": "to-export-report", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binderId": { "type": "string", "format": "uuid", "x-aura-field-code": "binderId" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "operationType": { "type": "integer", "format": "int32", "x-aura-field-code": "operationType" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "exportReportStatus" }, "values": { "x-aura-type": "unresolved" } }, "required": [ "binderId", "customerId", "operationType", "status", "values" ] } } } }, "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. 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": "to-export-report", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "export-reports/to-export-report", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BinderId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "Values", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ExportReportDto", "payload": "ExportReportDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BinderId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "OperationType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Values", "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 } } }, "/import-binders": { "get": { "operationId": "get-import-binder-list", "tags": [ "import-binders" ], "summary": "get-import-binder-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-import-binder-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-binders", "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": "ImportBinderDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BinderAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FeaturedTransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomDeclarationsNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ShipmentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoadingCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnLoadingCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BinderStatus", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-import-binder", "tags": [ "import-binders" ], "summary": "create-import-binder", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclarationsNumber": { "type": "string", "x-aura-field-code": "customDeclarationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } }, "required": [ "binderAmount", "binderStatus", "currencyCode", "customDeclarationsNumber", "customerId", "exporterAddress", "exporterName", "featuredTransactionType", "goodType", "importerAddress", "importerName", "loadingCountryCode", "paymentType", "referenceNumber", "shipmentType", "unLoadingCountryCode" ] } } } }, "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": 16, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-import-binder", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-binders", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ReferenceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BinderAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FeaturedTransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomDeclarationsNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ShipmentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnLoadingCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BinderStatus", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-binders/{id}": { "delete": { "operationId": "delete-import-binder", "tags": [ "import-binders" ], "summary": "delete-import-binder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importBinderId" } } ], "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-import-binder", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-binders/{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_FRGN_TRD_52", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_BINDER_NOT_FOUND" } ] } }, "get": { "operationId": "get-import-binder-by-id", "tags": [ "import-binders" ], "summary": "get-import-binder-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importBinderId" } } ], "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-import-binder-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-binders/{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": "ImportBinderDto", "payload": "ImportBinderDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ReferenceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BinderAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FeaturedTransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomDeclarationsNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "ShipmentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoadingCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnLoadingCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BinderStatus", "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_FRGN_TRD_52", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_BINDER_NOT_FOUND" } ] } }, "put": { "operationId": "update-import-binder", "tags": [ "import-binders" ], "summary": "update-import-binder", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importBinderId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binderAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "binderAmount" }, "binderStatus": { "type": "string", "x-aura-field-code": "binderStatus" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customDeclarationsNumber": { "type": "string", "x-aura-field-code": "customDeclarationsNumber" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "exporterAddress": { "type": "string", "x-aura-field-code": "exporterAddress" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "featuredTransactionType": { "type": "string", "x-aura-field-code": "featuredTransactionType" }, "goodType": { "type": "string", "x-aura-field-code": "goodType" }, "importerAddress": { "type": "string", "x-aura-field-code": "importerAddress" }, "importerName": { "type": "string", "x-aura-field-code": "importerName" }, "loadingCountryCode": { "type": "string", "x-aura-field-code": "loadingCountryCode" }, "paymentType": { "x-aura-type": "unresolved" }, "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" }, "shipmentType": { "type": "string", "x-aura-field-code": "shipmentType" }, "unLoadingCountryCode": { "type": "string", "x-aura-field-code": "unLoadingCountryCode" } }, "required": [ "binderAmount", "binderStatus", "currencyCode", "customDeclarationsNumber", "customerId", "exporterAddress", "exporterName", "featuredTransactionType", "goodType", "importerAddress", "importerName", "loadingCountryCode", "paymentType", "referenceNumber", "shipmentType", "unLoadingCountryCode" ] } } } }, "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": 16, "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-import-binder", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-binders/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReferenceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImporterAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BinderAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FeaturedTransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomDeclarationsNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ShipmentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnLoadingCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BinderStatus", "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_FRGN_TRD_52", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_BINDER_NOT_FOUND" } ] } } }, "/import-documents": { "get": { "operationId": "get-import-document-list", "tags": [ "import-documents" ], "summary": "get-import-document-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 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": "get-import-document-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents", "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": "ImportDocumentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string?", "nullable": true, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Charge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionSender", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpenseReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterBIC", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RemittanceLetterDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Representative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxExemptionScope", "declared_type": "string", "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Incoterm", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalAmountPaid", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AcceptanceCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvalCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsAccepted", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsAvalised", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ReturningChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionPaymentMaturity", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CreatedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ModifiedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionDocumentData", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "TermDetails", "declared_type": "IEnumerable", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-import-document", "tags": [ "import-documents" ], "summary": "create-import-document", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "acceptanceCharge": { "type": "string", "x-aura-field-code": "acceptanceCharge" }, "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalCharge": { "type": "string", "x-aura-field-code": "avalCharge" }, "charge": { "type": "string", "x-aura-field-code": "charge" }, "chargePayer": { "type": "string", "x-aura-field-code": "chargePayer" }, "collectionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmount" }, "collectionDocumentData": { "type": "array", "items": { "type": "object", "properties": { "collectionDocumentDate": { "type": "string", "x-aura-field-code": "collectionDocumentDate" }, "collectionDocumentNumber": { "type": "string", "x-aura-field-code": "collectionDocumentNumber" }, "collectionDocumentType": { "type": "string", "x-aura-field-code": "collectionDocumentType" }, "collectionNumberOfCopies": { "type": "string", "x-aura-field-code": "collectionNumberOfCopies" }, "collectionNumberOfOriginals": { "type": "string", "x-aura-field-code": "collectionNumberOfOriginals" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "exportDocumentId": { "type": "string", "x-aura-field-code": "exportDocumentId" }, "exportLetterCreditId": { "type": "string", "x-aura-field-code": "exportLetterCreditId" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" }, "importLetterCreditId": { "type": "string", "x-aura-field-code": "importLetterCreditId" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "x-aura-field-code": "collectionDocumentData" } }, "collectionEntryDate": { "type": "string", "x-aura-field-code": "collectionEntryDate" }, "collectionPlace": { "type": "string", "x-aura-field-code": "collectionPlace" }, "collectionSender": { "type": "string", "x-aura-field-code": "collectionSender" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "correspondentCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "correspondentCharge" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "deliveryPlace": { "type": "string", "x-aura-field-code": "deliveryPlace" }, "description": { "type": "string", "x-aura-field-code": "description" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "exporterAdress": { "type": "string", "x-aura-field-code": "exporterAdress" }, "exporterBIC": { "type": "string", "x-aura-field-code": "exporterBIC" }, "exporterCountry": { "type": "string", "x-aura-field-code": "exporterCountry" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "fileStatus": { "type": "string", "x-aura-field-code": "fileStatus" }, "goodsOrigin": { "type": "string", "x-aura-field-code": "goodsOrigin" }, "goodsValue": { "type": "number", "format": "decimal", "x-aura-field-code": "goodsValue" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "incentive": { "type": "boolean", "x-aura-field-code": "incentive" }, "incentiveDocumentId": { "type": "string", "x-aura-field-code": "incentiveDocumentId" }, "incoterm": { "type": "string", "x-aura-field-code": "incoterm" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNumber": { "type": "string", "x-aura-field-code": "invoiceNumber" }, "isAccepted": { "type": "boolean", "x-aura-field-code": "isAccepted" }, "isAvalised": { "type": "boolean", "x-aura-field-code": "isAvalised" }, "preDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "preDocumentId" }, "receiptPlace": { "type": "string", "x-aura-field-code": "receiptPlace" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "remittanceLetterDate": { "type": "string", "format": "date-time", "x-aura-field-code": "remittanceLetterDate" }, "representative": { "type": "string", "x-aura-field-code": "representative" }, "returningCharge": { "type": "string", "x-aura-field-code": "returningCharge" }, "returningChargePayer": { "type": "string", "x-aura-field-code": "returningChargePayer" }, "returningCourierCompany": { "type": "string", "x-aura-field-code": "returningCourierCompany" }, "returningDescription": { "type": "string", "x-aura-field-code": "returningDescription" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "shipName": { "type": "string", "x-aura-field-code": "shipName" }, "status": { "type": "string", "x-aura-field-code": "importDocumentStatus" }, "swiftMessage72Area": { "type": "string", "x-aura-field-code": "swiftMessage72Area" }, "swiftMessage79Area": { "type": "string", "x-aura-field-code": "swiftMessage79Area" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "taxExemptionScope": { "type": "string", "x-aura-field-code": "taxExemptionScope" }, "termDetails": { "type": "array", "items": { "type": "object", "properties": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "type": "string", "x-aura-field-code": "exportDocumentId" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "string", "x-aura-field-code": "importDocumentStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } }, "x-aura-field-code": "termDetails" } }, "totalAmountPaid": { "type": "number", "format": "decimal", "x-aura-field-code": "totalAmountPaid" }, "transferringBankAddress": { "type": "string", "x-aura-field-code": "transferringBankAddress" }, "transferringBankBicCode": { "type": "string", "x-aura-field-code": "transferringBankBicCode" }, "transferringCharge": { "type": "string", "x-aura-field-code": "transferringCharge" }, "transferringChargePayer": { "type": "string", "x-aura-field-code": "transferringChargePayer" }, "transferringCourierCompany": { "type": "string", "x-aura-field-code": "transferringCourierCompany" }, "transferringDescription": { "type": "string", "x-aura-field-code": "transferringDescription" }, "waveInfo": { "type": "string", "x-aura-field-code": "waveInfo" } } } } } }, "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": 60, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "AccountNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "Charge", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionSender", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerName", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExpenseReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterBIC", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": null, "nullable": true, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RemittanceLetterDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Representative", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TaxExemptionScope", "declared_type": null, "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Incoterm", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalAmountPaid", "declared_type": null, "nullable": true, "collection": false }, { "name": "AcceptanceCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvalCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsAccepted", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsAvalised", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReturningChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningCharge", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-documents/term-details": { "get": { "operationId": "get-all-import-document-by-term-detail", "tags": [ "import-documents" ], "summary": "get-all-import-document-by-term-detail", "parameters": [ { "name": "amountEnd", "in": "query", "required": false, "schema": { "type": "number", "format": "decimal", "x-aura-field-code": "amountEnd" } }, { "name": "amountStart", "in": "query", "required": false, "schema": { "type": "number", "format": "decimal", "x-aura-field-code": "amountStart" } }, { "name": "collectionEntryDateEnd", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "collectionEntryDateEnd" } }, { "name": "collectionEntryDateStart", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "collectionEntryDateStart" } }, { "name": "collectionType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" } }, { "name": "currencyCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "currencyCode" } }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "endDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date", "x-aura-field-code": "endDate" } }, { "name": "isCollectionEntryDate", "in": "query", "required": false, "schema": { "type": "boolean", "x-aura-field-code": "isCollectionEntryDate" } }, { "name": "maturityInstrumentType", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "maturityInstrumentType" } }, { "name": "reference", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "reference" } }, { "name": "startDate", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "startDate" } }, { "name": "status", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "importDocumentStatus" } } ], "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": 13 }, "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": "get-all-import-document-by-term-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/term-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": "CollectionType", "declared_type": null, "nullable": true, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "AmountStart", "declared_type": null, "nullable": true, "collection": false }, { "name": "AmountEnd", "declared_type": null, "nullable": true, "collection": false }, { "name": "StartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "EndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsCollectionEntryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionEntryDateStart", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionEntryDateEnd", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityInstrumentType", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ImportDocumentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string?", "nullable": true, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Charge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionSender", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpenseReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterBIC", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RemittanceLetterDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Representative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxExemptionScope", "declared_type": "string", "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Incoterm", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalAmountPaid", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AcceptanceCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvalCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsAccepted", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsAvalised", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ReturningChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionPaymentMaturity", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CreatedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ModifiedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionDocumentData", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "TermDetails", "declared_type": "IEnumerable", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-documents/{id}": { "delete": { "operationId": "delete-import-document", "tags": [ "import-documents" ], "summary": "delete-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } }, "get": { "operationId": "get-import-document-by-id", "tags": [ "import-documents" ], "summary": "get-import-document-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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-import-document-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{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": "ImportDocumentDto", "payload": "ImportDocumentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string?", "nullable": true, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Charge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionSender", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExpenseReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterBIC", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RemittanceLetterDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Representative", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TaxExemptionScope", "declared_type": "string", "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Incoterm", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalAmountPaid", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "AcceptanceCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AvalCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsAccepted", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "IsAvalised", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ReturningChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionPaymentMaturity", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "CreatedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ModifiedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CollectionDocumentData", "declared_type": "IEnumerable", "nullable": false, "collection": true }, { "name": "TermDetails", "declared_type": "IEnumerable", "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 }, "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } }, "put": { "operationId": "update-import-document", "tags": [ "import-documents" ], "summary": "update-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "acceptanceCharge": { "type": "string", "x-aura-field-code": "acceptanceCharge" }, "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalCharge": { "type": "string", "x-aura-field-code": "avalCharge" }, "charge": { "type": "string", "x-aura-field-code": "charge" }, "chargePayer": { "type": "string", "x-aura-field-code": "chargePayer" }, "collectionAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "collectionAmount" }, "collectionDocumentData": { "type": "array", "items": { "type": "object", "properties": { "collectionDocumentDate": { "type": "string", "x-aura-field-code": "collectionDocumentDate" }, "collectionDocumentNumber": { "type": "string", "x-aura-field-code": "collectionDocumentNumber" }, "collectionDocumentType": { "type": "string", "x-aura-field-code": "collectionDocumentType" }, "collectionNumberOfCopies": { "type": "string", "x-aura-field-code": "collectionNumberOfCopies" }, "collectionNumberOfOriginals": { "type": "string", "x-aura-field-code": "collectionNumberOfOriginals" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "exportDocumentId": { "type": "string", "x-aura-field-code": "exportDocumentId" }, "exportLetterCreditId": { "type": "string", "x-aura-field-code": "exportLetterCreditId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "collectionDocumentDataId" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" }, "importLetterCreditId": { "type": "string", "x-aura-field-code": "importLetterCreditId" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "x-aura-field-code": "collectionDocumentData" } }, "collectionEntryDate": { "type": "string", "x-aura-field-code": "collectionEntryDate" }, "collectionPlace": { "type": "string", "x-aura-field-code": "collectionPlace" }, "collectionSender": { "type": "string", "x-aura-field-code": "collectionSender" }, "collectionType": { "type": "integer", "format": "int32", "x-aura-field-code": "collectionType" }, "correspondentCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "correspondentCharge" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "deliveryPlace": { "type": "string", "x-aura-field-code": "deliveryPlace" }, "description": { "type": "string", "x-aura-field-code": "description" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "exporterAdress": { "type": "string", "x-aura-field-code": "exporterAdress" }, "exporterBIC": { "type": "string", "x-aura-field-code": "exporterBIC" }, "exporterCountry": { "type": "string", "x-aura-field-code": "exporterCountry" }, "exporterName": { "type": "string", "x-aura-field-code": "exporterName" }, "fileStatus": { "type": "string", "x-aura-field-code": "fileStatus" }, "goodsOrigin": { "type": "string", "x-aura-field-code": "goodsOrigin" }, "goodsValue": { "type": "number", "format": "decimal", "x-aura-field-code": "goodsValue" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "incentive": { "type": "boolean", "x-aura-field-code": "incentive" }, "incentiveDocumentId": { "type": "string", "x-aura-field-code": "incentiveDocumentId" }, "incoterm": { "type": "string", "x-aura-field-code": "incoterm" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNumber": { "type": "string", "x-aura-field-code": "invoiceNumber" }, "isAccepted": { "type": "boolean", "x-aura-field-code": "isAccepted" }, "isAvalised": { "type": "boolean", "x-aura-field-code": "isAvalised" }, "preDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "preDocumentId" }, "receiptPlace": { "type": "string", "x-aura-field-code": "receiptPlace" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "remittanceLetterDate": { "type": "string", "format": "date-time", "x-aura-field-code": "remittanceLetterDate" }, "representative": { "type": "string", "x-aura-field-code": "representative" }, "returningCharge": { "type": "string", "x-aura-field-code": "returningCharge" }, "returningChargePayer": { "type": "string", "x-aura-field-code": "returningChargePayer" }, "returningCourierCompany": { "type": "string", "x-aura-field-code": "returningCourierCompany" }, "returningDescription": { "type": "string", "x-aura-field-code": "returningDescription" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "shipName": { "type": "string", "x-aura-field-code": "shipName" }, "status": { "type": "string", "x-aura-field-code": "importDocumentStatus" }, "swiftMessage72Area": { "type": "string", "x-aura-field-code": "swiftMessage72Area" }, "swiftMessage79Area": { "type": "string", "x-aura-field-code": "swiftMessage79Area" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "taxExemptionScope": { "type": "string", "x-aura-field-code": "taxExemptionScope" }, "termDetails": { "type": "array", "items": { "type": "object", "properties": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "type": "string", "x-aura-field-code": "exportDocumentId" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } }, "x-aura-field-code": "termDetails" } }, "totalAmountPaid": { "type": "number", "format": "decimal", "x-aura-field-code": "totalAmountPaid" }, "transferringBankAddress": { "type": "string", "x-aura-field-code": "transferringBankAddress" }, "transferringBankBicCode": { "type": "string", "x-aura-field-code": "transferringBankBicCode" }, "transferringCharge": { "type": "string", "x-aura-field-code": "transferringCharge" }, "transferringChargePayer": { "type": "string", "x-aura-field-code": "transferringChargePayer" }, "transferringCourierCompany": { "type": "string", "x-aura-field-code": "transferringCourierCompany" }, "transferringDescription": { "type": "string", "x-aura-field-code": "transferringDescription" }, "waveInfo": { "type": "string", "x-aura-field-code": "waveInfo" } } } } } }, "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": 60, "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-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "Charge", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionEntryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CollectionPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionSender", "declared_type": null, "nullable": false, "collection": false }, { "name": "CollectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerName", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExpenseReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterBIC", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterName", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsOrigin", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "Incentive", "declared_type": null, "nullable": true, "collection": false }, { "name": "IncentiveDocumentId", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RemittanceLetterDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Representative", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessage72Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessage79Area", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TaxExemptionScope", "declared_type": null, "nullable": false, "collection": false }, { "name": "WaveInfo", "declared_type": null, "nullable": false, "collection": false }, { "name": "PreDocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "FileStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Incoterm", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalAmountPaid", "declared_type": null, "nullable": true, "collection": false }, { "name": "AcceptanceCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvalCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsAccepted", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsAvalised", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReturningChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningCharge", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-cancelled": { "put": { "operationId": "set-cancelled-import-document", "tags": [ "import-documents" ], "summary": "set-cancelled-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-cancelled-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-cancelled", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-delivered": { "put": { "operationId": "set-delivered-import-document", "tags": [ "import-documents" ], "summary": "set-delivered-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-delivered-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-delivered", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-free-of-payment": { "put": { "operationId": "set-free-of-payment-import-document", "tags": [ "import-documents" ], "summary": "set-free-of-payment-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-free-of-payment-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-free-of-payment", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-paid": { "put": { "operationId": "set-paid-import-document", "tags": [ "import-documents" ], "summary": "set-paid-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-paid-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-paid", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-processing": { "put": { "operationId": "set-processing-import-document", "tags": [ "import-documents" ], "summary": "set-processing-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-processing-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-processing", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-rejected": { "put": { "operationId": "set-rejected-import-document", "tags": [ "import-documents" ], "summary": "set-rejected-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-rejected-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-rejected", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-returned": { "put": { "operationId": "set-returned-import-document", "tags": [ "import-documents" ], "summary": "set-returned-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-returned-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-returned", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-transferred": { "put": { "operationId": "set-transferred-import-document", "tags": [ "import-documents" ], "summary": "set-transferred-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-transferred-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-transferred", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/set-waiting-for-transfer": { "put": { "operationId": "set-waiting-for-transfer-import-document", "tags": [ "import-documents" ], "summary": "set-waiting-for-transfer-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "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": "set-waiting-for-transfer-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/set-waiting-for-transfer", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/term-detail-acceptance-status": { "put": { "operationId": "term-detail-acceptance-statu-import-document", "tags": [ "import-documents" ], "summary": "term-detail-acceptance-statu-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "acceptanceStatu": { "type": "boolean", "x-aura-field-code": "acceptanceStatu" } }, "required": [ "acceptanceStatu" ] } } } }, "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": "term-detail-acceptance-statu-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/term-detail-acceptance-status", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-documents/{id}/term-detail-aval-status": { "put": { "operationId": "term-detail-aval-statu-import-document", "tags": [ "import-documents" ], "summary": "term-detail-aval-statu-import-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "avalStatu": { "type": "boolean", "x-aura-field-code": "avalStatu" } }, "required": [ "avalStatu" ] } } } }, "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": "term-detail-aval-statu-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-documents/{id}/term-detail-aval-status", "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_FRGN_TRD_53", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_DOCUMENT_NOT_FOUND" } ] } } }, "/import-lc-delivery-documents": { "get": { "operationId": "get-import-lCDelivery-document-list", "tags": [ "import-lc-delivery-documents" ], "summary": "get-import-lCDelivery-document-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-import-lCDelivery-document-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-delivery-documents", "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": "ImportLCDeliveryDocumentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DeliveryDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryDocumentTypeName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OriginalDocumentCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CopyDocumentCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DeliveryOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportLCDocumentId", "declared_type": "Guid?", "nullable": true, "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 } }, "post": { "operationId": "create-import-lCDelivery-document", "tags": [ "import-lc-delivery-documents" ], "summary": "create-import-lCDelivery-document", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "copyDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "copyDocumentCount" }, "deliveryDocumentType": { "type": "string", "x-aura-field-code": "deliveryDocumentType" }, "deliveryDocumentTypeName": { "type": "string", "x-aura-field-code": "deliveryDocumentTypeName" }, "deliveryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "deliveryOrder" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importLCDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCDocumentId" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "originalDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "originalDocumentCount" } }, "required": [ "copyDocumentCount", "deliveryDocumentType", "deliveryDocumentTypeName", "deliveryOrder", "groupGuid", "importLCDocumentId", "invoiceDate", "invoiceNo", "originalDocumentCount" ] } } } }, "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-import-lCDelivery-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-delivery-documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DeliveryDocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryDocumentTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "OriginalDocumentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CopyDocumentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryOrder", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportLCDocumentId", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-lc-delivery-documents/{id}": { "delete": { "operationId": "delete-import-lCDelivery-document", "tags": [ "import-lc-delivery-documents" ], "summary": "delete-import-lCDelivery-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDeliveryDocumentId" } } ], "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-import-lCDelivery-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-delivery-documents/{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_FRGN_TRD_54", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DELIVERY_DOCUMENT_NOT_FOUND" } ] } }, "get": { "operationId": "get-import-lCDelivery-document-by-id", "tags": [ "import-lc-delivery-documents" ], "summary": "get-import-lCDelivery-document-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDeliveryDocumentId" } } ], "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-import-lCDelivery-document-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-delivery-documents/{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": "ImportLCDeliveryDocumentDto", "payload": "ImportLCDeliveryDocumentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DeliveryDocumentType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DeliveryDocumentTypeName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "OriginalDocumentCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CopyDocumentCount", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "DeliveryOrder", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportLCDocumentId", "declared_type": "Guid?", "nullable": true, "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_FRGN_TRD_54", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DELIVERY_DOCUMENT_NOT_FOUND" } ] } }, "put": { "operationId": "update-import-lCDelivery-document", "tags": [ "import-lc-delivery-documents" ], "summary": "update-import-lCDelivery-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDeliveryDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "copyDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "copyDocumentCount" }, "deliveryDocumentType": { "type": "string", "x-aura-field-code": "deliveryDocumentType" }, "deliveryDocumentTypeName": { "type": "string", "x-aura-field-code": "deliveryDocumentTypeName" }, "deliveryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "deliveryOrder" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importLCDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCDocumentId" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "originalDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "originalDocumentCount" } }, "required": [ "copyDocumentCount", "deliveryDocumentType", "deliveryDocumentTypeName", "deliveryOrder", "groupGuid", "importLCDocumentId", "invoiceDate", "invoiceNo", "originalDocumentCount" ] } } } }, "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-import-lCDelivery-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-delivery-documents/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryDocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryDocumentTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "OriginalDocumentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "CopyDocumentCount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryOrder", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportLCDocumentId", "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_FRGN_TRD_54", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DELIVERY_DOCUMENT_NOT_FOUND" } ] } } }, "/import-lc-document-goods-details": { "get": { "operationId": "get-import-lCDocument-goods-detail-list", "tags": [ "import-lc-document-goods-details" ], "summary": "get-import-lCDocument-goods-detail-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-import-lCDocument-goods-detail-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-document-goods-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": "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": "ImportLCDocumentGoodsDetailDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "GoodsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": "double?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalValueOfGoods", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MT700Message45ADetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrentStatusOf45ADetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportLCDocumentId", "declared_type": "Guid?", "nullable": true, "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 } }, "post": { "operationId": "create-import-lCDocument-goods-detail", "tags": [ "import-lc-document-goods-details" ], "summary": "create-import-lCDocument-goods-detail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "importLCDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCDocumentId" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "x-aura-type": "unresolved" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "required": [ "currencyCode", "currentStatusOf45ADetail", "goodsName", "importLCDocumentId", "mT700Message45ADetail", "quantity", "totalValueOfGoods", "unit", "unitPrice" ] } } } }, "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-import-lCDocument-goods-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-document-goods-details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "GoodsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalValueOfGoods", "declared_type": null, "nullable": false, "collection": false }, { "name": "MT700Message45ADetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrentStatusOf45ADetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportLCDocumentId", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-lc-document-goods-details/{id}": { "delete": { "operationId": "delete-import-lCDocument-goods-detail", "tags": [ "import-lc-document-goods-details" ], "summary": "delete-import-lCDocument-goods-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDeliveryDocumentId" } } ], "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-import-lCDocument-goods-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-document-goods-details/{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_FRGN_TRD_56", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_GOODS_DETAIL_NOT_FOUND" } ] } }, "get": { "operationId": "get-import-lCDocument-goods-detail-by-id", "tags": [ "import-lc-document-goods-details" ], "summary": "get-import-lCDocument-goods-detail-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDeliveryDocumentId" } } ], "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-import-lCDocument-goods-detail-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-document-goods-details/{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": "ImportLCDocumentGoodsDetailDto", "payload": "ImportLCDocumentGoodsDetailDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "GoodsName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": "double?", "nullable": true, "collection": false }, { "name": "Unit", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TotalValueOfGoods", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MT700Message45ADetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrentStatusOf45ADetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportLCDocumentId", "declared_type": "Guid?", "nullable": true, "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_FRGN_TRD_56", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_GOODS_DETAIL_NOT_FOUND" } ] } }, "put": { "operationId": "update-import-lCDocument-goods-detail", "tags": [ "import-lc-document-goods-details" ], "summary": "update-import-lCDocument-goods-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentGoodsDetailId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "importLCDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCDocumentId" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "x-aura-type": "unresolved" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "required": [ "currencyCode", "currentStatusOf45ADetail", "goodsName", "importLCDocumentId", "mT700Message45ADetail", "quantity", "totalValueOfGoods", "unit", "unitPrice" ] } } } }, "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-import-lCDocument-goods-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-document-goods-details/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalValueOfGoods", "declared_type": null, "nullable": false, "collection": false }, { "name": "MT700Message45ADetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrentStatusOf45ADetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportLCDocumentId", "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_FRGN_TRD_56", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_GOODS_DETAIL_NOT_FOUND" } ] } } }, "/import-lc-documents": { "get": { "operationId": "get-import-lCDocument-list", "tags": [ "import-lc-documents" ], "summary": "get-import-lCDocument-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. 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": "get-import-lCDocument-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents", "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": "ImportLCDocumentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DocumentNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DocumentSender", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentHolder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DocumentEntryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "PaymentDueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "OurBankCharge", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DocumentStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipperName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Notes", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportLCId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondenceEntryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "LcDocumentSwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift79Message", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameandAddressMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountyCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LCAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "LCDueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IssuingDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfirmationInstructions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ImportLCDeliveryDocumentList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ImportLCDocumentGoodsDetailList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ImportLCDocumentReserveList", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-import-lCDocument", "tags": [ "import-lc-documents" ], "summary": "create-import-lCDocument", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "beneficiaryCountyCode": { "type": "integer", "format": "int32", "x-aura-field-code": "beneficiaryCountyCode" }, "beneficiaryNameandAddressMessage": { "type": "string", "x-aura-field-code": "beneficiaryNameandAddressMessage" }, "correspondenceEntryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "correspondenceEntryDate" }, "correspondentCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "correspondentCharge" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "customerNameandAddressMessage": { "type": "string", "x-aura-field-code": "customerNameandAddressMessage" }, "demandedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "demandedAmount" }, "dischargePort": { "type": "string", "x-aura-field-code": "dischargePort" }, "documentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "documentAmount" }, "documentEntryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "documentEntryDate" }, "documentHolder": { "type": "string", "x-aura-field-code": "documentHolder" }, "documentNumber": { "type": "string", "x-aura-field-code": "documentNumber" }, "documentSender": { "type": "string", "x-aura-field-code": "documentSender" }, "documentStatus": { "type": "string", "x-aura-field-code": "documentStatus" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "explanations": { "type": "string", "x-aura-field-code": "explanations" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importLCDeliveryDocumentList": { "type": "array", "items": { "type": "object", "properties": { "copyDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "copyDocumentCount" }, "deliveryDocumentType": { "type": "string", "x-aura-field-code": "deliveryDocumentType" }, "deliveryDocumentTypeName": { "type": "string", "x-aura-field-code": "deliveryDocumentTypeName" }, "deliveryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "deliveryOrder" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "originalDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "originalDocumentCount" } }, "x-aura-field-code": "importLCDeliveryDocumentList" } }, "importLCDocumentGoodsDetailList": { "type": "array", "items": { "type": "object", "properties": { "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "type": "integer", "format": "int32", "x-aura-field-code": "quantity" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "type": "integer", "format": "int32", "x-aura-field-code": "unit" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "x-aura-field-code": "importLCDocumentGoodsDetailList" } }, "importLCDocumentReserveList": { "type": "array", "items": { "type": "object", "properties": { "importLCDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCDocumentId" }, "isChecked": { "type": "boolean", "x-aura-field-code": "isChecked" }, "lcReserveENValue": { "type": "string", "x-aura-field-code": "lcReserveENValue" }, "lcReserveTRValue": { "type": "string", "x-aura-field-code": "lcReserveTRValue" } }, "x-aura-field-code": "importLCDocumentReserveList" } }, "importLCId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCId" }, "lCAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "lCAmount" }, "lCDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lCDueDate" }, "latestDateofShipment": { "type": "string", "x-aura-field-code": "latestDateofShipment" }, "lcDocumentSwift79Message": { "type": "string", "x-aura-field-code": "lcDocumentSwift79Message" }, "lcDocumentSwiftMessageType": { "type": "string", "x-aura-field-code": "lcDocumentSwiftMessageType" }, "loadingPort": { "type": "string", "x-aura-field-code": "loadingPort" }, "notes": { "type": "string", "x-aura-field-code": "notes" }, "ourBankCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "ourBankCharge" }, "paymentDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "paymentDueDate" }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "returningCharge": { "type": "string", "x-aura-field-code": "returningCharge" }, "returningChargePayer": { "type": "string", "x-aura-field-code": "returningChargePayer" }, "returningCourierCompany": { "type": "string", "x-aura-field-code": "returningCourierCompany" }, "returningDescription": { "type": "string", "x-aura-field-code": "returningDescription" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "shipName": { "type": "string", "x-aura-field-code": "shipName" }, "shipperName": { "type": "string", "x-aura-field-code": "shipperName" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "status" }, "transferringBankAddress": { "type": "string", "x-aura-field-code": "transferringBankAddress" }, "transferringBankBicCode": { "type": "string", "x-aura-field-code": "transferringBankBicCode" }, "transferringCharge": { "type": "string", "x-aura-field-code": "transferringCharge" }, "transferringChargePayer": { "type": "string", "x-aura-field-code": "transferringChargePayer" }, "transferringCourierCompany": { "type": "string", "x-aura-field-code": "transferringCourierCompany" }, "transferringDescription": { "type": "string", "x-aura-field-code": "transferringDescription" } } } } } }, "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": 50, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-import-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "DocumentNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentSender", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentHolder", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentEntryDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentDueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "OurBankCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipperName", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": null, "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Notes", "declared_type": null, "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportLCId", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondenceEntryDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift79Message", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-lc-documents/count": { "get": { "operationId": "import-lc-document-list-count", "tags": [ "import-lc-documents" ], "summary": "import-lc-document-list-count", "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. 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": "import-lc-document-list-count", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/count", "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": "declared-non-dto", "note": "The route returns `int`, a scalar rather than an object. There is no field tree below because there are no fields: the body is a JSON number, a 32-bit integer. This is a complete answer read from the declaration, not a gap.", "declared_type": "int", "payload": "int" } } }, "/import-lc-documents/{id}": { "delete": { "operationId": "delete-import-lCDocument", "tags": [ "import-lc-documents" ], "summary": "delete-import-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDeliveryDocumentId" } } ], "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-import-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" } ] } }, "get": { "operationId": "get-import-lCDocument-by-id", "tags": [ "import-lc-documents" ], "summary": "get-import-lCDocument-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDeliveryDocumentId" } } ], "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-import-lCDocument-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{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": "ImportLCDocumentDto", "payload": "ImportLCDocumentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DocumentNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DocumentSender", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentHolder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DocumentEntryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "PaymentDueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "OurBankCharge", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DocumentStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ShipperName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Notes", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportLCId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondenceEntryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "LcDocumentSwiftMessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LcDocumentSwift79Message", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameandAddressMessage", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountyCode", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LCAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "LCDueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "IssuingDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ConfirmationInstructions", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemainingAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "ImportLCDeliveryDocumentList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ImportLCDocumentGoodsDetailList", "declared_type": "List", "nullable": false, "collection": true }, { "name": "ImportLCDocumentReserveList", "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 }, "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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" } ] } }, "put": { "operationId": "update-import-lCDocument", "tags": [ "import-lc-documents" ], "summary": "update-import-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "beneficiaryCountyCode": { "type": "integer", "format": "int32", "x-aura-field-code": "beneficiaryCountyCode" }, "beneficiaryNameandAddressMessage": { "type": "string", "x-aura-field-code": "beneficiaryNameandAddressMessage" }, "correspondenceEntryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "correspondenceEntryDate" }, "correspondentCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "correspondentCharge" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "customerNameandAddressMessage": { "type": "string", "x-aura-field-code": "customerNameandAddressMessage" }, "demandedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "demandedAmount" }, "dischargePort": { "type": "string", "x-aura-field-code": "dischargePort" }, "documentAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "documentAmount" }, "documentEntryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "documentEntryDate" }, "documentHolder": { "type": "string", "x-aura-field-code": "documentHolder" }, "documentNumber": { "type": "string", "x-aura-field-code": "documentNumber" }, "documentSender": { "type": "string", "x-aura-field-code": "documentSender" }, "documentStatus": { "type": "string", "x-aura-field-code": "documentStatus" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "explanations": { "type": "string", "x-aura-field-code": "explanations" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importLCDeliveryDocumentList": { "type": "array", "items": { "type": "object", "properties": { "copyDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "copyDocumentCount" }, "deliveryDocumentType": { "type": "string", "x-aura-field-code": "deliveryDocumentType" }, "deliveryDocumentTypeName": { "type": "string", "x-aura-field-code": "deliveryDocumentTypeName" }, "deliveryOrder": { "type": "integer", "format": "int32", "x-aura-field-code": "deliveryOrder" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" }, "importLCDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCDocumentId" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "originalDocumentCount": { "type": "integer", "format": "int32", "x-aura-field-code": "originalDocumentCount" } }, "required": [ "copyDocumentCount", "deliveryDocumentType", "deliveryDocumentTypeName", "deliveryOrder", "groupGuid", "id", "importLCDocumentId", "invoiceDate", "invoiceNo", "originalDocumentCount" ], "x-aura-field-code": "importLCDeliveryDocumentList" } }, "importLCDocumentGoodsDetailList": { "type": "array", "items": { "type": "object", "properties": { "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "currentStatusOf45ADetail": { "type": "string", "x-aura-field-code": "currentStatusOf45ADetail" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" }, "importLCDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCDocumentId" }, "mT700Message45ADetail": { "type": "string", "x-aura-field-code": "mT700Message45ADetail" }, "quantity": { "x-aura-type": "unresolved" }, "totalValueOfGoods": { "type": "string", "x-aura-field-code": "totalValueOfGoods" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" } }, "required": [ "currencyCode", "currentStatusOf45ADetail", "goodsName", "id", "importLCDocumentId", "mT700Message45ADetail", "quantity", "totalValueOfGoods", "unit", "unitPrice" ], "x-aura-field-code": "importLCDocumentGoodsDetailList" } }, "importLCDocumentReserveList": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" }, "importLCDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCDocumentId" }, "isChecked": { "type": "boolean", "x-aura-field-code": "isChecked" }, "lcReserveENValue": { "type": "string", "x-aura-field-code": "lcReserveENValue" }, "lcReserveTRValue": { "type": "string", "x-aura-field-code": "lcReserveTRValue" } }, "required": [ "id", "importLCDocumentId", "isChecked", "lcReserveENValue", "lcReserveTRValue" ], "x-aura-field-code": "importLCDocumentReserveList" } }, "importLCId": { "type": "string", "format": "uuid", "x-aura-field-code": "importLCId" }, "lCAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "lCAmount" }, "lCDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lCDueDate" }, "latestDateofShipment": { "x-aura-type": "unresolved" }, "lcDocumentSwift79Message": { "type": "string", "x-aura-field-code": "lcDocumentSwift79Message" }, "lcDocumentSwiftMessageType": { "type": "string", "x-aura-field-code": "lcDocumentSwiftMessageType" }, "loadingPort": { "type": "string", "x-aura-field-code": "loadingPort" }, "notes": { "type": "string", "x-aura-field-code": "notes" }, "ourBankCharge": { "type": "number", "format": "decimal", "x-aura-field-code": "ourBankCharge" }, "paymentDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "paymentDueDate" }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "returningCharge": { "type": "string", "x-aura-field-code": "returningCharge" }, "returningChargePayer": { "type": "string", "x-aura-field-code": "returningChargePayer" }, "returningCourierCompany": { "type": "string", "x-aura-field-code": "returningCourierCompany" }, "returningDescription": { "type": "string", "x-aura-field-code": "returningDescription" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "shipName": { "type": "string", "x-aura-field-code": "shipName" }, "shipperName": { "type": "string", "x-aura-field-code": "shipperName" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLcDocumentStatus" }, "transferringBankAddress": { "type": "string", "x-aura-field-code": "transferringBankAddress" }, "transferringBankBicCode": { "type": "string", "x-aura-field-code": "transferringBankBicCode" }, "transferringCharge": { "type": "string", "x-aura-field-code": "transferringCharge" }, "transferringChargePayer": { "type": "string", "x-aura-field-code": "transferringChargePayer" }, "transferringCourierCompany": { "type": "string", "x-aura-field-code": "transferringCourierCompany" }, "transferringDescription": { "type": "string", "x-aura-field-code": "transferringDescription" } }, "required": [ "accountingBusinessKey", "beneficiaryCountyCode", "beneficiaryNameandAddressMessage", "correspondenceEntryDate", "correspondentCharge", "currencyCode", "customerId", "customerName", "customerNameandAddressMessage", "demandedAmount", "dischargePort", "documentAmount", "documentEntryDate", "documentHolder", "documentNumber", "documentSender", "documentStatus", "documentType", "explanations", "groupGuid", "importLCDeliveryDocumentList", "importLCDocumentGoodsDetailList", "importLCDocumentReserveList", "importLCId", "lCAmount", "lCDueDate", "latestDateofShipment", "lcDocumentSwift79Message", "lcDocumentSwiftMessageType", "loadingPort", "notes", "ourBankCharge", "paymentDueDate", "receiverBankBICCode", "reference", "remainingAmount", "returningCharge", "returningChargePayer", "returningCourierCompany", "returningDescription", "senderReference", "shipName", "shipperName", "status", "transferringBankAddress", "transferringBankBicCode", "transferringCharge", "transferringChargePayer", "transferringCourierCompany", "transferringDescription" ] } } } }, "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": 50, "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-import-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DemandedAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentSender", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentHolder", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentEntryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "OurBankCharge", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipperName", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": null, "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": null, "nullable": false, "collection": false }, { "name": "Notes", "declared_type": null, "nullable": false, "collection": false }, { "name": "Explanations", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportLCId", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningCourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturningDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankBicCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringBankAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCharge", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringCourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferringDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondenceEntryDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "LcDocumentSwift79Message", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": null, "nullable": false, "collection": false }, { "name": "LCAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryNameandAddressMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LCDueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemainingAmount", "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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" } ] } } }, "/import-lc-documents/{id}/return-to-source": { "put": { "operationId": "return-to-source-import-lCDocument", "tags": [ "import-lc-documents" ], "summary": "return-to-source-import-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLcDocumentStatus" } }, "required": [ "status" ] } } } }, "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": "return-to-source-import-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{id}/return-to-source", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" } ] } } }, "/import-lc-documents/{id}/set-cancelled": { "put": { "operationId": "set-cancelled-import-lCDocument", "tags": [ "import-lc-documents" ], "summary": "set-cancelled-import-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLcDocumentStatus" } }, "required": [ "status" ] } } } }, "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": "set-cancelled-import-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{id}/set-cancelled", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_65", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_STATUS_CHANGE" } ] } } }, "/import-lc-documents/{id}/set-reserved-status": { "put": { "operationId": "set-reserved-status-import-lCDocument", "tags": [ "import-lc-documents" ], "summary": "set-reserved-status-import-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLcDocumentStatus" } }, "required": [ "status" ] } } } }, "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": "set-reserved-status-import-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{id}/set-reserved-status", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" } ] } } }, "/import-lc-documents/{id}/set-returned": { "put": { "operationId": "set-returned-import-lCDocument", "tags": [ "import-lc-documents" ], "summary": "set-returned-import-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLcDocumentStatus" } }, "required": [ "status" ] } } } }, "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": "set-returned-import-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{id}/set-returned", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" } ] } } }, "/import-lc-documents/{id}/set-status": { "put": { "operationId": "set-import-lCDocument-status", "tags": [ "import-lc-documents" ], "summary": "set-import-lCDocument-status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLcDocumentStatus" } }, "required": [ "status" ] } } } }, "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": "set-import-lCDocument-status", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{id}/set-status", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" } ] } } }, "/import-lc-documents/{id}/transfer": { "put": { "operationId": "transfer-import-lCDocument", "tags": [ "import-lc-documents" ], "summary": "transfer-import-lCDocument", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importLcDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLcDocumentStatus" } }, "required": [ "status" ] } } } }, "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": "transfer-import-lCDocument", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-lc-documents/{id}/transfer", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_55", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LC_DOCUMENT_NOT_FOUND" } ] } } }, "/import-letter-credits": { "post": { "operationId": "create-import-letter-credit", "tags": [ "import-letter-credits" ], "summary": "create-import-letter-credit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-import-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-letter-credits/maturity-tracking": { "get": { "operationId": "get-lCMaturity-tracking", "tags": [ "import-letter-credits" ], "summary": "get-lCMaturity-tracking", "parameters": [ { "name": "currencyCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "currencyCode" } }, { "name": "customerId", "in": "query", "required": false, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } }, { "name": "demandedAmountEnd", "in": "query", "required": false, "schema": { "type": "number", "format": "decimal", "x-aura-field-code": "demandedAmountEnd" } }, { "name": "demandedAmountStart", "in": "query", "required": false, "schema": { "type": "number", "format": "decimal", "x-aura-field-code": "demandedAmountStart" } }, { "name": "documentAmountEnd", "in": "query", "required": false, "schema": { "type": "number", "format": "decimal", "x-aura-field-code": "documentAmountEnd" } }, { "name": "documentAmountStart", "in": "query", "required": false, "schema": { "type": "number", "format": "decimal", "x-aura-field-code": "documentAmountStart" } }, { "name": "documentEntryDateEnd", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "documentEntryDateEnd" } }, { "name": "documentEntryDateStart", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "documentEntryDateStart" } }, { "name": "documentStatus", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "documentStatus" } }, { "name": "documentType", "in": "query", "required": false, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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" } }, { "name": "paymentDueDateEnd", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "paymentDueDateEnd" } }, { "name": "paymentDueDateStart", "in": "query", "required": false, "schema": { "type": "string", "format": "date-time", "x-aura-field-code": "paymentDueDateStart" } }, { "name": "paymentStatus", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "paymentStatus" } }, { "name": "reference", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "reference" } }, { "name": "senderReference", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "senderReference" } } ], "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": 20 }, "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": "get-lCMaturity-tracking", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/maturity-tracking", "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 }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentAmountStart", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentAmountEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "DemandedAmountStart", "declared_type": null, "nullable": false, "collection": false }, { "name": "DemandedAmountEnd", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentDueDateStart", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDueDateEnd", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentEntryDateStart", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentEntryDateEnd", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentStatus", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "List", "envelopes": [ "List" ], "payload": "ImportLCMaturityTrackingDto", "collection": true, "members": [ { "name": "ImportLCDocumentId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "DemandedAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentEntryDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "DocumentNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "PaymentDueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CorrespondentCharge", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "DocumentStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ImportLCId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "PaymentStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-letter-credits/{id}": { "delete": { "operationId": "delete-import-letter-credit", "tags": [ "import-letter-credits" ], "summary": "delete-import-letter-credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "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-import-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/{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_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" } ] } }, "put": { "operationId": "update-import-letter-credit", "tags": [ "import-letter-credits" ], "summary": "update-import-letter-credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "x-aura-type": "unresolved" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "additionalAmountCovered": { "type": "string", "x-aura-field-code": "additionalAmountCovered" }, "additionalConditionsMessage": { "type": "string", "x-aura-field-code": "additionalConditionsMessage" }, "adviseThroughBank": { "type": "string", "x-aura-field-code": "adviseThroughBank" }, "amendmentChargePayer": { "type": "integer", "format": "int32", "x-aura-field-code": "amendmentChargePayer" }, "amendmentChargePayerNarrative": { "type": "string", "x-aura-field-code": "amendmentChargePayerNarrative" }, "applicableRule": { "type": "integer", "format": "int32", "x-aura-field-code": "applicableRule" }, "applicableRuleMessage": { "type": "string", "x-aura-field-code": "applicableRuleMessage" }, "applicableRuleName": { "type": "string", "x-aura-field-code": "applicableRuleName" }, "applicantBankBICCode": { "type": "string", "x-aura-field-code": "applicantBankBICCode" }, "availableBICCode": { "type": "string", "x-aura-field-code": "availableBICCode" }, "availableWith": { "type": "integer", "format": "int32", "x-aura-field-code": "availableWith" }, "availableWithName": { "type": "string", "x-aura-field-code": "availableWithName" }, "beneficiaryCountyCode": { "type": "integer", "format": "int32", "x-aura-field-code": "beneficiaryCountyCode" }, "beneficiaryNameandAddressMessage": { "type": "string", "x-aura-field-code": "beneficiaryNameandAddressMessage" }, "cancellationRequest": { "type": "string", "x-aura-field-code": "cancellationRequest" }, "chargeDescription": { "type": "string", "x-aura-field-code": "chargeDescription" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "chargeDetailName": { "type": "string", "x-aura-field-code": "chargeDetailName" }, "confirmationInstructions": { "type": "integer", "format": "int32", "x-aura-field-code": "confirmationInstructions" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "customerNameandAddressMessage": { "type": "string", "x-aura-field-code": "customerNameandAddressMessage" }, "dateOfExpiry": { "x-aura-type": "unresolved" }, "deliveryPlace": { "type": "string", "x-aura-field-code": "deliveryPlace" }, "deliveryVehicle": { "type": "string", "x-aura-field-code": "deliveryVehicle" }, "dischargePort": { "type": "string", "x-aura-field-code": "dischargePort" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "documentsRequiredsMessage": { "type": "string", "x-aura-field-code": "documentsRequiredsMessage" }, "draftsAt": { "type": "string", "x-aura-field-code": "draftsAt" }, "draftsNarrative": { "type": "string", "x-aura-field-code": "draftsNarrative" }, "draweeBICCode": { "type": "string", "x-aura-field-code": "draweeBICCode" }, "formofDocumentaryCredit": { "type": "integer", "format": "int32", "x-aura-field-code": "formofDocumentaryCredit" }, "formofDocumentaryCreditName": { "type": "string", "x-aura-field-code": "formofDocumentaryCreditName" }, "goodsCurrency": { "type": "string", "x-aura-field-code": "goodsCurrency" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "goodsType": { "type": "string", "x-aura-field-code": "goodsType" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "instructionstothePaying": { "type": "string", "x-aura-field-code": "instructionstothePaying" }, "instructionstothePayingMessage": { "type": "string", "x-aura-field-code": "instructionstothePayingMessage" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "issuingDate": { "x-aura-type": "unresolved" }, "lCAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "lCAmount" }, "lCDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lCDueDate" }, "latestDateofShipment": { "x-aura-type": "unresolved" }, "loadingPort": { "type": "string", "x-aura-field-code": "loadingPort" }, "lowerTolerance": { "type": "integer", "format": "int32", "x-aura-field-code": "lowerTolerance" }, "messagePurpose": { "type": "string", "x-aura-field-code": "messagePurpose" }, "mixedPaymentDetails": { "type": "string", "x-aura-field-code": "mixedPaymentDetails" }, "negotiationDetails": { "type": "string", "x-aura-field-code": "negotiationDetails" }, "partialShipments": { "type": "integer", "format": "int32", "x-aura-field-code": "partialShipments" }, "partialShipmentsName": { "type": "string", "x-aura-field-code": "partialShipmentsName" }, "periodforPresentationinDays": { "type": "integer", "format": "int32", "x-aura-field-code": "periodforPresentationinDays" }, "periodforPresentationinDaysDescription": { "type": "string", "x-aura-field-code": "periodforPresentationinDaysDescription" }, "placeOfExpiry": { "type": "string", "x-aura-field-code": "placeOfExpiry" }, "quantity": { "type": "integer", "format": "int32", "x-aura-field-code": "quantity" }, "receiptPlace": { "type": "string", "x-aura-field-code": "receiptPlace" }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "reimbursmentBank": { "type": "string", "x-aura-field-code": "reimbursmentBank" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "requestedConfirmationParty": { "type": "string", "x-aura-field-code": "requestedConfirmationParty" }, "riskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "riskAmount" }, "sendertoReceiverInformation": { "type": "string", "x-aura-field-code": "sendertoReceiverInformation" }, "shipmentInfoMessage": { "type": "string", "x-aura-field-code": "shipmentInfoMessage" }, "shipmentPeriod": { "type": "string", "x-aura-field-code": "shipmentPeriod" }, "specialPaymentConditionsforBankOnly": { "type": "string", "x-aura-field-code": "specialPaymentConditionsforBankOnly" }, "specialPaymentConditionsforBeneficiary": { "type": "string", "x-aura-field-code": "specialPaymentConditionsforBeneficiary" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLetterCreditStatus" }, "totalGoodsAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalGoodsAmount" }, "transhipment": { "type": "integer", "format": "int32", "x-aura-field-code": "transhipment" }, "transhipmentName": { "type": "string", "x-aura-field-code": "transhipmentName" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" }, "upperTolerance": { "type": "integer", "format": "int32", "x-aura-field-code": "upperTolerance" } }, "required": [ "accountNumber", "accountingBusinessKey", "additionalAmountCovered", "additionalConditionsMessage", "adviseThroughBank", "amendmentChargePayer", "amendmentChargePayerNarrative", "applicableRule", "applicableRuleMessage", "applicableRuleName", "applicantBankBICCode", "availableBICCode", "availableWith", "availableWithName", "beneficiaryCountyCode", "beneficiaryNameandAddressMessage", "cancellationRequest", "chargeDescription", "chargeDetail", "chargeDetailName", "confirmationInstructions", "currencyCode", "customerId", "customerName", "customerNameandAddressMessage", "dateOfExpiry", "deliveryPlace", "deliveryVehicle", "dischargePort", "documentType", "documentsRequiredsMessage", "draftsAt", "draftsNarrative", "draweeBICCode", "formofDocumentaryCredit", "formofDocumentaryCreditName", "goodsCurrency", "goodsName", "goodsType", "groupGuid", "instructionstothePaying", "instructionstothePayingMessage", "invoiceDate", "invoiceNo", "issuingDate", "lCAmount", "lCDueDate", "latestDateofShipment", "loadingPort", "lowerTolerance", "messagePurpose", "mixedPaymentDetails", "negotiationDetails", "partialShipments", "partialShipmentsName", "periodforPresentationinDays", "periodforPresentationinDaysDescription", "placeOfExpiry", "quantity", "receiptPlace", "receiverBankBICCode", "reference", "reimbursmentBank", "remainingAmount", "requestedConfirmationParty", "riskAmount", "sendertoReceiverInformation", "shipmentInfoMessage", "shipmentPeriod", "specialPaymentConditionsforBankOnly", "specialPaymentConditionsforBeneficiary", "status", "totalGoodsAmount", "transhipment", "transhipmentName", "unit", "unitPrice", "upperTolerance" ] } } } }, "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": 78, "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-import-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LCAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UpperTolerance", "declared_type": null, "nullable": false, "collection": false }, { "name": "LowerTolerance", "declared_type": null, "nullable": false, "collection": false }, { "name": "Transferable", "declared_type": null, "nullable": true, "collection": false }, { "name": "Confirmed", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverBankBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormofDocumentaryCredit", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormofDocumentaryCreditName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRule", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRuleName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRuleMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LCDueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "DateOfExpiry", "declared_type": null, "nullable": true, "collection": false }, { "name": "IssuingDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PlaceOfExpiry", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdditionalAmountCovered", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicantBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraweeBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWith", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithName", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraftsAt", "declared_type": null, "nullable": false, "collection": false }, { "name": "MixedPaymentDetails", "declared_type": null, "nullable": false, "collection": false }, { "name": "PartialShipments", "declared_type": null, "nullable": false, "collection": false }, { "name": "PartialShipmentsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Transhipment", "declared_type": null, "nullable": false, "collection": false }, { "name": "TranshipmentName", "declared_type": null, "nullable": false, "collection": false }, { "name": "NegotiationDetails", "declared_type": null, "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": null, "nullable": true, "collection": false }, { "name": "ShipmentPeriod", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "GoodsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": true, "collection": false }, { "name": "GoodsCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalGoodsAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryVehicle", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBeneficiary", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBankOnly", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetailName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "PeriodforPresentationinDays", "declared_type": null, "nullable": true, "collection": false }, { "name": "PeriodforPresentationinDaysDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ConfirmationInstructions", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdvisingBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdvisingBankBICBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdviseThroughBank", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendertoReceiverInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionstothePaying", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdditionalConditionsMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentsRequiredsMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipmentInfoMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionstothePayingMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraftsNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "RiskAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "MessagePurpose", "declared_type": null, "nullable": false, "collection": false }, { "name": "CancellationRequest", "declared_type": null, "nullable": false, "collection": false }, { "name": "AmendmentChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "AmendmentChargePayerNarrative", "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_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" } ] } } }, "/import-letter-credits/{id}/change-request": { "post": { "operationId": "change-request-import-letter-credit", "tags": [ "import-letter-credits" ], "summary": "change-request-import-letter-credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "x-aura-type": "unresolved" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "additionalAmountCovered": { "type": "string", "x-aura-field-code": "additionalAmountCovered" }, "additionalConditionsMessage": { "type": "string", "x-aura-field-code": "additionalConditionsMessage" }, "adviseThroughBank": { "type": "string", "x-aura-field-code": "adviseThroughBank" }, "amendmentChargePayer": { "type": "integer", "format": "int32", "x-aura-field-code": "amendmentChargePayer" }, "amendmentChargePayerNarrative": { "type": "string", "x-aura-field-code": "amendmentChargePayerNarrative" }, "applicableRule": { "type": "integer", "format": "int32", "x-aura-field-code": "applicableRule" }, "applicableRuleMessage": { "type": "string", "x-aura-field-code": "applicableRuleMessage" }, "applicableRuleName": { "type": "string", "x-aura-field-code": "applicableRuleName" }, "applicantBankBICCode": { "type": "string", "x-aura-field-code": "applicantBankBICCode" }, "availableBICCode": { "type": "string", "x-aura-field-code": "availableBICCode" }, "availableWith": { "type": "integer", "format": "int32", "x-aura-field-code": "availableWith" }, "availableWithName": { "type": "string", "x-aura-field-code": "availableWithName" }, "beneficiaryCountyCode": { "type": "integer", "format": "int32", "x-aura-field-code": "beneficiaryCountyCode" }, "beneficiaryNameandAddressMessage": { "type": "string", "x-aura-field-code": "beneficiaryNameandAddressMessage" }, "cancellationRequest": { "type": "string", "x-aura-field-code": "cancellationRequest" }, "changeRequestReason": { "type": "string", "x-aura-field-code": "changeRequestReason" }, "chargeDescription": { "type": "string", "x-aura-field-code": "chargeDescription" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "chargeDetailName": { "type": "string", "x-aura-field-code": "chargeDetailName" }, "confirmationInstructions": { "type": "integer", "format": "int32", "x-aura-field-code": "confirmationInstructions" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "customerName": { "type": "string", "x-aura-field-code": "customerName" }, "customerNameandAddressMessage": { "type": "string", "x-aura-field-code": "customerNameandAddressMessage" }, "dateOfExpiry": { "x-aura-type": "unresolved" }, "deliveryPlace": { "type": "string", "x-aura-field-code": "deliveryPlace" }, "deliveryVehicle": { "type": "string", "x-aura-field-code": "deliveryVehicle" }, "dischargePort": { "type": "string", "x-aura-field-code": "dischargePort" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "documentsRequiredsMessage": { "type": "string", "x-aura-field-code": "documentsRequiredsMessage" }, "draftsAt": { "type": "string", "x-aura-field-code": "draftsAt" }, "draftsNarrative": { "type": "string", "x-aura-field-code": "draftsNarrative" }, "draweeBICCode": { "type": "string", "x-aura-field-code": "draweeBICCode" }, "formofDocumentaryCredit": { "type": "integer", "format": "int32", "x-aura-field-code": "formofDocumentaryCredit" }, "formofDocumentaryCreditName": { "type": "string", "x-aura-field-code": "formofDocumentaryCreditName" }, "goodsCurrency": { "type": "string", "x-aura-field-code": "goodsCurrency" }, "goodsName": { "type": "string", "x-aura-field-code": "goodsName" }, "goodsType": { "type": "string", "x-aura-field-code": "goodsType" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "instructionstothePaying": { "type": "string", "x-aura-field-code": "instructionstothePaying" }, "instructionstothePayingMessage": { "type": "string", "x-aura-field-code": "instructionstothePayingMessage" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "issuingDate": { "x-aura-type": "unresolved" }, "lCAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "lCAmount" }, "lCDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "lCDueDate" }, "latestDateofShipment": { "x-aura-type": "unresolved" }, "loadingPort": { "type": "string", "x-aura-field-code": "loadingPort" }, "lowerTolerance": { "type": "integer", "format": "int32", "x-aura-field-code": "lowerTolerance" }, "messagePurpose": { "type": "string", "x-aura-field-code": "messagePurpose" }, "mixedPaymentDetails": { "type": "string", "x-aura-field-code": "mixedPaymentDetails" }, "negotiationDetails": { "type": "string", "x-aura-field-code": "negotiationDetails" }, "partialShipments": { "type": "integer", "format": "int32", "x-aura-field-code": "partialShipments" }, "partialShipmentsName": { "type": "string", "x-aura-field-code": "partialShipmentsName" }, "periodforPresentationinDays": { "type": "integer", "format": "int32", "x-aura-field-code": "periodforPresentationinDays" }, "periodforPresentationinDaysDescription": { "type": "string", "x-aura-field-code": "periodforPresentationinDaysDescription" }, "placeOfExpiry": { "type": "string", "x-aura-field-code": "placeOfExpiry" }, "quantity": { "type": "integer", "format": "int32", "x-aura-field-code": "quantity" }, "receiptPlace": { "type": "string", "x-aura-field-code": "receiptPlace" }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "reimbursmentBank": { "type": "string", "x-aura-field-code": "reimbursmentBank" }, "remainingAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "remainingAmount" }, "requestedConfirmationParty": { "type": "string", "x-aura-field-code": "requestedConfirmationParty" }, "riskAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "riskAmount" }, "sendertoReceiverInformation": { "type": "string", "x-aura-field-code": "sendertoReceiverInformation" }, "shipmentInfoMessage": { "type": "string", "x-aura-field-code": "shipmentInfoMessage" }, "shipmentPeriod": { "type": "string", "x-aura-field-code": "shipmentPeriod" }, "specialPaymentConditionsforBankOnly": { "type": "string", "x-aura-field-code": "specialPaymentConditionsforBankOnly" }, "specialPaymentConditionsforBeneficiary": { "type": "string", "x-aura-field-code": "specialPaymentConditionsforBeneficiary" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLetterCreditStatus" }, "totalGoodsAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "totalGoodsAmount" }, "transhipment": { "type": "integer", "format": "int32", "x-aura-field-code": "transhipment" }, "transhipmentName": { "type": "string", "x-aura-field-code": "transhipmentName" }, "unit": { "x-aura-type": "unresolved" }, "unitPrice": { "type": "number", "format": "decimal", "x-aura-field-code": "unitPrice" }, "upperTolerance": { "type": "integer", "format": "int32", "x-aura-field-code": "upperTolerance" } }, "required": [ "accountNumber", "accountingBusinessKey", "additionalAmountCovered", "additionalConditionsMessage", "adviseThroughBank", "amendmentChargePayer", "amendmentChargePayerNarrative", "applicableRule", "applicableRuleMessage", "applicableRuleName", "applicantBankBICCode", "availableBICCode", "availableWith", "availableWithName", "beneficiaryCountyCode", "beneficiaryNameandAddressMessage", "cancellationRequest", "changeRequestReason", "chargeDescription", "chargeDetail", "chargeDetailName", "confirmationInstructions", "currencyCode", "customerId", "customerName", "customerNameandAddressMessage", "dateOfExpiry", "deliveryPlace", "deliveryVehicle", "dischargePort", "documentType", "documentsRequiredsMessage", "draftsAt", "draftsNarrative", "draweeBICCode", "formofDocumentaryCredit", "formofDocumentaryCreditName", "goodsCurrency", "goodsName", "goodsType", "groupGuid", "instructionstothePaying", "instructionstothePayingMessage", "invoiceDate", "invoiceNo", "issuingDate", "lCAmount", "lCDueDate", "latestDateofShipment", "loadingPort", "lowerTolerance", "messagePurpose", "mixedPaymentDetails", "negotiationDetails", "partialShipments", "partialShipmentsName", "periodforPresentationinDays", "periodforPresentationinDaysDescription", "placeOfExpiry", "quantity", "receiptPlace", "receiverBankBICCode", "reference", "reimbursmentBank", "remainingAmount", "requestedConfirmationParty", "riskAmount", "sendertoReceiverInformation", "shipmentInfoMessage", "shipmentPeriod", "specialPaymentConditionsforBankOnly", "specialPaymentConditionsforBeneficiary", "status", "totalGoodsAmount", "transhipment", "transhipmentName", "unit", "unitPrice", "upperTolerance" ] } } } }, "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": 79, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "change-request-import-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/{id}/change-request", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": true, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": true, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": true, "collection": false }, { "name": "LCAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "RemainingAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": true, "collection": false }, { "name": "UpperTolerance", "declared_type": null, "nullable": false, "collection": false }, { "name": "LowerTolerance", "declared_type": null, "nullable": false, "collection": false }, { "name": "Transferable", "declared_type": null, "nullable": true, "collection": false }, { "name": "Confirmed", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryCountyCode", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": null, "nullable": true, "collection": false }, { "name": "ReceiverBankBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsType", "declared_type": null, "nullable": true, "collection": false }, { "name": "FormofDocumentaryCredit", "declared_type": null, "nullable": false, "collection": false }, { "name": "FormofDocumentaryCreditName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRule", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRuleName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicableRuleMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "LCDueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "DateOfExpiry", "declared_type": null, "nullable": true, "collection": false }, { "name": "IssuingDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PlaceOfExpiry", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdditionalAmountCovered", "declared_type": null, "nullable": false, "collection": false }, { "name": "ApplicantBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraweeBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWith", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvailableWithName", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraftsAt", "declared_type": null, "nullable": false, "collection": false }, { "name": "MixedPaymentDetails", "declared_type": null, "nullable": false, "collection": false }, { "name": "PartialShipments", "declared_type": null, "nullable": false, "collection": false }, { "name": "PartialShipmentsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Transhipment", "declared_type": null, "nullable": false, "collection": false }, { "name": "TranshipmentName", "declared_type": null, "nullable": false, "collection": false }, { "name": "NegotiationDetails", "declared_type": null, "nullable": false, "collection": false }, { "name": "LatestDateofShipment", "declared_type": null, "nullable": true, "collection": false }, { "name": "ShipmentPeriod", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "GoodsName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Quantity", "declared_type": null, "nullable": true, "collection": false }, { "name": "Unit", "declared_type": null, "nullable": false, "collection": false }, { "name": "UnitPrice", "declared_type": null, "nullable": true, "collection": false }, { "name": "GoodsCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TotalGoodsAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "DeliveryVehicle", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryType", "declared_type": null, "nullable": false, "collection": false }, { "name": "DeliveryPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiptPlace", "declared_type": null, "nullable": false, "collection": false }, { "name": "DischargePort", "declared_type": null, "nullable": false, "collection": false }, { "name": "LoadingPort", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBeneficiary", "declared_type": null, "nullable": false, "collection": false }, { "name": "SpecialPaymentConditionsforBankOnly", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetailName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "PeriodforPresentationinDays", "declared_type": null, "nullable": true, "collection": false }, { "name": "PeriodforPresentationinDaysDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "ConfirmationInstructions", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RequestConfirmationPartyBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReimbursementBankBICCodeBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdvisingBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdvisingBankBICBankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdviseThroughBank", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendertoReceiverInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionstothePaying", "declared_type": null, "nullable": false, "collection": false }, { "name": "AdditionalConditionsMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentsRequiredsMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "ShipmentInfoMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionstothePayingMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "DraftsNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerNameandAddressMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "RiskAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "MessagePurpose", "declared_type": null, "nullable": false, "collection": false }, { "name": "CancellationRequest", "declared_type": null, "nullable": false, "collection": false }, { "name": "AmendmentChargePayer", "declared_type": null, "nullable": false, "collection": false }, { "name": "AmendmentChargePayerNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChangeRequestReason", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" } ] } } }, "/import-letter-credits/{id}/set-cancelled": { "put": { "operationId": "set-cancelled-import-letter-credit", "tags": [ "import-letter-credits" ], "summary": "set-cancelled-import-letter-credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLetterCreditStatus" } }, "required": [ "status" ] } } } }, "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": "set-cancelled-import-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/{id}/set-cancelled", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_58", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_CANNOT_BE_CANCELLED" } ] } } }, "/import-letter-credits/{id}/set-closed": { "put": { "operationId": "set-closed-import-letter-credit", "tags": [ "import-letter-credits" ], "summary": "set-closed-import-letter-credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLetterCreditStatus" } }, "required": [ "status" ] } } } }, "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": "set-closed-import-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/{id}/set-closed", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_59", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_CANNOT_BE_CLOSED" }, { "code": "ERR_FRGN_TRD_61", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_HAS_REMAINING_AMOUNT" } ] } } }, "/import-letter-credits/{id}/set-feedback-maturity": { "put": { "operationId": "set-feedback-import-lCMaturity", "tags": [ "import-letter-credits" ], "summary": "set-feedback-import-lCMaturity", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "feedbackDate": { "type": "string", "format": "date-time", "x-aura-field-code": "feedbackDate" }, "feedbackMessage": { "type": "string", "x-aura-field-code": "feedbackMessage" }, "feedbackStatus": { "type": "string", "x-aura-field-code": "feedbackStatus" } }, "required": [ "feedbackDate", "feedbackMessage", "feedbackStatus" ] } } } }, "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": "set-feedback-import-lCMaturity", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/{id}/set-feedback-maturity", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "FeedbackMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "FeedbackStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "FeedbackDate", "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_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_62", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NO_EXPIRY_DATE" }, { "code": "ERR_FRGN_TRD_63", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_NEAR_MATURITY" } ] } } }, "/import-letter-credits/{id}/set-returned": { "put": { "operationId": "set-returned-import-letter-credit", "tags": [ "import-letter-credits" ], "summary": "set-returned-import-letter-credit", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLetterCreditStatus" } }, "required": [ "status" ] } } } }, "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": "set-returned-import-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/{id}/set-returned", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_60", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_CANNOT_BE_RETURNED" } ] } } }, "/import-letter-credits/{id}/set-status": { "put": { "operationId": "set-import-letter-credit-status", "tags": [ "import-letter-credits" ], "summary": "set-import-letter-credit-status", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "importLetterCreditId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "integer", "format": "int32", "x-aura-field-code": "importLetterCreditStatus" } }, "required": [ "status" ] } } } }, "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": "set-import-letter-credit-status", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-letter-credits/{id}/set-status", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "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_FRGN_TRD_57", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_LETTER_CREDIT_NOT_FOUND" } ] } } }, "/import-transfers": { "get": { "operationId": "get-import-transfer-list", "tags": [ "import-transfers" ], "summary": "get-import-transfer-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-import-transfer-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-transfers", "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": "ImportTransferDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EftId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TbfUniqueId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DocumentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FxSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TbfConfirmationStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Binder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferID", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TransferDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "TransferAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ReceiverName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiverCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterisDifferentfromBuyer", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Exporter", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DomesticExpenses", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TransferCurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RecordStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionCost", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "IdentityType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IdentityNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CreatedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ModifiedBy", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-import-transfer", "tags": [ "import-transfers" ], "summary": "create-import-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binder": { "type": "string", "x-aura-field-code": "binder" }, "branchNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "branchNumber" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "documentId": { "x-aura-type": "unresolved" }, "documentNo": { "type": "string", "x-aura-field-code": "documentNo" }, "domesticExpenses": { "type": "number", "format": "decimal", "x-aura-field-code": "domesticExpenses" }, "eftId": { "type": "string", "format": "uuid", "x-aura-field-code": "eftId" }, "exporter": { "type": "string", "x-aura-field-code": "exporter" }, "exporterCountry": { "x-aura-type": "unresolved" }, "exporterisDifferentfromBuyer": { "type": "boolean", "x-aura-field-code": "exporterisDifferentfromBuyer" }, "fxSource": { "type": "string", "x-aura-field-code": "fxSource" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "identityNumber": { "x-aura-type": "unresolved" }, "identityType": { "x-aura-type": "unresolved" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "receiverCountry": { "type": "string", "x-aura-field-code": "receiverCountry" }, "receiverName": { "type": "string", "x-aura-field-code": "receiverName" }, "recordStatus": { "x-aura-type": "unresolved" }, "swiftTransferId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "tbfConfirmationStatus": { "type": "string", "x-aura-field-code": "tbfConfirmationStatus" }, "tbfUniqueId": { "type": "string", "format": "uuid", "x-aura-field-code": "tbfUniqueId" }, "transactionCost": { "type": "number", "format": "decimal", "x-aura-field-code": "transactionCost" }, "transferAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "transferAmount" }, "transferCurrencyCode": { "type": "string", "x-aura-field-code": "transferCurrencyCode" }, "transferDate": { "type": "string", "format": "date-time", "x-aura-field-code": "transferDate" }, "transferID": { "type": "string", "format": "uuid", "x-aura-field-code": "transferID" }, "transferType": { "x-aura-type": "unresolved" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "binder", "branchNumber", "currencyCode", "customerId", "documentId", "documentNo", "domesticExpenses", "eftId", "exporter", "exporterCountry", "exporterisDifferentfromBuyer", "fxSource", "groupGuid", "identityNumber", "identityType", "invoiceDate", "invoiceNo", "receiverCountry", "receiverName", "recordStatus", "swiftTransferId", "tbfConfirmationStatus", "tbfUniqueId", "transactionCost", "transferAmount", "transferCurrencyCode", "transferDate", "transferID", "transferType", "valueDate" ] } } } }, "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": 30, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-import-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-transfers", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "EftId", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "TbfUniqueId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "FxSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "TbfConfirmationStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransferType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Binder", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferID", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterisDifferentfromBuyer", "declared_type": null, "nullable": true, "collection": false }, { "name": "Exporter", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "DomesticExpenses", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferCurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RecordStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionCost", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentityType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentityNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/import-transfers/{id}": { "delete": { "operationId": "delete-import-transfer", "tags": [ "import-transfers" ], "summary": "delete-import-transfer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importTransferId" } } ], "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-import-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-transfers/{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_FRGN_TRD_66", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_TRANSFER_NOT_FOUND" } ] } }, "get": { "operationId": "get-import-transfer-by-id", "tags": [ "import-transfers" ], "summary": "get-import-transfer-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importTransferId" } } ], "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-import-transfer-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-transfers/{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": "ImportTransferDto", "payload": "ImportTransferDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EftId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BranchNumber", "declared_type": "int", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TbfUniqueId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "DocumentId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "FxSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TbfConfirmationStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid?", "nullable": true, "collection": false }, { "name": "CustomerName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Binder", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransferID", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "TransferDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "TransferAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ReceiverName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiverCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterisDifferentfromBuyer", "declared_type": "bool?", "nullable": true, "collection": false }, { "name": "Exporter", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DomesticExpenses", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "TransferCurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RecordStatus", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionCost", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "IdentityType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IdentityNumber", "declared_type": "long", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CreatedBy", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ModifiedDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "ModifiedBy", "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_FRGN_TRD_66", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_TRANSFER_NOT_FOUND" } ] } }, "put": { "operationId": "update-import-transfer", "tags": [ "import-transfers" ], "summary": "update-import-transfer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "importTransferId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "binder": { "type": "string", "x-aura-field-code": "binder" }, "branchNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "branchNumber" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "documentId": { "x-aura-type": "unresolved" }, "documentNo": { "type": "string", "x-aura-field-code": "documentNo" }, "domesticExpenses": { "type": "number", "format": "decimal", "x-aura-field-code": "domesticExpenses" }, "eftId": { "type": "string", "format": "uuid", "x-aura-field-code": "eftId" }, "exporter": { "type": "string", "x-aura-field-code": "exporter" }, "exporterCountry": { "x-aura-type": "unresolved" }, "exporterisDifferentfromBuyer": { "type": "boolean", "x-aura-field-code": "exporterisDifferentfromBuyer" }, "fxSource": { "type": "string", "x-aura-field-code": "fxSource" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "identityNumber": { "x-aura-type": "unresolved" }, "identityType": { "x-aura-type": "unresolved" }, "invoiceDate": { "type": "string", "format": "date-time", "x-aura-field-code": "invoiceDate" }, "invoiceNo": { "type": "string", "x-aura-field-code": "invoiceNo" }, "receiverCountry": { "type": "string", "x-aura-field-code": "receiverCountry" }, "receiverName": { "type": "string", "x-aura-field-code": "receiverName" }, "recordStatus": { "x-aura-type": "unresolved" }, "swiftTransferId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "tbfConfirmationStatus": { "type": "string", "x-aura-field-code": "tbfConfirmationStatus" }, "tbfUniqueId": { "type": "string", "format": "uuid", "x-aura-field-code": "tbfUniqueId" }, "transactionCost": { "type": "number", "format": "decimal", "x-aura-field-code": "transactionCost" }, "transferAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "transferAmount" }, "transferCurrencyCode": { "type": "string", "x-aura-field-code": "transferCurrencyCode" }, "transferDate": { "type": "string", "format": "date-time", "x-aura-field-code": "transferDate" }, "transferID": { "type": "string", "format": "uuid", "x-aura-field-code": "transferID" }, "transferType": { "x-aura-type": "unresolved" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "binder", "branchNumber", "currencyCode", "customerId", "documentId", "documentNo", "domesticExpenses", "eftId", "exporter", "exporterCountry", "exporterisDifferentfromBuyer", "fxSource", "groupGuid", "identityNumber", "identityType", "invoiceDate", "invoiceNo", "receiverCountry", "receiverName", "recordStatus", "swiftTransferId", "tbfConfirmationStatus", "tbfUniqueId", "transactionCost", "transferAmount", "transferCurrencyCode", "transferDate", "transferID", "transferType", "valueDate" ] } } } }, "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": 30, "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-import-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "import-transfers/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "EftId", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "TbfUniqueId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "FxSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "TbfConfirmationStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransferType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Binder", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferID", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterisDifferentfromBuyer", "declared_type": null, "nullable": true, "collection": false }, { "name": "Exporter", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExporterCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "InvoiceNo", "declared_type": null, "nullable": false, "collection": false }, { "name": "DomesticExpenses", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferCurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "RecordStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionCost", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentityType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IdentityNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftTransferId", "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_FRGN_TRD_66", "status": 400, "message": null, "message_available": false, "constant_name": "IMPORT_TRANSFER_NOT_FOUND" } ] } } }, "/incoming-letter-of-guarantees": { "post": { "operationId": "create-incoming-letter-of-guarantee", "tags": [ "incoming-letter-of-guarantees" ], "summary": "create-incoming-letter-of-guarantee", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-incoming-letter-of-guarantee", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "incoming-letter-of-guarantees", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/kernel/compensating-events": { "get": { "operationId": "foreign-trade-get-compensating-event-list", "tags": [ "kernel" ], "summary": "foreign-trade-get-compensating-event-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "foreign-trade-get-compensating-event-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "kernel/compensating-events", "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": "CompensatingEventDto", "collection": true, "members": [ { "name": "EventId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EventType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventPayload", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StateCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "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 } } }, "/kernel/compensating-events/{id}": { "get": { "operationId": "foreign-trade-get-compensating-event-by-id", "tags": [ "kernel" ], "summary": "foreign-trade-get-compensating-event-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "compensatingEventId" } } ], "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": "foreign-trade-get-compensating-event-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "kernel/compensating-events/{id}", "x-aura-request-contract": { "state": "not-parsed-in-repo" }, "x-aura-code-response": { "state": "structure", "declared_type": "CompensatingEventDto", "payload": "CompensatingEventDto", "collection": false, "members": [ { "name": "EventId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "CorrelationId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "EventType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "EventPayload", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StateCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CreatedDate", "declared_type": "DateTime", "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_CMPNSTNG_1", "status": 400, "message": null, "message_available": false, "constant_name": "COMPENSATING_EVENT_ID_NOT_FOUND" } ] } } }, "/localizations": { "get": { "operationId": "foreign-trade-get-localization-list", "tags": [ "localizations" ], "summary": "foreign-trade-get-localization-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "foreign-trade-get-localization-list", "x-aura-domain": "foreign-trade", "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." }, "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 } }, "post": { "operationId": "foreign-trade-create-localization", "tags": [ "localizations" ], "summary": "foreign-trade-create-localization", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "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": { "x-aura-type": "unresolved" } }, "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. 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": "foreign-trade-create-localization", "x-aura-domain": "foreign-trade", "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-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_LCLZ_1", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/by-code/{code}": { "get": { "operationId": "foreign-trade-get-localization-by-code", "tags": [ "localizations" ], "summary": "foreign-trade-get-localization-by-code", "parameters": [ { "name": "code", "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. 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": "foreign-trade-get-localization-by-code", "x-aura-domain": "foreign-trade", "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-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_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } } }, "/localizations/{id}": { "delete": { "operationId": "foreign-trade-delete-localization", "tags": [ "localizations" ], "summary": "foreign-trade-delete-localization", "parameters": [ { "name": "id", "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": 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": "foreign-trade-delete-localization", "x-aura-domain": "foreign-trade", "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": "foreign-trade-get-localization-by-id", "tags": [ "localizations" ], "summary": "foreign-trade-get-localization-by-id", "parameters": [ { "name": "id", "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. 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": "foreign-trade-get-localization-by-id", "x-aura-domain": "foreign-trade", "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-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_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "put": { "operationId": "foreign-trade-update-localization", "tags": [ "localizations" ], "summary": "foreign-trade-update-localization", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "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": { "x-aura-type": "unresolved" } }, "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": "foreign-trade-update-localization", "x-aura-domain": "foreign-trade", "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": "foreign-trade-get-localization-translation-by-localization-id", "tags": [ "localizations" ], "summary": "foreign-trade-get-localization-translation-by-localization-id", "parameters": [ { "name": "id", "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. 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": "foreign-trade-get-localization-translation-by-localization-id", "x-aura-domain": "foreign-trade", "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-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_LCLZ_3", "status": 400, "message": null, "message_available": false, "constant_name": null } ] } }, "post": { "operationId": "foreign-trade-create-localization-translation", "tags": [ "localizations" ], "summary": "foreign-trade-create-localization-translation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "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" } } }, "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": "foreign-trade-create-localization-translation", "x-aura-domain": "foreign-trade", "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": "foreign-trade-delete-localization-translation", "tags": [ "localizations" ], "summary": "foreign-trade-delete-localization-translation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "name": "translationId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "translationId" } } ], "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": "foreign-trade-delete-localization-translation", "x-aura-domain": "foreign-trade", "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": "foreign-trade-update-localization-translation", "tags": [ "localizations" ], "summary": "foreign-trade-update-localization-translation", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "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": "foreign-trade-update-localization-translation", "x-aura-domain": "foreign-trade", "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 } ] } } }, "/mock-endpoint": { "get": { "operationId": "get-mock-data", "tags": [ "mock-endpoint" ], "summary": "get-mock-data", "parameters": [ { "name": "mockRequest", "in": "query", "required": false, "schema": { "type": "object", "x-aura-field-code": "mockRequest" } } ], "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": 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. 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-mock-data", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "mock-endpoint", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "MockRequest", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "GetMockDataResponse", "payload": "GetMockDataResponse", "collection": false, "members": [ { "name": "MockResponse", "declared_type": "object", "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 } } }, "/outgoing-letter-of-guarantees": { "post": { "operationId": "create-outgoing-letter-of-guarantee", "tags": [ "outgoing-letter-of-guarantees" ], "summary": "create-outgoing-letter-of-guarantee", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-outgoing-letter-of-guarantee", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "outgoing-letter-of-guarantees", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/parameters": { "get": { "operationId": "foreign-trade-get-parameter-list", "tags": [ "parameters" ], "summary": "foreign-trade-get-parameter-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "foreign-trade-get-parameter-list", "x-aura-domain": "foreign-trade", "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." }, "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 } }, "post": { "operationId": "foreign-trade-create-parameter", "tags": [ "parameters" ], "summary": "foreign-trade-create-parameter", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "x-aura-type": "unresolved" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "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": 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": "foreign-trade-create-parameter", "x-aura-domain": "foreign-trade", "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}/default-value": { "get": { "operationId": "foreign-trade-get-parameter-default-value-by-parameter-code", "tags": [ "parameters" ], "summary": "foreign-trade-get-parameter-default-value-by-parameter-code", "parameters": [ { "name": "code", "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": 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": "foreign-trade-get-parameter-default-value-by-parameter-code", "x-aura-domain": "foreign-trade", "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/{id}": { "delete": { "operationId": "foreign-trade-delete-parameter", "tags": [ "parameters" ], "summary": "foreign-trade-delete-parameter", "parameters": [ { "name": "id", "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": 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": "foreign-trade-delete-parameter", "x-aura-domain": "foreign-trade", "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": "foreign-trade-get-parameter-by-id", "tags": [ "parameters" ], "summary": "foreign-trade-get-parameter-by-id", "parameters": [ { "name": "id", "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": 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. 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": "foreign-trade-get-parameter-by-id", "x-aura-domain": "foreign-trade", "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-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_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "put": { "operationId": "foreign-trade-update-parameter", "tags": [ "parameters" ], "summary": "foreign-trade-update-parameter", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "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": { "x-aura-type": "unresolved" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "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": 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": "foreign-trade-update-parameter", "x-aura-domain": "foreign-trade", "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": "foreign-trade-get-parameter-default-value", "tags": [ "parameters" ], "summary": "foreign-trade-get-parameter-default-value", "parameters": [ { "name": "id", "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": 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": "foreign-trade-get-parameter-default-value", "x-aura-domain": "foreign-trade", "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": "foreign-trade-delete-parameter-field-value", "tags": [ "parameters" ], "summary": "foreign-trade-delete-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "name": "fieldValueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldValueId" } } ], "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": "foreign-trade-delete-parameter-field-value", "x-aura-domain": "foreign-trade", "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": "foreign-trade-update-parameter-field-value", "tags": [ "parameters" ], "summary": "foreign-trade-update-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "name": "fieldValueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldValueId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" } }, "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": "foreign-trade-update-parameter-field-value", "x-aura-domain": "foreign-trade", "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": "foreign-trade-get-parameter-field-list", "tags": [ "parameters" ], "summary": "foreign-trade-get-parameter-field-list", "parameters": [ { "name": "id", "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": 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. 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": "foreign-trade-get-parameter-field-list", "x-aura-domain": "foreign-trade", "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-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_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "post": { "operationId": "foreign-trade-create-parameter-field", "tags": [ "parameters" ], "summary": "foreign-trade-create-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "translations": { "type": "array", "items": { "type": "object", "properties": { "languageCode": { "type": "string", "x-aura-field-code": "languageCode" }, "name": { "x-aura-type": "unresolved" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "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. 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": "foreign-trade-create-parameter-field", "x-aura-domain": "foreign-trade", "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-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_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": "foreign-trade-delete-parameter-field", "tags": [ "parameters" ], "summary": "foreign-trade-delete-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" } } ], "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": "foreign-trade-delete-parameter-field", "x-aura-domain": "foreign-trade", "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": "foreign-trade-update-parameter-field", "tags": [ "parameters" ], "summary": "foreign-trade-update-parameter-field", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "name": "fieldId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "fieldId" } } ], "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": { "x-aura-type": "unresolved" } }, "required": [ "languageCode", "name" ], "x-aura-field-code": "translations" } } }, "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": "foreign-trade-update-parameter-field", "x-aura-domain": "foreign-trade", "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": "foreign-trade-get-parameter-value-list", "tags": [ "parameters" ], "summary": "foreign-trade-get-parameter-value-list", "parameters": [ { "name": "id", "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": 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. 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": "foreign-trade-get-parameter-value-list", "x-aura-domain": "foreign-trade", "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-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_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "post": { "operationId": "foreign-trade-create-parameter-value", "tags": [ "parameters" ], "summary": "foreign-trade-create-parameter-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } } ], "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", "isActive", "paramKey", "sortOrder", "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. 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": "foreign-trade-create-parameter-value", "x-aura-domain": "foreign-trade", "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-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_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": "foreign-trade-delete-parameter-value", "tags": [ "parameters" ], "summary": "foreign-trade-delete-parameter-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "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": "foreign-trade-delete-parameter-value", "x-aura-domain": "foreign-trade", "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": "foreign-trade-update-parameter-value", "tags": [ "parameters" ], "summary": "foreign-trade-update-parameter-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "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", "isActive", "sortOrder", "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": "foreign-trade-update-parameter-value", "x-aura-domain": "foreign-trade", "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": "foreign-trade-get-parameter-field-value-list", "tags": [ "parameters" ], "summary": "foreign-trade-get-parameter-field-value-list", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "name": "valueId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "valueId" } }, { "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. 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": "foreign-trade-get-parameter-field-value-list", "x-aura-domain": "foreign-trade", "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-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_PRMTR_2", "status": 400, "message": null, "message_available": false, "constant_name": "PARAMETER_ID_NOT_FOUND" } ] } }, "post": { "operationId": "foreign-trade-create-parameter-field-value", "tags": [ "parameters" ], "summary": "foreign-trade-create-parameter-field-value", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "x-aura-type": "unresolved" } }, { "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": { "fieldValues": { "type": "array", "items": { "type": "object", "properties": { "fieldValue": { "type": "string", "x-aura-field-code": "fieldValue" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "parameterFieldId": { "type": "string", "format": "uuid", "x-aura-field-code": "parameterFieldId" } }, "required": [ "fieldValue", "isActive", "parameterFieldId" ], "x-aura-field-code": "fieldValues" } } }, "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": "foreign-trade-create-parameter-field-value", "x-aura-domain": "foreign-trade", "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" } ] } } }, "/pre-documents": { "get": { "operationId": "get-pre-document-list", "tags": [ "pre-documents" ], "summary": "get-pre-document-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-pre-document-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "pre-documents", "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": "PreDocumentDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CourierDeliveryDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "CourierNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-pre-document", "tags": [ "pre-documents" ], "summary": "create-pre-document", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "courierCompany": { "type": "string", "x-aura-field-code": "courierCompany" }, "courierDeliveryDate": { "type": "string", "format": "date", "x-aura-field-code": "courierDeliveryDate" }, "courierNumber": { "type": "string", "x-aura-field-code": "courierNumber" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "goodsValue": { "type": "number", "format": "decimal", "x-aura-field-code": "goodsValue" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "preDocumentStatus" } }, "required": [ "courierCompany", "courierDeliveryDate", "courierNumber", "currencyCode", "documentType", "goodsValue", "reference", "senderReference" ] } } } }, "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": 10, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-pre-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "pre-documents", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "CourierDeliveryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CourierNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/pre-documents/{id}": { "delete": { "operationId": "delete-pre-document", "tags": [ "pre-documents" ], "summary": "delete-pre-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "preDocumentId" } } ], "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-pre-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "pre-documents/{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_FRGN_TRD_1", "status": 400, "message": null, "message_available": false, "constant_name": "PRE_DOCUMENT_NOT_FOUND" } ] } }, "get": { "operationId": "get-pre-document-by-id", "tags": [ "pre-documents" ], "summary": "get-pre-document-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "preDocumentId" } } ], "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-pre-document-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "pre-documents/{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": "PreDocumentDto", "payload": "PreDocumentDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "CurrencyCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CourierCompany", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CourierDeliveryDate", "declared_type": "DateOnly?", "nullable": true, "collection": false }, { "name": "CourierNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "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_FRGN_TRD_1", "status": 400, "message": null, "message_available": false, "constant_name": "PRE_DOCUMENT_NOT_FOUND" } ] } }, "put": { "operationId": "update-pre-document", "tags": [ "pre-documents" ], "summary": "update-pre-document", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "preDocumentId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "courierCompany": { "type": "string", "x-aura-field-code": "courierCompany" }, "courierDeliveryDate": { "type": "string", "format": "date", "x-aura-field-code": "courierDeliveryDate" }, "courierNumber": { "type": "string", "x-aura-field-code": "courierNumber" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "documentType": { "type": "integer", "format": "int32", "x-aura-field-code": "documentType" }, "goodsValue": { "type": "number", "format": "decimal", "x-aura-field-code": "goodsValue" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "preDocumentStatus" } }, "required": [ "courierCompany", "courierDeliveryDate", "courierNumber", "currencyCode", "documentType", "goodsValue", "groupGuid", "reference", "senderReference", "status" ] } } } }, "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": 10, "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-pre-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "pre-documents/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "DocumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "GoodsValue", "declared_type": null, "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CourierCompany", "declared_type": null, "nullable": false, "collection": false }, { "name": "CourierDeliveryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "CourierNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "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_FRGN_TRD_1", "status": 400, "message": null, "message_available": false, "constant_name": "PRE_DOCUMENT_NOT_FOUND" } ] } } }, "/product-infos": { "get": { "operationId": "get-product-info-list", "tags": [ "product-infos" ], "summary": "get-product-info-list", "parameters": [ { "name": "explanation", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "explanation" } }, { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "x-aura-field-code": "filter" } }, { "name": "limitProductCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "limitProductCode" } }, { "name": "name", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "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" } }, { "name": "productCode", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "productCode" } } ], "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": 9 }, "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": "get-product-info-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "product-infos", "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": "ProductCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": null, "nullable": false, "collection": false }, { "name": "LimitProductCode", "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": "ProductInfoDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProductCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LimitProductCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "State", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-product-info", "tags": [ "product-infos" ], "summary": "create-product-info", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "explanation": { "type": "string", "x-aura-field-code": "explanation" }, "limitProductCode": { "type": "string", "x-aura-field-code": "limitProductCode" }, "name": { "x-aura-type": "unresolved" }, "productCode": { "type": "string", "x-aura-field-code": "productCode" }, "state": { "x-aura-type": "unresolved" } }, "required": [ "explanation", "limitProductCode", "name", "productCode", "state" ] } } } }, "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-product-info", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "product-infos", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ProductCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "LimitProductCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": null, "nullable": false, "collection": false }, { "name": "State", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/product-infos/customer-risks/{customerId}": { "get": { "operationId": "get-customer-risks", "tags": [ "product-infos" ], "summary": "get-customer-risks", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" } } ], "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 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": "get-customer-risks", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "product-infos/customer-risks/{customerId}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "ProductRiskDto", "collection": true, "members": [ { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountModule", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AccountId", "declared_type": "long", "nullable": false, "collection": false }, { "name": "ProductCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LimitProductCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Balance", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "RemainingLoanAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "CurrencyCode", "declared_type": "int", "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 } } }, "/product-infos/{id}": { "delete": { "operationId": "delete-product-info", "tags": [ "product-infos" ], "summary": "delete-product-info", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "productInfoId" } } ], "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-product-info", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "product-infos/{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_FRGN_TRD_36", "status": 400, "message": null, "message_available": false, "constant_name": "PRODUCT_INFO_NOT_FOUND" } ] } }, "get": { "operationId": "get-product-info-by-id", "tags": [ "product-infos" ], "summary": "get-product-info-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "productInfoId" } } ], "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-product-info-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "product-infos/{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": "ProductInfoDto", "payload": "ProductInfoDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProductCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LimitProductCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "State", "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_FRGN_TRD_36", "status": 400, "message": null, "message_available": false, "constant_name": "PRODUCT_INFO_NOT_FOUND" } ] } }, "put": { "operationId": "update-product-info", "tags": [ "product-infos" ], "summary": "update-product-info", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "productInfoId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "explanation": { "type": "string", "x-aura-field-code": "explanation" }, "limitProductCode": { "type": "string", "x-aura-field-code": "limitProductCode" }, "name": { "x-aura-type": "unresolved" }, "productCode": { "type": "string", "x-aura-field-code": "productCode" }, "state": { "x-aura-type": "unresolved" } }, "required": [ "explanation", "limitProductCode", "name", "productCode", "state" ] } } } }, "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. 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": "update-product-info", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "product-infos/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProductCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Name", "declared_type": null, "nullable": false, "collection": false }, { "name": "LimitProductCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": null, "nullable": false, "collection": false }, { "name": "State", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ProductInfoDto", "payload": "ProductInfoDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "ProductCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Name", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LimitProductCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Explanation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "State", "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_FRGN_TRD_36", "status": 400, "message": null, "message_available": false, "constant_name": "PRODUCT_INFO_NOT_FOUND" } ] } } }, "/reference-numbers/generate": { "post": { "operationId": "get-foreign-trade-reference-number", "tags": [ "reference-numbers" ], "summary": "get-foreign-trade-reference-number", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "direction": { "type": "string", "x-aura-field-code": "direction" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "transactionType": { "type": "string", "x-aura-field-code": "importDocumentTransactionType" } }, "required": [ "direction", "isDomestic", "transactionType" ] } } } }, "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": "get-foreign-trade-reference-number", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "reference-numbers/generate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ReferenceNumberDto", "payload": "ReferenceNumberDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Counter", "declared_type": "int", "nullable": false, "collection": false }, { "name": "LastReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Direction", "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 } } }, "/reference-numbers/validate": { "post": { "operationId": "validate-reference-number", "tags": [ "reference-numbers" ], "summary": "validate-reference-number", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "referenceNumber": { "type": "string", "x-aura-field-code": "referenceNumber" } }, "required": [ "referenceNumber" ] } } } }, "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 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": "validate-reference-number", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "reference-numbers/validate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ReferenceNumber", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ValidateReferenceNumberResultDto", "payload": "ValidateReferenceNumberResultDto", "collection": false, "members": [ { "name": "IsValid", "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 single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-bic-banks": { "get": { "operationId": "get-swift-bICBank-list", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bICBank-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", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "type": "array", "items": { "type": "object", "x-aura-field-code": "keys" } }, "values": { "type": "array", "items": { "type": "object", "x-aura-field-code": "values" } } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-swift-bICBank-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks", "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": "SwiftBICBankDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Address", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ApiUpdateDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "BankAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankIBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCustomerId", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Correspondents", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-swift-bICBank", "tags": [ "swift-bic-banks" ], "summary": "create-swift-bICBank", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "x-aura-field-code": "address" }, "addressCity": { "type": "string", "x-aura-field-code": "addressCity" }, "addressCountryCode": { "x-aura-type": "unresolved" }, "addressCountryName": { "type": "string", "x-aura-field-code": "addressCountryName" }, "bICCode": { "type": "string", "x-aura-field-code": "bICCode" }, "bankCode": { "x-aura-type": "unresolved" }, "bankName": { "type": "string", "x-aura-field-code": "bankName", "x-aura-maskable": true }, "branchCode": { "x-aura-type": "unresolved" }, "branchName": { "type": "string", "x-aura-field-code": "branchName" }, "correspondents": { "type": "array", "items": { "type": "object", "properties": { "apiUpdateDate": { "type": "string", "format": "date-time", "x-aura-field-code": "apiUpdateDate" }, "bICCode": { "type": "string", "x-aura-field-code": "bICCode" }, "correspondenceType": { "type": "string", "x-aura-field-code": "correspondenceType" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" } }, "required": [ "apiUpdateDate", "bICCode", "correspondenceType", "correspondentBankBICCode", "currency", "isActive" ], "x-aura-field-code": "correspondents" } }, "countryCode": { "type": "string", "x-aura-field-code": "countryCode" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "locationCode": { "type": "string", "x-aura-field-code": "locationCode" } }, "required": [ "address", "addressCity", "addressCountryCode", "addressCountryName", "bICCode", "bankCode", "bankName", "branchCode", "branchName", "correspondents", "countryCode", "isActive", "locationCode" ] } } } }, "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": 13, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-swift-bICBank", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LocationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressCity", "declared_type": null, "nullable": false, "collection": false }, { "name": "Address", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressCountryName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-bic-banks/by-bank-code/{bankCode}/name": { "get": { "operationId": "get-swift-bank-name-by-bank-code", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bank-name-by-bank-code", "parameters": [ { "name": "bankCode", "in": "path", "required": true, "schema": { "type": "integer", "format": "int32", "x-aura-field-code": "bankCode" } } ], "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-swift-bank-name-by-bank-code", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/by-bank-code/{bankCode}/name", "x-aura-code-response": { "state": "no-code-endpoint", "note": "No endpoint registration was found at this address." } } }, "/swift-bic-banks/by-bic-code/{bICCode}": { "get": { "operationId": "get-swift-bICBank-by-code", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bICBank-by-code", "parameters": [ { "name": "bICCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "bICCode" } } ], "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-swift-bICBank-by-code", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/by-bic-code/{bICCode}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BICCode", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftBICBankDto", "payload": "SwiftBICBankDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Address", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ApiUpdateDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "BankAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankIBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCustomerId", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Correspondents", "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 }, "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_FRGN_TRD_9", "status": 400, "message": null, "message_available": false, "constant_name": "ITEM_DOES_NOT_EXISTS" } ] } } }, "/swift-bic-banks/by-bic-code/{bICCode}/name": { "get": { "operationId": "get-swift-bICBank-name-by-code", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bICBank-name-by-code", "parameters": [ { "name": "bICCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "bICCode" } } ], "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. 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": "get-swift-bICBank-name-by-code", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/by-bic-code/{bICCode}/name", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BICCode", "declared_type": null, "nullable": false, "collection": false } ] }, "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_FRGN_TRD_9", "status": 400, "message": null, "message_available": false, "constant_name": "ITEM_DOES_NOT_EXISTS" } ] } } }, "/swift-bic-banks/by-branch-code/{branchCode}/name": { "get": { "operationId": "get-swift-bic-banks-get-branch-name-by-branch-code", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bic-banks-get-branch-name-by-branch-code", "parameters": [ { "name": "branchCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "branchCodeString" } } ], "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. 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": "get-swift-bic-banks-get-branch-name-by-branch-code", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/by-branch-code/{branchCode}/name", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false } ] }, "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_FRGN_TRD_9", "status": 400, "message": null, "message_available": false, "constant_name": "ITEM_DOES_NOT_EXISTS" } ] } } }, "/swift-bic-banks/by-iban/{iBan}": { "get": { "operationId": "get-swift-bICBank-by-iban", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bICBank-by-iban", "parameters": [ { "name": "iBan", "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": "iban", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "iban" } } ], "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": 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. 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-swift-bICBank-by-iban", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/by-iban/{iBan}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Iban", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftBICBankDto", "payload": "SwiftBICBankDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Address", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ApiUpdateDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "BankAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankIBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCustomerId", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Correspondents", "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 }, "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_FRGN_TRD_14", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_IBAN_NUMBER" } ] } } }, "/swift-bic-banks/by-id/{id}": { "get": { "operationId": "get-swift-bICBank-by-id", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bICBank-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftBicBankId" } } ], "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-swift-bICBank-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/by-id/{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": "SwiftBICBankDto", "payload": "SwiftBICBankDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Address", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ApiUpdateDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "BankAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankIBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCustomerId", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Correspondents", "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 }, "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_FRGN_TRD_9", "status": 400, "message": null, "message_available": false, "constant_name": "ITEM_DOES_NOT_EXISTS" } ] } } }, "/swift-bic-banks/correspondents": { "get": { "operationId": "get-swift-bICBank-correspondent", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bICBank-correspondent", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-swift-bICBank-correspondent", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/correspondents", "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": "SwiftBICBankCorrespondentDto", "collection": true, "members": [ { "name": "BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondentBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CorrespondenceType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ApiUpdateDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "BankAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankIBAN", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-bic-banks/{bICCode}": { "get": { "operationId": "get-swift-bICBank", "tags": [ "swift-bic-banks" ], "summary": "get-swift-bICBank", "parameters": [ { "name": "bICCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "bICCode" } }, { "name": "accountNumber", "in": "query", "required": false, "schema": { "x-aura-type": "unresolved" } }, { "name": "currency", "in": "query", "required": false, "schema": { "type": "string", "x-aura-field-code": "currency" } } ], "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": 2 }, "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-swift-bICBank", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/{bICCode}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": true, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftBICBankDto", "payload": "SwiftBICBankDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "CountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "LocationCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCity", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Address", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "AddressCountryName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsActive", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "ApiUpdateDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "BankAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankIBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankCustomerId", "declared_type": "object", "nullable": false, "collection": false }, { "name": "Correspondents", "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 } }, "put": { "operationId": "update-swift-bICBank", "tags": [ "swift-bic-banks" ], "summary": "update-swift-bICBank", "parameters": [ { "name": "bICCode", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "bICCode" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "address": { "type": "string", "x-aura-field-code": "address" }, "addressCity": { "type": "string", "x-aura-field-code": "addressCity" }, "addressCountryCode": { "x-aura-type": "unresolved" }, "addressCountryName": { "type": "string", "x-aura-field-code": "addressCountryName" }, "bankCode": { "x-aura-type": "unresolved" }, "bankName": { "type": "string", "x-aura-field-code": "bankName", "x-aura-maskable": true }, "branchCode": { "x-aura-type": "unresolved" }, "branchName": { "type": "string", "x-aura-field-code": "branchName" }, "correspondents": { "type": "array", "items": { "type": "object", "properties": { "apiUpdateDate": { "type": "string", "format": "date-time", "x-aura-field-code": "apiUpdateDate" }, "bICCode": { "type": "string", "x-aura-field-code": "bICCode" }, "correspondenceType": { "type": "string", "x-aura-field-code": "correspondenceType" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" } }, "required": [ "apiUpdateDate", "bICCode", "correspondenceType", "correspondentBankBICCode", "currency", "isActive" ], "x-aura-field-code": "correspondents" } }, "countryCode": { "type": "string", "x-aura-field-code": "countryCode" }, "isActive": { "type": "boolean", "x-aura-field-code": "isActive" }, "locationCode": { "type": "string", "x-aura-field-code": "locationCode" } }, "required": [ "address", "addressCity", "addressCountryCode", "addressCountryName", "bankCode", "bankName", "branchCode", "branchName", "correspondents", "countryCode", "isActive", "locationCode" ] } } } }, "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": 12, "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-swift-bICBank", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-bic-banks/{bICCode}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "CountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "LocationCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressCity", "declared_type": null, "nullable": false, "collection": false }, { "name": "Address", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddressCountryName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsActive", "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_FRGN_67", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_ALMANAC_BIC_CODE_NOT_FOUND" } ] } } }, "/swift-incomings": { "get": { "operationId": "get-swift-incoming-list", "tags": [ "swift-incomings" ], "summary": "get-swift-incoming-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. 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": "get-swift-incoming-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-incomings", "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": "SwiftIncomingDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "MTId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IncomingDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "FiTransferId", "declared_type": "int", "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 } }, "post": { "operationId": "create-swift-incoming", "tags": [ "swift-incomings" ], "summary": "create-swift-incoming", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fiTransferId": { "type": "integer", "format": "int32", "x-aura-field-code": "fiTransferId" }, "incomingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "incomingDate" }, "mTId": { "x-aura-type": "unresolved" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "required": [ "fiTransferId", "incomingDate", "mTId", "messageText", "messageType", "reference" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-swift-incoming", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-incomings", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "MTId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "IncomingDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "FiTransferId", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-incomings/validate": { "post": { "operationId": "swift-incoming-validate", "tags": [ "swift-incomings" ], "summary": "swift-incoming-validate", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "amount": { "x-aura-type": "unresolved" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "directionType": { "type": "string", "x-aura-field-code": "directionType" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "transactionDate": { "x-aura-type": "unresolved" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "transferSystemCode": { "type": "string", "x-aura-field-code": "transferSystemCode" }, "transferSystemName": { "type": "string", "x-aura-field-code": "transferSystemName" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "amount", "businessKey", "directionType", "id", "messageTypeDefinitionId", "messageTypeName", "platformReference", "receiverAccount", "reference", "senderAccount", "sourceReference", "transactionDate", "transferMessageDefinitionId", "transferSystemCode", "transferSystemName", "valueDate" ] } } } }, "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": 16, "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": "swift-incoming-validate", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-incomings/validate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSystemName", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSystemCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferMessageDefinitionId", "declared_type": null, "nullable": false, "collection": false }, { "name": "DirectionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "BusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "SourceReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderAccount", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverAccount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "PlatformReference", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftIncomingValidationDto", "payload": "SwiftIncomingValidationDto", "collection": false, "members": [ { "name": "Id", "declared_type": "int", "nullable": false, "collection": false }, { "name": "IsValidated", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "PlatformReference", "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-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 } } }, "/swift-incomings/{id}": { "delete": { "operationId": "delete-swift-incoming", "tags": [ "swift-incomings" ], "summary": "delete-swift-incoming", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" } } ], "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-swift-incoming", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-incomings/{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_FRGN_TRD_4", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_INCOMING_NOT_FOUND" } ] } }, "get": { "operationId": "get-swift-incoming-by-id", "tags": [ "swift-incomings" ], "summary": "get-swift-incoming-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" } } ], "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-swift-incoming-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-incomings/{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": "SwiftIncomingDto", "payload": "SwiftIncomingDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "MTId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IncomingDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "FiTransferId", "declared_type": "int", "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_FRGN_TRD_4", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_INCOMING_NOT_FOUND" } ] } }, "put": { "operationId": "update-swift-incoming", "tags": [ "swift-incomings" ], "summary": "update-swift-incoming", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fiTransferId": { "type": "integer", "format": "int32", "x-aura-field-code": "fiTransferId" }, "incomingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "incomingDate" }, "mTId": { "x-aura-type": "unresolved" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "reference": { "type": "string", "x-aura-field-code": "reference" } }, "required": [ "fiTransferId", "incomingDate", "mTId", "messageText", "messageType", "reference" ] } } } }, "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-swift-incoming", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-incomings/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "IncomingDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "FiTransferId", "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_FRGN_TRD_4", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_INCOMING_NOT_FOUND" } ] } } }, "/swift-incomings/{id}/process": { "put": { "operationId": "process-swift-incoming", "tags": [ "swift-incomings" ], "summary": "process-swift-incoming", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" } } ], "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. 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": "process-swift-incoming", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-incomings/{id}/process", "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": "ProcessSwiftIncomingDto", "payload": "ProcessSwiftIncomingDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageHtml", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftIncomingId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RelatedDocumentReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": "int?", "nullable": true, "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_FRGN_TRD_4", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_INCOMING_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_9", "status": 400, "message": null, "message_available": false, "constant_name": "ITEM_DOES_NOT_EXISTS" } ] } } }, "/swift-mts": { "get": { "operationId": "get-swift-mTSchema-list", "tags": [ "swift-mts" ], "summary": "get-swift-mTSchema-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-swift-mTSchema-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-mts", "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": "SwiftMTSchemaDto", "collection": true, "members": [ { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SchemaProperties", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Fields", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-swift-mTSchema", "tags": [ "swift-mts" ], "summary": "create-swift-mTSchema", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "x-aura-type": "unresolved" }, "fields": { "type": "array", "items": { "type": "object", "properties": { "active": { "type": "boolean", "x-aura-field-code": "active" }, "description": { "x-aura-type": "unresolved" }, "editable": { "type": "boolean", "x-aura-field-code": "editable" }, "fieldDefs": { "type": "array", "items": { "type": "object", "properties": { "dataType": { "x-aura-type": "unresolved" }, "dataValue": { "type": "string", "x-aura-field-code": "dataValue" }, "dataValueOptions": { "type": "string", "x-aura-field-code": "dataValueOptions" }, "defaultValue": { "type": "string", "x-aura-field-code": "defaultValue" }, "description": { "x-aura-type": "unresolved" }, "editable": { "type": "boolean", "x-aura-field-code": "editable" }, "fieldName": { "type": "string", "x-aura-field-code": "fieldName" }, "format": { "type": "string", "x-aura-field-code": "format" }, "maxLength": { "type": "integer", "format": "int32", "x-aura-field-code": "maxLength" }, "maxRow": { "type": "integer", "format": "int32", "x-aura-field-code": "maxRow" }, "minLength": { "type": "integer", "format": "int32", "x-aura-field-code": "minLength" }, "order": { "type": "integer", "format": "int32", "x-aura-field-code": "order" }, "regExFormat": { "type": "string", "x-aura-field-code": "regExFormat" }, "required": { "type": "boolean", "x-aura-field-code": "required" }, "rowNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "rowNumber" }, "rule": { "type": "string", "x-aura-field-code": "rule" }, "tag": { "type": "string", "x-aura-field-code": "tag" }, "visible": { "type": "boolean", "x-aura-field-code": "visible" } }, "required": [ "dataType", "dataValue", "dataValueOptions", "defaultValue", "description", "editable", "fieldName", "format", "maxLength", "maxRow", "minLength", "order", "regExFormat", "required", "rowNumber", "rule", "tag", "visible" ], "x-aura-field-code": "fieldDefs" } }, "fieldName": { "type": "string", "x-aura-field-code": "fieldName" }, "groupNo": { "type": "integer", "format": "int32", "x-aura-field-code": "groupNo" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "order": { "type": "integer", "format": "int32", "x-aura-field-code": "order" }, "required": { "type": "boolean", "x-aura-field-code": "required" }, "rule": { "type": "string", "x-aura-field-code": "rule" }, "tag": { "type": "string", "x-aura-field-code": "tag" }, "visible": { "type": "boolean", "x-aura-field-code": "visible" } }, "required": [ "active", "description", "editable", "fieldDefs", "fieldName", "groupNo", "messageType", "order", "required", "rule", "tag", "visible" ], "x-aura-field-code": "fields" } }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "schemaProperties": { "type": "string", "x-aura-field-code": "schemaProperties" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "swiftMtSchemaStatus" } }, "required": [ "description", "fields", "messageType", "schemaProperties", "status" ] } } } }, "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-swift-mTSchema", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-mts", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "MessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageName", "declared_type": null, "nullable": false, "collection": false }, { "name": "Description", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "SchemaProperties", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-mts/by-message-type/{messageType}": { "get": { "operationId": "get-swift-mTSchema-by-message-type", "tags": [ "swift-mts" ], "summary": "get-swift-mTSchema-by-message-type", "parameters": [ { "name": "messageType", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "messageType" } } ], "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-swift-mTSchema-by-message-type", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-mts/by-message-type/{messageType}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "MessageType", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftMTSchemaDto", "payload": "SwiftMTSchemaDto", "collection": false, "members": [ { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Description", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SchemaProperties", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Fields", "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 } } }, "/swift-mx-schemas/import": { "post": { "operationId": "import-swift-mx-schema", "tags": [ "swift-mx-schemas" ], "summary": "import-swift-mx-schema", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fileContent": { "type": "string", "x-aura-field-code": "fileContent" }, "fileName": { "type": "string", "x-aura-field-code": "fileName" } }, "required": [ "fileContent", "fileName" ] } } } }, "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": "import-swift-mx-schema", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-mx-schemas/import", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "FileName", "declared_type": null, "nullable": false, "collection": false }, { "name": "FileContent", "declared_type": null, "nullable": false, "collection": false }, { "name": "SheetName", "declared_type": null, "nullable": false, "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_FRGN_TRD_74", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_MX_SCHEMA_GENERAL_INFO_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_75", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_MX_SCHEMA_SHEET_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_76", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_MX_SCHEMA_MESSAGE_TYPE_NOT_FOUND" } ] } } }, "/swift-mx-schemas/preview": { "post": { "operationId": "preview-swift-mx", "tags": [ "swift-mx-schemas" ], "summary": "preview-swift-mx", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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 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": "preview-swift-mx", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-mx-schemas/preview", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "collection": false } ] } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "PreviewSwiftMxResponse", "payload": "PreviewSwiftMxResponse", "collection": false, "members": [ { "name": "Messages", "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 } } }, "/swift-others": { "get": { "operationId": "get-swift-other-list", "tags": [ "swift-others" ], "summary": "get-swift-other-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-swift-other-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-others", "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": "SwiftOtherDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageTypeName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageHtml", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftIncomingId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RelatedDocumentReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CreateTime", "declared_type": "DateTime", "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 } }, "post": { "operationId": "create-swift-other", "tags": [ "swift-others" ], "summary": "create-swift-other", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "direction": { "type": "string", "x-aura-field-code": "direction" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "type": "string", "x-aura-field-code": "swiftOtherStatus" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" } }, "required": [ "direction", "messageHtml", "messageText", "messageType", "reference", "status" ] } } } }, "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": 10, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-swift-other", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-others", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageHtml", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftIncomingId", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedDocumentReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-others/by-reference/{reference}": { "get": { "operationId": "get-swift-other-by-reference", "tags": [ "swift-others" ], "summary": "get-swift-other-by-reference", "parameters": [ { "name": "reference", "in": "path", "required": true, "schema": { "type": "string", "x-aura-field-code": "reference" } } ], "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 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": "get-swift-other-by-reference", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-others/by-reference/{reference}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Reference", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "SwiftOtherDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageTypeName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageHtml", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftIncomingId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "RelatedDocumentReference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SwiftTransferId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CreateTime", "declared_type": "DateTime", "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 } } }, "/swift-others/{id}": { "delete": { "operationId": "delete-swift-other", "tags": [ "swift-others" ], "summary": "delete-swift-other", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftOtherId" } } ], "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-swift-other", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-others/{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_FRGN_TRD_15", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_OTHER_NOT_FOUND" } ] } }, "put": { "operationId": "update-swift-other", "tags": [ "swift-others" ], "summary": "update-swift-other", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftOtherId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "direction": { "type": "string", "x-aura-field-code": "direction" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "type": "string", "x-aura-field-code": "swiftOtherStatus" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" } }, "required": [ "direction", "messageHtml", "messageText", "messageType", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId" ] } } } }, "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": 10, "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-swift-other", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-others/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageHtml", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftIncomingId", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedDocumentReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "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_FRGN_TRD_15", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_OTHER_NOT_FOUND" } ] } } }, "/swift-outgoings": { "get": { "operationId": "get-swift-outgoing-list", "tags": [ "swift-outgoings" ], "summary": "get-swift-outgoing-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. 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": "get-swift-outgoing-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-outgoings", "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": "MessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionStartDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionEndDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Reference", "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": "SwiftOutgoingDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "MTId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "SendDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Response", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageContentHtml", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentReference", "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 collection.", "code_response_state": "structure", "code_cardinality": "collection", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } }, "post": { "operationId": "create-swift-outgoing", "tags": [ "swift-outgoings" ], "summary": "create-swift-outgoing", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "mTId": { "type": "string", "format": "uuid", "x-aura-field-code": "mTId" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "parentReference": { "type": "string", "x-aura-field-code": "parentReference" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "response": { "type": "string", "x-aura-field-code": "response" }, "sendDate": { "x-aura-type": "unresolved" }, "status": { "type": "string", "x-aura-field-code": "swiftOutgoingStatus" }, "transactionDate": { "x-aura-type": "unresolved" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "businessKey", "mTId", "messageContentHtml", "messageText", "messageType", "parentReference", "reference", "response", "sendDate", "status", "transactionDate", "uETR", "valueDate" ] } } } }, "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": 13, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-swift-outgoing", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-outgoings", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "MTId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Response", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageContentHtml", "declared_type": null, "nullable": false, "collection": false }, { "name": "BusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "ParentReference", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-outgoings/{id}": { "get": { "operationId": "get-swift-outgoing-by-id", "tags": [ "swift-outgoings" ], "summary": "get-swift-outgoing-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftOutgoingId" } } ], "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-swift-outgoing-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-outgoings/{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": "SwiftOutgoingDto", "payload": "SwiftOutgoingDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "MTId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "SendDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "Response", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MessageContentHtml", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BusinessKey", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ParentReference", "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_FRGN_TRD_11", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_OUTGOING_NOT_FOUND" } ] } } }, "/swift-transfers": { "get": { "operationId": "get-swift-transfer-list", "tags": [ "swift-transfers" ], "summary": "get-swift-transfer-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. 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": "get-swift-transfer-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers", "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": "SwiftTransferDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": "MTMessagesToCreateType", "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": "ImportTransferAction", "nullable": false, "collection": false }, { "name": "IsManuel", "declared_type": "bool", "nullable": false, "collection": false } ], "naming": "Member names are the service's declaration names." } } }, "/swift-transfers/filter": { "get": { "operationId": "get-swift-transfer-list-by-filter", "tags": [ "swift-transfers" ], "summary": "get-swift-transfer-list-by-filter", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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. 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": "get-swift-transfer-list-by-filter", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/filter", "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": "SwiftTransferDto", "collection": true, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": "MTMessagesToCreateType", "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": "ImportTransferAction", "nullable": false, "collection": false }, { "name": "IsManuel", "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 } } }, "/swift-transfers/incoming/asking-branch-info": { "put": { "operationId": "incoming-asking-branch-info-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-asking-branch-info-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-asking-branch-info-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/asking-branch-info", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/incoming/asking-receivable": { "put": { "operationId": "incoming-asking-receivable-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-asking-receivable-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-asking-receivable-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/asking-receivable", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/incoming/cancel": { "put": { "operationId": "incoming-cancel-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-cancel-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-cancel-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/cancel", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/incoming/create": { "post": { "operationId": "incoming-create-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-create-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "swiftTransfer": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "x-aura-type": "unresolved" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "x-aura-type": "unresolved" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "x-aura-type": "unresolved" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "swiftTransfer" } }, "required": [ "customerId", "swiftTransfer" ] } } } }, "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. 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": "incoming-create-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/create", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SwiftTransfer", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "collection": false } ] } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftTransferDto", "payload": "SwiftTransferDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": "MTMessagesToCreateType", "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": "ImportTransferAction", "nullable": false, "collection": false }, { "name": "IsManuel", "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 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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } } }, "/swift-transfers/incoming/decline": { "put": { "operationId": "incoming-decline-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-decline-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-decline-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/decline", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/incoming/feedback": { "put": { "operationId": "incoming-feedback-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-feedback-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-feedback-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/feedback", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/incoming/init": { "put": { "operationId": "incoming-init-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-init-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "swiftTransfer": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "swiftTransfer" } }, "required": [ "swiftTransfer" ] } } } }, "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": 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": "incoming-init-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/init", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SwiftTransfer", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "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_FRGN_TRD_18", "status": 400, "message": null, "message_available": false, "constant_name": "NOT_CORRESPONDENT" } ] } } }, "/swift-transfers/incoming/received/create": { "post": { "operationId": "incoming-received-create-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-received-create-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "swiftTransfer": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "swiftTransfer" } }, "required": [ "swiftTransfer" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "incoming-received-create-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/received/create", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SwiftTransfer", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-transfers/incoming/return": { "put": { "operationId": "incoming-return-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-return-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-return-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/return", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/incoming/return-to-source": { "put": { "operationId": "incoming-return-to-source-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-return-to-source-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-return-to-source-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/return-to-source", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/incoming/set-processing": { "put": { "operationId": "incoming-set-processing-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-set-processing-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-set-processing-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/set-processing", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/incoming/set-waiting": { "put": { "operationId": "incoming-set-waiting-swift-transfer", "tags": [ "swift-transfers" ], "summary": "incoming-set-waiting-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "incoming-set-waiting-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/incoming/set-waiting", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } } }, "/swift-transfers/manual": { "post": { "operationId": "swift-transfer-manuel", "tags": [ "swift-transfers" ], "summary": "swift-transfer-manuel", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "type": "string", "x-aura-field-code": "code" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "type": "string", "x-aura-field-code": "code" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "type": "string", "x-aura-field-code": "code" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "type": "string", "x-aura-field-code": "code" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "type": "object", "x-aura-field-code": "queries" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "type": "string", "x-aura-field-code": "code" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "type": "string", "x-aura-field-code": "swiftIncomingStatus" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "type": "string", "x-aura-field-code": "code" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "type": "string", "x-aura-field-code": "swiftIncomingStatus" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorizationDto": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "x-aura-field-code": "transactionAuthorizationDetails" } } }, "x-aura-field-code": "transactionAuthorizationDto" }, "transactionAuthorizationId": { "type": "string", "x-aura-field-code": "transactionAuthorizationId" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "string", "x-aura-field-code": "swiftIncomingTransactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "x-aura-field-code": "code" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "type": "string", "format": "date", "x-aura-field-code": "transactionDate" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "type": "string", "format": "date", "x-aura-field-code": "valueDate" } }, "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "type": "string", "format": "date", "x-aura-field-code": "valueDate" } } } } } }, "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": 143, "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": "swift-transfer-manuel", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/manual", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftMessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderBankBICName", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderAccount", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderName", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderCity", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderCountry", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiverBankBICName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankTagType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankPartyIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankLocation", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankNameAndAddress1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankNameAndAddress2", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankNameAndAddress3", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankNameAndAddress4", "declared_type": null, "nullable": false, "collection": false }, { "name": "Beneficiary59Tag", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName2", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName3", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName4", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameBIC", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryBankBICName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ExpenseReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentExpenseReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderToReceiverInfoCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderToReceiverInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageContentTxt", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageContentHtml", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageContentPairTxt", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageContentPairHtml", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICName", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICName", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructedAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "InstructedCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "UsdAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "OldStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "BusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "PairReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "SwiftIncomingId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CancellationNarrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderingBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderingBankBICName", "declared_type": null, "nullable": false, "collection": false }, { "name": "OrderingBankCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsCheck", "declared_type": null, "nullable": true, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "IncomingSwiftSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryBankNameAndAddress1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryBankNameAndAddress2", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryBankNameAndAddress3", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryBankNameAndAddress4", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryBankPartyIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryTagType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryBankNameAndAddress1", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryBankNameAndAddress2", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryBankNameAndAddress3", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryBankNameAndAddress4", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryBankPartyIdentifier", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryTagType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryIntermediaryBankBICName", "declared_type": null, "nullable": false, "collection": false }, { "name": "AddToSwiftMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentBankIBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionAuthorizationDto", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsGLAccounting", "declared_type": null, "nullable": false, "collection": false }, { "name": "ActiveWorkgroupId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "CreatedActiveWorkgroupId", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCommentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "FeedbackNote", "declared_type": null, "nullable": false, "collection": false }, { "name": "MtId", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCharges71Tag", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionAuthorizationId", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsImportDocument", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedDocumentReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "RelatedDocumentTermIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFullName", "declared_type": null, "nullable": false, "collection": false }, { "name": "SenderFullNameAndAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "collection": false }, { "name": "DetailsofCharges", "declared_type": null, "nullable": false, "collection": false }, { "name": "DetailsofAmountsAdded", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructedValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "PlatformStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "PlatformStatusDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "PlatformReference", "declared_type": null, "nullable": false, "collection": false }, { "name": "PlatformErrorMessage", "declared_type": null, "nullable": false, "collection": false }, { "name": "Narrative", "declared_type": null, "nullable": false, "collection": false }, { "name": "NarrativeForFE", "declared_type": null, "nullable": false, "collection": false }, { "name": "Queries", "declared_type": null, "nullable": false, "collection": false }, { "name": "Consensus", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReturnToSourceNote", "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_FRGN_TRD_10", "status": 400, "message": null, "message_available": false, "constant_name": "ALREADY_PROCESSED" } ] } } }, "/swift-transfers/outgoing/cancel": { "put": { "operationId": "outgoing-cancel-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-cancel-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "outgoing-cancel-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/cancel", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/outgoing/create": { "post": { "operationId": "outgoing-create-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-create-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "swiftTransfer": { "type": "object", "x-aura-field-code": "swiftTransfer" } }, "required": [ "swiftTransfer" ] } } } }, "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": "outgoing-create-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/create", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SwiftTransfer", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/outgoing/create-for-import-document": { "post": { "operationId": "outgoing-create-swift-transfer-for-import-document", "tags": [ "swift-transfers" ], "summary": "outgoing-create-swift-transfer-for-import-document", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "outgoing-create-swift-transfer-for-import-document", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/create-for-import-document", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } } }, "/swift-transfers/outgoing/create-for-import-letter-credit": { "post": { "operationId": "outgoing-create-swift-transfer-for-import-letter-credit", "tags": [ "swift-transfers" ], "summary": "outgoing-create-swift-transfer-for-import-letter-credit", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "outgoing-create-swift-transfer-for-import-letter-credit", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/create-for-import-letter-credit", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } } }, "/swift-transfers/outgoing/decline": { "put": { "operationId": "outgoing-decline-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-decline-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "outgoing-decline-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/decline", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/outgoing/edit": { "put": { "operationId": "outgoing-edit-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-edit-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "swiftTransfer": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "string", "x-aura-field-code": "transactionTypeValue" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "swiftTransfer" } }, "required": [ "swiftTransfer" ] } } } }, "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": 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": "outgoing-edit-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/edit", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SwiftTransfer", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/outgoing/feedback": { "put": { "operationId": "outgoing-feedback-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-feedback-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "outgoing-feedback-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/feedback", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/outgoing/init": { "post": { "operationId": "outgoing-init-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-init-swift-transfer", "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "x-aura-field-code": "model" } } } } } }, "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 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": "outgoing-init-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/init", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "collection": false } ] } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftTransferDto", "payload": "SwiftTransferDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": "MTMessagesToCreateType", "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": "ImportTransferAction", "nullable": false, "collection": false }, { "name": "IsManuel", "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 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_FRGN_TRD_19", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_REFERENCE_NUMBER" }, { "code": "ERR_FRGN_TRD_24", "status": 400, "message": null, "message_available": false, "constant_name": "INSUFFICIENT_BALANCE" } ] } } }, "/swift-transfers/outgoing/payback": { "put": { "operationId": "outgoing-payback-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-payback-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "outgoing-payback-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/payback", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" } ] } } }, "/swift-transfers/outgoing/save": { "post": { "operationId": "outgoing-save-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-save-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "outgoing-save-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/save", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-transfers/outgoing/send": { "post": { "operationId": "outgoing-send-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-send-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "swiftTransfer": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "swiftTransfer" } }, "required": [ "swiftTransfer" ] } } } }, "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": "outgoing-send-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/send", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SwiftTransfer", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" }, { "code": "ERR_FRGN_TRD_17", "status": 400, "message": null, "message_available": false, "constant_name": "INVALID_SWIFT_TRANSFER_STATE" }, { "code": "ERR_FRGN_TRD_35", "status": 400, "message": null, "message_available": false, "constant_name": "NO_MESSAGE_TO_SEND" } ] } } }, "/swift-transfers/outgoing/set-completed": { "put": { "operationId": "outgoing-set-completed-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-set-completed-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "outgoing-set-completed-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/set-completed", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } } }, "/swift-transfers/outgoing/set-error": { "put": { "operationId": "outgoing-set-error-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-set-error-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "outgoing-set-error-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/set-error", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } } }, "/swift-transfers/outgoing/set-messages": { "post": { "operationId": "outgoing-set-swift-transfer-messages", "tags": [ "swift-transfers" ], "summary": "outgoing-set-swift-transfer-messages", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "swiftTransfer": { "type": "object", "x-aura-field-code": "swiftTransfer" } }, "required": [ "swiftTransfer" ] } } } }, "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 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": "outgoing-set-swift-transfer-messages", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/set-messages", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "SwiftTransfer", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "collection": false } ] } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "ApiResponse", "envelopes": [ "ApiResponse" ], "payload": "SwiftTransferDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": "MTMessagesToCreateType", "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": "ImportTransferAction", "nullable": false, "collection": false }, { "name": "IsManuel", "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 single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-transfers/outgoing/set-processing": { "put": { "operationId": "outgoing-set-processing-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-set-processing-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "id" ] } } } }, "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": 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": "outgoing-set-processing-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/set-processing", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } } }, "/swift-transfers/outgoing/validate": { "post": { "operationId": "outgoing-validate-swift-transfer", "tags": [ "swift-transfers" ], "summary": "outgoing-validate-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "x-aura-type": "unresolved" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "x-aura-type": "unresolved" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "x-aura-type": "unresolved" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "x-aura-type": "unresolved" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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 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": "outgoing-validate-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/outgoing/validate", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Model", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": null, "nullable": false, "collection": false } ] } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftTransferDto", "payload": "SwiftTransferDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": "MTMessagesToCreateType", "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": "ImportTransferAction", "nullable": false, "collection": false }, { "name": "IsManuel", "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 single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-transfers/process": { "post": { "operationId": "process-swift-transfer", "tags": [ "swift-transfers" ], "summary": "process-swift-transfer", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "fiTransferId": { "type": "integer", "format": "int32", "x-aura-field-code": "fiTransferId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "incomingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "incomingDate" }, "mTId": { "x-aura-type": "unresolved" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "swiftTransferStatus" } }, "required": [ "fiTransferId", "id", "incomingDate", "mTId", "messageText", "messageType", "reference", "status" ] } } } }, "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": 8, "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": "process-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/process", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTId", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageText", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "IncomingDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "FiTransferId", "declared_type": null, "nullable": false, "collection": false } ] }, "x-aura-code-response": { "state": "structure", "declared_type": "SwiftTransferDto", "payload": "SwiftTransferDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": "MTMessagesToCreateType", "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": "ImportTransferAction", "nullable": false, "collection": false }, { "name": "IsManuel", "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 single-record.", "code_response_state": "structure", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/swift-transfers/set-header-bic-code": { "post": { "operationId": "swift-transfer-set-header-bICCode", "tags": [ "swift-transfers" ], "summary": "swift-transfer-set-header-bICCode", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "bICCode": { "type": "string", "x-aura-field-code": "bICCode" }, "code": { "x-aura-type": "unresolved" } }, "required": [ "bICCode", "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": 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": "swift-transfer-set-header-bICCode", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/set-header-bic-code", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Code", "declared_type": null, "nullable": false, "collection": false }, { "name": "BICCode", "declared_type": null, "nullable": false, "collection": false } ] }, "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" } } }, "/swift-transfers/{id}": { "delete": { "operationId": "delete-swift-transfer", "tags": [ "swift-transfers" ], "summary": "delete-swift-transfer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } } ], "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-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/{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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } }, "get": { "operationId": "get-swift-transfer-by-id", "tags": [ "swift-transfers" ], "summary": "get-swift-transfer-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 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": "get-swift-transfer-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/{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": "SwiftTransferDto", "payload": "SwiftTransferDto", "collection": false, "members": [ { "name": "Id", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "Direction", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Status", "declared_type": "string", "nullable": false, "collection": false }, { "name": "UETR", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Reference", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": "DateTime", "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": "Guid", "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": "bool", "nullable": false, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": "string", "nullable": false, "collection": false }, { "name": "Amount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": "decimal", "nullable": false, "collection": false }, { "name": "Currency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": "decimal?", "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": "string", "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": "int", "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": "string", "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": "string", "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": "DateTime?", "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": "string", "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": "string", "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": "string", "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": "string", "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": "MTMessagesToCreateType", "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": "int?", "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": "int", "nullable": false, "collection": false }, { "name": "ImportTransferAction", "declared_type": "ImportTransferAction", "nullable": false, "collection": false }, { "name": "IsManuel", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } }, "put": { "operationId": "update-swift-transfer", "tags": [ "swift-transfers" ], "summary": "update-swift-transfer", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "model": { "type": "object", "properties": { "accountNumber": { "type": "string", "x-aura-field-code": "accountNumber" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "activeWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "activeWorkgroupId" }, "addToSwiftMessage": { "type": "boolean", "x-aura-field-code": "addToSwiftMessage" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "bankChargeAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "bankChargeAmount" }, "beneficiary59Tag": { "type": "string", "x-aura-field-code": "beneficiary59Tag" }, "beneficiaryAccountNumber": { "type": "string", "x-aura-field-code": "beneficiaryAccountNumber" }, "beneficiaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryBankBICCode" }, "beneficiaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryBankBICName" }, "beneficiaryBankLocation": { "type": "string", "x-aura-field-code": "beneficiaryBankLocation" }, "beneficiaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress1" }, "beneficiaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress2" }, "beneficiaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress3" }, "beneficiaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryBankNameAndAddress4" }, "beneficiaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryBankPartyIdentifier" }, "beneficiaryBankTagType": { "type": "string", "x-aura-field-code": "beneficiaryBankTagType" }, "beneficiaryFullName": { "type": "string", "x-aura-field-code": "beneficiaryFullName" }, "beneficiaryIntermediaryBankBICCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICCode" }, "beneficiaryIntermediaryBankBICName": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankBICName" }, "beneficiaryIntermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress1" }, "beneficiaryIntermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress2" }, "beneficiaryIntermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress3" }, "beneficiaryIntermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankNameAndAddress4" }, "beneficiaryIntermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryBankPartyIdentifier" }, "beneficiaryIntermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryNameCountryCode" }, "beneficiaryIntermediaryTagType": { "type": "string", "x-aura-field-code": "beneficiaryIntermediaryTagType" }, "beneficiaryName1": { "type": "string", "x-aura-field-code": "beneficiaryName1" }, "beneficiaryName2": { "type": "string", "x-aura-field-code": "beneficiaryName2" }, "beneficiaryName3": { "type": "string", "x-aura-field-code": "beneficiaryName3" }, "beneficiaryName4": { "type": "string", "x-aura-field-code": "beneficiaryName4" }, "beneficiaryNameBIC": { "type": "string", "x-aura-field-code": "beneficiaryNameBIC" }, "beneficiaryNameCountryCode": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryCode" }, "beneficiaryNameCountryName": { "type": "string", "x-aura-field-code": "beneficiaryNameCountryName" }, "branchCommentType": { "type": "integer", "format": "int32", "x-aura-field-code": "branchCommentType" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "cancellationNarrative": { "type": "string", "x-aura-field-code": "cancellationNarrative" }, "chargeDetail": { "type": "string", "x-aura-field-code": "chargeDetail" }, "consensus": { "type": "string", "x-aura-field-code": "consensus" }, "correspondentBankAccountId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentBankAccountId" }, "correspondentBankBICCode": { "type": "string", "x-aura-field-code": "correspondentBankBICCode" }, "correspondentBankIBAN": { "type": "string", "x-aura-field-code": "correspondentBankIBAN" }, "correspondentCustomerId": { "type": "integer", "format": "int32", "x-aura-field-code": "correspondentCustomerId" }, "correspondentExpenseReference": { "type": "string", "x-aura-field-code": "correspondentExpenseReference" }, "createdActiveWorkgroupId": { "type": "integer", "format": "int32", "x-aura-field-code": "createdActiveWorkgroupId" }, "currency": { "type": "string", "x-aura-field-code": "currency" }, "customerId": { "type": "string", "format": "uuid", "x-aura-field-code": "customerId" }, "detailsofAmountsAdded": { "type": "string", "x-aura-field-code": "detailsofAmountsAdded" }, "detailsofAmountsAddedAmountList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofAmountsAddedAmountList" } }, "detailsofCharges": { "type": "string", "x-aura-field-code": "detailsofCharges" }, "detailsofChargesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "detailsofChargesList" } }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "expenseReference": { "type": "string", "x-aura-field-code": "expenseReference" }, "feedbackNote": { "type": "string", "x-aura-field-code": "feedbackNote" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "importTransferAction": { "type": "integer", "format": "int32", "x-aura-field-code": "importTransferAction" }, "incomingSwiftSource": { "type": "string", "x-aura-field-code": "incomingSwiftSource" }, "instructedAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "instructedAmount" }, "instructedCurrency": { "type": "string", "x-aura-field-code": "instructedCurrency" }, "instructedValueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "instructedValueDate" }, "intermediaryBankBICCode": { "type": "string", "x-aura-field-code": "intermediaryBankBICCode" }, "intermediaryBankBICName": { "type": "string", "x-aura-field-code": "intermediaryBankBICName" }, "intermediaryBankNameAndAddress1": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress1" }, "intermediaryBankNameAndAddress2": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress2" }, "intermediaryBankNameAndAddress3": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress3" }, "intermediaryBankNameAndAddress4": { "type": "string", "x-aura-field-code": "intermediaryBankNameAndAddress4" }, "intermediaryBankPartyIdentifier": { "type": "string", "x-aura-field-code": "intermediaryBankPartyIdentifier" }, "intermediaryNameCountryCode": { "type": "string", "x-aura-field-code": "intermediaryNameCountryCode" }, "intermediaryTagType": { "type": "string", "x-aura-field-code": "intermediaryTagType" }, "isCheck": { "type": "boolean", "x-aura-field-code": "isCheck" }, "isDomestic": { "type": "boolean", "x-aura-field-code": "isDomestic" }, "isGLAccounting": { "type": "boolean", "x-aura-field-code": "isGLAccounting" }, "isImportDocument": { "type": "boolean", "x-aura-field-code": "isImportDocument" }, "mTMessagesToCreate": { "type": "string", "x-aura-field-code": "mTMessagesToCreate" }, "messageContentHtml": { "type": "string", "x-aura-field-code": "messageContentHtml" }, "messageContentPairHtml": { "type": "string", "x-aura-field-code": "messageContentPairHtml" }, "messageContentPairTxt": { "type": "string", "x-aura-field-code": "messageContentPairTxt" }, "messageContentTxt": { "type": "string", "x-aura-field-code": "messageContentTxt" }, "messageTypeScenario": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeScenario" }, "mtId": { "type": "string", "x-aura-field-code": "mtId" }, "narrative": { "type": "string", "x-aura-field-code": "narrative" }, "narrativeForFE": { "type": "string", "x-aura-field-code": "narrativeForFE" }, "narrativeForFEList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeForFEList" } }, "narrativeList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "narrativeList" } }, "netAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "netAmount" }, "oldStatus": { "type": "string", "x-aura-field-code": "oldStatus" }, "orderingBankBICCode": { "type": "string", "x-aura-field-code": "orderingBankBICCode" }, "orderingBankBICName": { "type": "string", "x-aura-field-code": "orderingBankBICName" }, "orderingBankCountryCode": { "type": "string", "x-aura-field-code": "orderingBankCountryCode" }, "pairReference": { "type": "string", "x-aura-field-code": "pairReference" }, "paymentCategoryDetail": { "x-aura-type": "unresolved" }, "paymentDescription": { "type": "string", "x-aura-field-code": "paymentDescription" }, "paymentPurposeCategory": { "x-aura-type": "unresolved" }, "platformErrorMessage": { "type": "string", "x-aura-field-code": "platformErrorMessage" }, "platformReference": { "type": "string", "x-aura-field-code": "platformReference" }, "platformStatus": { "type": "string", "x-aura-field-code": "platformStatus" }, "platformStatusDescription": { "type": "string", "x-aura-field-code": "platformStatusDescription" }, "provisionNumber": { "type": "integer", "format": "int32", "x-aura-field-code": "provisionNumber" }, "queries": { "x-aura-type": "unresolved" }, "queriesList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "queriesList" } }, "receiverBankBICCode": { "type": "string", "x-aura-field-code": "receiverBankBICCode" }, "receiverBankBICName": { "type": "string", "x-aura-field-code": "receiverBankBICName" }, "receiversCorrespondentBICCode": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICCode" }, "receiversCorrespondentBICName": { "type": "string", "x-aura-field-code": "receiversCorrespondentBICName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "relatedSwiftMessages": { "type": "array", "items": { "type": "object", "properties": { "createTime": { "type": "string", "format": "date-time", "x-aura-field-code": "createTime" }, "direction": { "type": "string", "x-aura-field-code": "direction" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "messageHtml": { "type": "string", "x-aura-field-code": "messageHtml" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageType": { "type": "string", "x-aura-field-code": "messageType" }, "messageTypeName": { "type": "string", "x-aura-field-code": "messageTypeName" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "relatedDocumentReference": { "type": "string", "x-aura-field-code": "relatedDocumentReference" }, "relatedDocumentTermIndex": { "type": "string", "x-aura-field-code": "relatedDocumentTermIndex" }, "relatedReference": { "type": "string", "x-aura-field-code": "relatedReference" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftTransferId": { "x-aura-type": "unresolved" } }, "required": [ "createTime", "direction", "id", "messageHtml", "messageText", "messageType", "messageTypeName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "status", "swiftIncomingId", "swiftTransferId" ], "x-aura-field-code": "relatedSwiftMessages" } }, "remittanceInformation": { "type": "string", "x-aura-field-code": "remittanceInformation" }, "remittanceInformationList": { "type": "array", "items": { "type": "object", "properties": { "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "code": { "x-aura-type": "unresolved" }, "currencyCode": { "type": "string", "x-aura-field-code": "currencyCode" }, "index": { "type": "integer", "format": "int32", "x-aura-field-code": "index" }, "text": { "type": "string", "x-aura-field-code": "text" }, "valueText": { "type": "string", "x-aura-field-code": "valueText" } }, "required": [ "amount", "code", "currencyCode", "index", "text", "valueText" ], "x-aura-field-code": "remittanceInformationList" } }, "returnToSourceNote": { "type": "string", "x-aura-field-code": "returnToSourceNote" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "senderAddress": { "type": "string", "x-aura-field-code": "senderAddress" }, "senderBankBICCode": { "type": "string", "x-aura-field-code": "senderBankBICCode" }, "senderBankBICName": { "type": "string", "x-aura-field-code": "senderBankBICName" }, "senderCity": { "type": "string", "x-aura-field-code": "senderCity" }, "senderCountry": { "type": "string", "x-aura-field-code": "senderCountry" }, "senderFullNameAndAddress": { "type": "string", "x-aura-field-code": "senderFullNameAndAddress" }, "senderName": { "type": "string", "x-aura-field-code": "senderName" }, "senderPostCode": { "type": "string", "x-aura-field-code": "senderPostCode" }, "senderReference": { "type": "string", "x-aura-field-code": "senderReference" }, "senderToReceiverInfoCode": { "type": "string", "x-aura-field-code": "senderToReceiverInfoCode" }, "senderToReceiverInformation": { "type": "string", "x-aura-field-code": "senderToReceiverInformation" }, "sendersCharges71Tag": { "type": "string", "x-aura-field-code": "sendersCharges71Tag" }, "sendersChargesAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "sendersChargesAmount" }, "sendersChargesCurrency": { "type": "string", "x-aura-field-code": "sendersChargesCurrency" }, "sendersCorrespondentBICCode": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICCode" }, "sendersCorrespondentBICName": { "type": "string", "x-aura-field-code": "sendersCorrespondentBICName" }, "statisticalCode": { "type": "string", "x-aura-field-code": "statisticalCode" }, "status": { "x-aura-type": "unresolved" }, "swiftIncomingId": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftIncomingId" }, "swiftMessageType": { "type": "string", "x-aura-field-code": "swiftMessageType", "x-aura-maskable": true }, "transactionAuthorization": { "type": "object", "properties": { "authorizedFullName": { "type": "string", "x-aura-field-code": "authorizedFullName" }, "businessKey": { "x-aura-type": "unresolved" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" }, "thirdPartyIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyIdentityNumber" }, "thirdPartyInstructionIdentityNumber": { "type": "string", "x-aura-field-code": "thirdPartyInstructionIdentityNumber" }, "thirdPartyName": { "type": "string", "x-aura-field-code": "thirdPartyName" }, "thirdPartyPhoneNumber": { "type": "string", "x-aura-field-code": "thirdPartyPhoneNumber" }, "transactionAuthorizationDetails": { "type": "array", "items": { "type": "object", "properties": { "authorizedId": { "type": "integer", "format": "int32", "x-aura-field-code": "authorizedId" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "swiftTransferId" } }, "required": [ "authorizedId", "id" ], "x-aura-field-code": "transactionAuthorizationDetails" } } }, "required": [ "authorizedFullName", "businessKey", "id", "processCode", "thirdPartyIdentityNumber", "thirdPartyInstructionIdentityNumber", "thirdPartyName", "thirdPartyPhoneNumber", "transactionAuthorizationDetails" ], "x-aura-field-code": "transactionAuthorization" }, "transactionAuthorizationId": { "x-aura-type": "unresolved" }, "transactionAuthorizationType": { "type": "string", "x-aura-field-code": "transactionAuthorizationType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionReasonType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionReasonType" }, "transactionType": { "type": "integer", "format": "int32", "x-aura-field-code": "transactionType" }, "transferMessageTransactionDefinitionList": { "type": "array", "items": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "messageCreationType": { "type": "string", "x-aura-field-code": "messageCreationType" }, "messageTransactionDtoItemInputModel": { "type": "object", "properties": { "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "amount": { "type": "number", "format": "decimal", "x-aura-field-code": "amount" }, "businessKey": { "type": "string", "x-aura-field-code": "businessKey" }, "messageContent": { "type": "string", "x-aura-field-code": "messageContent" }, "messageHTML": { "type": "string", "x-aura-field-code": "messageHTML" }, "messageText": { "type": "string", "x-aura-field-code": "messageText" }, "messageTransactionDetails": { "type": "array", "items": { "type": "object", "properties": { "messageFieldPropertyId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageFieldPropertyId" }, "messageFieldPropertyValue": { "type": "string", "x-aura-field-code": "messageFieldPropertyValue" } }, "required": [ "messageFieldPropertyId", "messageFieldPropertyValue" ], "x-aura-field-code": "messageTransactionDetails" } }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "receiver": { "type": "string", "x-aura-field-code": "receiver" }, "receiverAccount": { "type": "string", "x-aura-field-code": "receiverAccount" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "sender": { "type": "string", "x-aura-field-code": "sender" }, "senderAccount": { "type": "string", "x-aura-field-code": "senderAccount" }, "sourceId": { "type": "integer", "format": "int32", "x-aura-field-code": "sourceId" }, "sourceReference": { "type": "string", "x-aura-field-code": "sourceReference" }, "sourceType": { "type": "string", "x-aura-field-code": "sourceType" }, "transactionDate": { "x-aura-type": "unresolved" }, "transactionGuid": { "type": "string", "format": "uuid", "x-aura-field-code": "transactionGuid" }, "transferMessageDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "transferMessageDefinitionId" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountingBusinessKey", "amount", "businessKey", "messageContent", "messageHTML", "messageText", "messageTransactionDetails", "messageTypeDefinitionId", "receiver", "receiverAccount", "reference", "sender", "senderAccount", "sourceId", "sourceReference", "sourceType", "transactionDate", "transactionGuid", "transferMessageDefinitionId", "valueDate" ], "x-aura-field-code": "messageTransactionDtoItemInputModel" }, "messageTypeDefinitionId": { "type": "integer", "format": "int32", "x-aura-field-code": "messageTypeDefinitionId" }, "processCode": { "type": "string", "x-aura-field-code": "processCode" } }, "required": [ "code", "messageCreationType", "messageTransactionDtoItemInputModel", "messageTypeDefinitionId", "processCode" ], "x-aura-field-code": "transferMessageTransactionDefinitionList" } }, "transferSubject": { "type": "string", "x-aura-field-code": "transferSubject" }, "uETR": { "type": "string", "x-aura-field-code": "uETR" }, "usdAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "usdAmount" }, "valueDate": { "x-aura-type": "unresolved" } }, "required": [ "accountNumber", "accountingBusinessKey", "activeWorkgroupId", "addToSwiftMessage", "amount", "bankChargeAmount", "beneficiary59Tag", "beneficiaryAccountNumber", "beneficiaryBankBICCode", "beneficiaryBankBICName", "beneficiaryBankLocation", "beneficiaryBankNameAndAddress1", "beneficiaryBankNameAndAddress2", "beneficiaryBankNameAndAddress3", "beneficiaryBankNameAndAddress4", "beneficiaryBankPartyIdentifier", "beneficiaryBankTagType", "beneficiaryFullName", "beneficiaryIntermediaryBankBICCode", "beneficiaryIntermediaryBankBICName", "beneficiaryIntermediaryBankNameAndAddress1", "beneficiaryIntermediaryBankNameAndAddress2", "beneficiaryIntermediaryBankNameAndAddress3", "beneficiaryIntermediaryBankNameAndAddress4", "beneficiaryIntermediaryBankPartyIdentifier", "beneficiaryIntermediaryNameCountryCode", "beneficiaryIntermediaryTagType", "beneficiaryName1", "beneficiaryName2", "beneficiaryName3", "beneficiaryName4", "beneficiaryNameBIC", "beneficiaryNameCountryCode", "beneficiaryNameCountryName", "branchCommentType", "businessKey", "cancellationNarrative", "chargeDetail", "consensus", "correspondentBankAccountId", "correspondentBankBICCode", "correspondentBankIBAN", "correspondentCustomerId", "correspondentExpenseReference", "createdActiveWorkgroupId", "currency", "customerId", "detailsofAmountsAdded", "detailsofAmountsAddedAmountList", "detailsofCharges", "detailsofChargesList", "direction", "expenseReference", "feedbackNote", "groupGuid", "id", "importTransferAction", "incomingSwiftSource", "instructedAmount", "instructedCurrency", "instructedValueDate", "intermediaryBankBICCode", "intermediaryBankBICName", "intermediaryBankNameAndAddress1", "intermediaryBankNameAndAddress2", "intermediaryBankNameAndAddress3", "intermediaryBankNameAndAddress4", "intermediaryBankPartyIdentifier", "intermediaryNameCountryCode", "intermediaryTagType", "isCheck", "isDomestic", "isGLAccounting", "isImportDocument", "mTMessagesToCreate", "messageContentHtml", "messageContentPairHtml", "messageContentPairTxt", "messageContentTxt", "messageTypeScenario", "mtId", "narrative", "narrativeForFE", "narrativeForFEList", "narrativeList", "netAmount", "oldStatus", "orderingBankBICCode", "orderingBankBICName", "orderingBankCountryCode", "pairReference", "paymentCategoryDetail", "paymentDescription", "paymentPurposeCategory", "platformErrorMessage", "platformReference", "platformStatus", "platformStatusDescription", "provisionNumber", "queries", "queriesList", "receiverBankBICCode", "receiverBankBICName", "receiversCorrespondentBICCode", "receiversCorrespondentBICName", "reference", "relatedDocumentReference", "relatedDocumentTermIndex", "relatedReference", "relatedSwiftMessages", "remittanceInformation", "remittanceInformationList", "returnToSourceNote", "senderAccount", "senderAddress", "senderBankBICCode", "senderBankBICName", "senderCity", "senderCountry", "senderFullNameAndAddress", "senderName", "senderPostCode", "senderReference", "senderToReceiverInfoCode", "senderToReceiverInformation", "sendersCharges71Tag", "sendersChargesAmount", "sendersChargesCurrency", "sendersCorrespondentBICCode", "sendersCorrespondentBICName", "statisticalCode", "status", "swiftIncomingId", "swiftMessageType", "transactionAuthorization", "transactionAuthorizationId", "transactionAuthorizationType", "transactionDate", "transactionReasonType", "transactionType", "transferMessageTransactionDefinitionList", "transferSubject", "uETR", "usdAmount", "valueDate" ], "x-aura-field-code": "model" } }, "required": [ "model" ] } } } }, "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-swift-transfer", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "swift-transfers/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Model", "declared_type": null, "nullable": false, "collection": false, "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "Direction", "declared_type": null, "nullable": false, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "UETR", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "ValueDate", "declared_type": null, "nullable": false, "collection": false }, { "name": "CustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "FromAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "IBAN", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BranchName", "declared_type": null, "nullable": false, "collection": false }, { "name": "IsDomestic", "declared_type": null, "nullable": true, "collection": false }, { "name": "TransactionAuthorizationType", "declared_type": null, "nullable": false, "collection": false }, { "name": "RemittanceInformation", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentSource", "declared_type": null, "nullable": false, "collection": false }, { "name": "Amount", "declared_type": null, "nullable": false, "collection": false }, { "name": "NetAmount", "declared_type": null, "nullable": false, "collection": false }, { "name": "Currency", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersChargesAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "SendersChargesCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "BankChargeAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "BankChargeCurrency", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransactionReasonType", "declared_type": null, "nullable": false, "collection": false }, { "name": "TransferSubject", "declared_type": null, "nullable": false, "collection": false }, { "name": "PaymentPurposeCategory", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentCategoryDetail", "declared_type": null, "nullable": true, "collection": false }, { "name": "PaymentDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "StatisticalCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "InvoiceDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "BeneficiaryAccountNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryName1", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddress", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryNameCountryCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryAddressType", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCareOf", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiarySubDepartment", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryStreetName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBuildingName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryFloor", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryUnitNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostBox", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryRoom", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryPostCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryTownLocationName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryDistrictName", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryCountrySubdivision", "declared_type": null, "nullable": false, "collection": false }, { "name": "BeneficiaryBankBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "SendersCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ReceiversCorrespondentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent1BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent2BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "IntermediaryAgent3BICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "ThirdReimbursementAgentBICCode", "declared_type": null, "nullable": false, "collection": false }, { "name": "InstructionForNextAgent", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChargeDetail", "declared_type": null, "nullable": false, "collection": false }, { "name": "MTMessagesToCreate", "declared_type": null, "nullable": false, "collection": false }, { "name": "MessageTypeScenario", "declared_type": null, "nullable": true, "collection": false }, { "name": "ProvisionNumber", "declared_type": null, "nullable": true, "collection": false }, { "name": "CorrespondentBankAccountId", "declared_type": null, "nullable": false, "collection": false }, { "name": "CorrespondentCustomerId", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportTransferAction", "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_FRGN_TRD_16", "status": 400, "message": null, "message_available": false, "constant_name": "SWIFT_TRANSFER_NOT_FOUND" } ] } } }, "/term-details": { "get": { "operationId": "get-term-detail-list", "tags": [ "term-details" ], "summary": "get-term-detail-list", "parameters": [ { "name": "filter", "in": "query", "required": false, "schema": { "type": "object", "properties": { "code": { "x-aura-type": "unresolved" }, "expression": { "type": "string", "x-aura-field-code": "expression" }, "parameters": { "type": "object", "properties": { "comparer": { "type": "object", "x-aura-field-code": "comparer" }, "count": { "type": "integer", "format": "int32", "x-aura-field-code": "count" }, "item": { "type": "object", "x-aura-field-code": "item" }, "keys": { "x-aura-type": "unresolved" }, "values": { "x-aura-type": "unresolved" } }, "x-aura-field-code": "parameters" } }, "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 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": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "x-aura-type": "unresolved" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" }, "importDocumentId": { "x-aura-type": "unresolved" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "x-aura-type": "unresolved" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" }, "importDocumentId": { "x-aura-type": "unresolved" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } } }, "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": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "x-aura-type": "unresolved" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" }, "importDocumentId": { "x-aura-type": "unresolved" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } } }, "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-term-detail-list", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-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": "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": "unresolved", "note": "The repository declares `TermDetailDto` 3 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "IEnumerable", "envelopes": [ "IEnumerable" ], "payload": "TermDetailDto" } }, "post": { "operationId": "create-term-detail", "tags": [ "term-details" ], "summary": "create-term-detail", "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "x-aura-type": "unresolved" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importDocumentId": { "x-aura-type": "unresolved" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } }, "required": [ "acceptanceStatus", "accountingBusinessKey", "avalStatus", "chequeNumber", "exportDocumentId", "groupGuid", "importDocumentId", "maturityAmount", "maturityDueDate", "maturityInstrumentType", "maturityInstrumentTypeName", "maturityPaymentCondition", "maturityPaymentConditionDay", "maturityStartingDate", "policyCorrespondentReturnDate", "policyCustomerReturnDate", "policyDeliveryDate", "policyHolderOfDraft", "policyProtestType", "policyProtestTypeName", "policyReturnDate", "policyStatusOfDraft", "reference", "status", "termIndex", "termReturnDescription", "toTheOrderOfPolicy" ] } } } }, "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": 27, "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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-term-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "ChequeNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AcceptanceStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvalStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaturityAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityInstrumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaturityDueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityStartingDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityPaymentCondition", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaturityPaymentConditionDay", "declared_type": null, "nullable": true, "collection": false }, { "name": "ToTheOrderOfPolicy", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyProtestType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyHolderOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyStatusOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyDeliveryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PolicyReturnDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PolicyCustomerReturnDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PolicyCorrespondentReturnDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportDocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExportDocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "TermReturnDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaturityInstrumentTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyProtestTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "TermIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "code_cardinality": "single-record", "catalog_cardinality": "undeclared", "catalog_success_status": 200 } } }, "/term-details/{id}": { "delete": { "operationId": "delete-term-detail", "tags": [ "term-details" ], "summary": "delete-term-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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-term-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } }, "get": { "operationId": "get-term-detail-by-id", "tags": [ "term-details" ], "summary": "get-term-detail-by-id", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "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": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "x-aura-type": "unresolved" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" }, "importDocumentId": { "x-aura-type": "unresolved" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } } }, { "type": "array", "description": "Bare-array response possibility.", "items": { "type": "object", "properties": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "x-aura-type": "unresolved" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" }, "importDocumentId": { "x-aura-type": "unresolved" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } } }, "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": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "x-aura-type": "unresolved" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "id": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" }, "importDocumentId": { "x-aura-type": "unresolved" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } } }, "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-term-detail-by-id", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{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": "unresolved", "note": "The repository declares `TermDetailDto` 3 times and nothing in the route expression says which one. No structure is published rather than one picked at random.", "declared_type": "TermDetailDto", "payload": "TermDetailDto" }, "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } }, "put": { "operationId": "update-term-detail", "tags": [ "term-details" ], "summary": "update-term-detail", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "type": "object", "properties": { "acceptanceStatus": { "type": "boolean", "x-aura-field-code": "acceptanceStatus" }, "accountingBusinessKey": { "type": "string", "x-aura-field-code": "accountingBusinessKey" }, "avalStatus": { "type": "boolean", "x-aura-field-code": "avalStatus" }, "chequeNumber": { "type": "string", "x-aura-field-code": "chequeNumber" }, "exportDocumentId": { "type": "string", "x-aura-field-code": "exportDocumentId" }, "groupGuid": { "type": "string", "x-aura-field-code": "groupGuid" }, "importDocumentId": { "type": "string", "format": "uuid", "x-aura-field-code": "importDocumentId" }, "maturityAmount": { "type": "number", "format": "decimal", "x-aura-field-code": "maturityAmount" }, "maturityDueDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityDueDate" }, "maturityInstrumentType": { "type": "string", "x-aura-field-code": "maturityInstrumentType" }, "maturityInstrumentTypeName": { "type": "string", "x-aura-field-code": "maturityInstrumentTypeName" }, "maturityPaymentCondition": { "type": "string", "x-aura-field-code": "maturityPaymentCondition" }, "maturityPaymentConditionDay": { "type": "integer", "format": "int32", "x-aura-field-code": "maturityPaymentConditionDay" }, "maturityStartingDate": { "type": "string", "format": "date-time", "x-aura-field-code": "maturityStartingDate" }, "policyCorrespondentReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCorrespondentReturnDate" }, "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyDeliveryDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyDeliveryDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyProtestType": { "type": "string", "x-aura-field-code": "policyProtestType" }, "policyProtestTypeName": { "type": "string", "x-aura-field-code": "policyProtestTypeName" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "reference": { "type": "string", "x-aura-field-code": "reference" }, "status": { "type": "integer", "format": "int32", "x-aura-field-code": "termDetailStatus" }, "termIndex": { "type": "string", "x-aura-field-code": "termIndex" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" }, "toTheOrderOfPolicy": { "type": "string", "x-aura-field-code": "toTheOrderOfPolicy" } } } } } }, "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": 27, "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-term-detail", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{id}", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "ChequeNumber", "declared_type": null, "nullable": false, "collection": false }, { "name": "AcceptanceStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "AvalStatus", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaturityAmount", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityInstrumentType", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaturityDueDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityStartingDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "MaturityPaymentCondition", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaturityPaymentConditionDay", "declared_type": null, "nullable": true, "collection": false }, { "name": "ToTheOrderOfPolicy", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyProtestType", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyHolderOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyStatusOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyDeliveryDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PolicyReturnDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PolicyCustomerReturnDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "PolicyCorrespondentReturnDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "Status", "declared_type": null, "nullable": false, "collection": false }, { "name": "AccountingBusinessKey", "declared_type": null, "nullable": false, "collection": false }, { "name": "ImportDocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "ExportDocumentId", "declared_type": null, "nullable": true, "collection": false }, { "name": "GroupGuid", "declared_type": null, "nullable": false, "collection": false }, { "name": "TermReturnDescription", "declared_type": null, "nullable": false, "collection": false }, { "name": "MaturityInstrumentTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyProtestTypeName", "declared_type": null, "nullable": false, "collection": false }, { "name": "TermIndex", "declared_type": null, "nullable": false, "collection": false }, { "name": "Reference", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } } }, "/term-details/{id}/export-cancelled": { "post": { "operationId": "set-export-cancelled", "tags": [ "term-details" ], "summary": "set-export-cancelled", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-export-cancelled", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{id}/export-cancelled", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } } }, "/term-details/{id}/export-feedback": { "post": { "operationId": "set-export-feedback", "tags": [ "term-details" ], "summary": "set-export-feedback", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "policyCustomerReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyCustomerReturnDate" }, "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" }, "termReturnDescription": { "type": "string", "x-aura-field-code": "termReturnDescription" } }, "required": [ "policyCustomerReturnDate", "policyHolderOfDraft", "policyStatusOfDraft", "termReturnDescription" ] } } } }, "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": 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 declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-export-feedback", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{id}/export-feedback", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyStatusOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyHolderOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyCustomerReturnDate", "declared_type": null, "nullable": true, "collection": false }, { "name": "TermReturnDescription", "declared_type": null, "nullable": false, "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } } }, "/term-details/{id}/export-return": { "post": { "operationId": "set-export-return", "tags": [ "term-details" ], "summary": "set-export-return", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-export-return", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{id}/export-return", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } } }, "/term-details/{id}/import-cancelled": { "post": { "operationId": "set-import-cancelled", "tags": [ "term-details" ], "summary": "set-import-cancelled", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-import-cancelled", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{id}/import-cancelled", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } } }, "/term-details/{id}/import-feedback": { "post": { "operationId": "set-import-feedback", "tags": [ "term-details" ], "summary": "set-import-feedback", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" }, "policyStatusOfDraft": { "type": "string", "x-aura-field-code": "policyStatusOfDraft" } }, "required": [ "policyHolderOfDraft", "policyReturnDate", "policyStatusOfDraft" ] } } } }, "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-import-feedback", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{id}/import-feedback", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyStatusOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyHolderOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyReturnDate", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } } }, "/term-details/{id}/import-free-of-payment": { "post": { "operationId": "set-import-free-of-payment", "tags": [ "term-details" ], "summary": "set-import-free-of-payment", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "policyHolderOfDraft": { "type": "string", "x-aura-field-code": "policyHolderOfDraft" }, "policyReturnDate": { "type": "string", "format": "date-time", "x-aura-field-code": "policyReturnDate" } }, "required": [ "policyHolderOfDraft", "policyReturnDate" ] } } } }, "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-import-free-of-payment", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{id}/import-free-of-payment", "x-aura-request-contract": { "state": "structure", "note": "The fields a caller sends.", "members": [ { "name": "Id", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyHolderOfDraft", "declared_type": null, "nullable": false, "collection": false }, { "name": "PolicyReturnDate", "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } } }, "/term-details/{id}/import-return": { "post": { "operationId": "set-import-return", "tags": [ "term-details" ], "summary": "set-import-return", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "format": "uuid", "x-aura-field-code": "termDetailId" } } ], "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. An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "content": { "application/json": { "schema": { "type": "object", "description": "Body shape declared by the exact route registration for the catalog's 200 response.", "properties": { "id": { "type": "string", "format": "uuid", "description": "Identifier returned by the command.", "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-code-response" } } }, "x-aura-documentation": { "language": "en", "status": "source-grounded", "source": "exact-pinned-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": "set-import-return", "x-aura-domain": "foreign-trade", "x-aura-raw-url-path": "term-details/{id}/import-return", "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": "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-response-contract-disagreement": { "state": "catalog-union-withheld-for-exact-code-contract", "note": "An exact, uniquely bound route registration declares the command-id envelope, so this schema is the code-backed body contract.", "code_response_state": "command-id", "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_FRGN_TRD_41", "status": 400, "message": null, "message_available": false, "constant_name": "TERM_DETAIL_NOT_FOUND" } ] } } } }, "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": 11 }, "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" } } } } } } }