{ "openapi": "3.0.1", "info": { "title": "Public API", "description": "Public API", "contact": { "name": "Customs4trade", "url": "https://www.customs4trade.com", "email": "customersupport@customs4trade.com" }, "version": "1.0" }, "paths": { "/v1/articledataitems": { "post": { "tags": [ "Master data" ], "summary": "Article items", "description": "CAS provides the option to integrate master data into CAS about articles to be imported, exported or \r\nto be used in special customs procedures.\r\n\r\nLegal content can then be configured in CAS, e.g. by the use of the measure management module, so that the declarations \r\nare augmented in order to be compliant with all regulations.", "requestBody": { "description": "The article items to add or update in the master data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItems" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItems" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItems" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/businesspartners": { "post": { "tags": [ "Master data" ], "summary": "Business partners", "description": "Allows to add or update business partners in the master data", "requestBody": { "description": "The business partners to add or update in the master data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.BusinessPartnersIngestion" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.BusinessPartnersIngestion" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.BusinessPartnersIngestion" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/subscriptions": { "get": { "tags": [ "Notifications" ], "summary": "Get active subscriptions", "description": "Gets a list of active subscriptions.", "responses": { "200": { "description": "Returning the list of the active subscriptions.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:subscriptions" ] } ] }, "post": { "tags": [ "Notifications" ], "summary": "Create subscription", "description": "Creates a new subscription.", "requestBody": { "description": "The subscription model containing the parameters for the subscription.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.SubscriptionCreation" } } } }, "responses": { "201": { "description": "Returns the created subscription object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.SubscriptionDetails" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:subscriptions" ] } ] } }, "/v1/subscriptions/{subscriptionId}": { "delete": { "tags": [ "Notifications" ], "summary": "Delete subscription", "description": "Deletes a subscription given the subscription ID.", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "ID of the subscription to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The specified subscription was successfully deleted." }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:delete:subscriptions" ] } ] }, "get": { "tags": [ "Notifications" ], "summary": "Get subscription", "description": "Gets the subscription details given the subscription ID.", "operationId": "GetSubscriptionById", "parameters": [ { "name": "subscriptionId", "in": "path", "description": "ID of the subscription", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returning the details of the subscription specified with it's ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.SubscriptionDetails" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:subscriptions" ] } ] } }, "/v1/certificates-of-origin": { "post": { "tags": [ "Origin Management" ], "summary": "Certificate of origin", "description": "Allows to request a certificate of origin (based on a declaration).", "requestBody": { "description": "The request for certificate of origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateOfOrigin" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateOfOrigin" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateOfOrigin" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/certificates-of-origin/{certificateOfOriginId}/{attachmentId}": { "get": { "tags": [ "Origin Management" ], "summary": "Certificate of origin document", "description": "Used to download the content of an attachment of a certificate of origin.", "parameters": [ { "name": "certificateOfOriginId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:documents" ] } ] } }, "/v1/certificates-of-origin/{certificateOfOriginId}/{attachmentId}/url": { "get": { "tags": [ "Origin Management" ], "summary": "Certificate of origin document url", "description": "Used to obtain a temporarily accessible url to download the content of an attachment of a certificate of origin.", "parameters": [ { "name": "certificateOfOriginId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:documents" ] } ] } }, "/v1/customsshipments": { "post": { "tags": [ "Shipments" ], "summary": "Customs shipment", "description": "Used to create a customs shipment and start one or more customs flows.", "requestBody": { "description": "The customs shipment data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/declarations/{declarationId}": { "get": { "tags": [ "Shipments" ], "summary": "Get declaration", "description": "This endpoint returns the declaration data for the provided declarationId.", "parameters": [ { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "description": "Possible values: 'errors' & 'attachments'. Both can be combined by repeating the include parameter, or by providing them as comma separated values.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "itemIndex", "in": "query", "description": "Only returns the GAGI with the provided index. Watch out: no recalculation of total values on header level, apart from TotNumItems on SAD, which will be 1. (Temporary) fix", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Declaration" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Declaration" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:declarations" ] } ] }, "patch": { "tags": [ "Shipments" ], "summary": "Update declaration", "description": "This endpoint updates the declaration from given payload for the provided declarationId.", "parameters": [ { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Header.SingleAdministrativeDocumentEditable" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Header.SingleAdministrativeDocumentEditable" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Header.SingleAdministrativeDocumentEditable" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/declarations/{declarationId}/attachments/{attachmentId}": { "get": { "tags": [ "Shipments" ], "summary": "Get declaration attachment", "parameters": [ { "name": "declarationId", "in": "path", "description": "The unique identifier of the declaration", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The unique identifier of the attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:declarations" ] } ] } }, "/v1/declarations/{declarationId}/attachments/{attachmentId}/url": { "get": { "tags": [ "Shipments" ], "summary": "Get secured link to declaration attachment", "parameters": [ { "name": "declarationId", "in": "path", "description": "The unique identifier of the declaration", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The unique identifier of the attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:declarations" ] } ] } }, "/v1/declarations/{declarationId}/attachments/{documentType}/{attachmentId}": { "get": { "tags": [ "Shipments" ], "summary": "Get declaration attachment", "parameters": [ { "name": "declarationId", "in": "path", "description": "The unique identifier of the declaration", "required": true, "schema": { "type": "string" } }, { "name": "documentType", "in": "path", "description": "The document type (EAD, TSAD)", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The unique identifier of the attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:declarations" ] } ] } }, "/v1/declarations/{declarationId}/attachments/{documentType}/{attachmentId}/url": { "get": { "tags": [ "Shipments" ], "summary": "Get secured link to declaration attachment", "parameters": [ { "name": "declarationId", "in": "path", "description": "The unique identifier of the declaration", "required": true, "schema": { "type": "string" } }, { "name": "documentType", "in": "path", "description": "The document type (EAD, TSAD)", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The unique identifier of the attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:declarations" ] } ] } }, "/v1/declarations/{declarationId}/changedestination": { "post": { "tags": [ "Shipments" ], "summary": "Change of destination", "description": "Triggers a change of destination for an EMCS excise declaration. This action will automatically split the declaration and submit the change.", "parameters": [ { "name": "declarationId", "in": "path", "description": "This declarationId is used as the Declaration ID for your declaration in CAS", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Change of destination action parameters", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ChangeDestinationParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ChangeDestinationParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ChangeDestinationParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ChangeDestinationParameters" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ChangeDestinationParameters" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ChangeDestinationParameters" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ChangeDestinationParameters" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/complementaryexplanation": { "post": { "tags": [ "Shipments" ], "summary": "Submit Complementary Explanation", "description": "Submits complementary explanation for an EMCS excise movement.", "parameters": [ { "name": "declarationId", "in": "path", "description": "This declarationId is used as the Declaration ID for your declaration in CAS", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Complementary explanation action parameters", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationParameters" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationParameters" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationParameters" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationParameters" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/delayfordelivery": { "post": { "tags": [ "Shipments" ], "summary": "Delay for delivery", "description": "Submits a delay for delivery notification for an EMCS excise movement.", "parameters": [ { "name": "declarationId", "in": "path", "description": "This declarationId is used as the Declaration ID for your declaration in CAS", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delay for delivery action parameters", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.DelayForDelivery.DelayForDeliveryParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.DelayForDelivery.DelayForDeliveryParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.DelayForDelivery.DelayForDeliveryParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.DelayForDelivery.DelayForDeliveryParameters" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.DelayForDelivery.DelayForDeliveryParameters" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.DelayForDelivery.DelayForDeliveryParameters" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.DelayForDelivery.DelayForDeliveryParameters" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/generatesad": { "post": { "tags": [ "Shipments" ], "summary": "Generate SAD", "description": "Generates an single administrative document (SAD) and makes it available for download.", "parameters": [ { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/goodsarrived": { "post": { "tags": [ "Shipments" ], "summary": "Goods Arrived action", "description": "Indicate that the goods have arrived. Can be used when the declaration is in the status GoodsNotArrived.", "parameters": [ { "name": "declarationId", "in": "path", "description": "This declarationId is used as the Declaration ID for your declaration in CAS", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/invalidate": { "post": { "tags": [ "Shipments" ], "summary": "Invalidate declaration", "description": "Invalidates the declaration when allowed.", "parameters": [ { "name": "declarationId", "in": "path", "description": "This declarationId is used as the Declaration ID for your declaration in CAS", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Invalidation action parameters", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.Invalidation.InvalidationParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.Invalidation.InvalidationParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.Invalidation.InvalidationParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.Invalidation.InvalidationParameters" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.Invalidation.InvalidationParameters" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.Invalidation.InvalidationParameters" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.Invalidation.InvalidationParameters" } } } }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/items": { "post": { "tags": [ "Shipments" ], "summary": "Create declaration item", "description": "This endpoint creates the declaration item from given payload for the provided declarationId.", "parameters": [ { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGovernmentAgencyGoodsItemEditable" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGovernmentAgencyGoodsItemEditable" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGovernmentAgencyGoodsItemEditable" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/declarations/{declarationId}/items/{governmentAgencyGoodsItemId}": { "delete": { "tags": [ "Shipments" ], "summary": "Delete declaration item", "description": "This endpoint deletes the declaration item by declarationId and governmentAgencyGoodsItemId.", "parameters": [ { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "governmentAgencyGoodsItemId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "202": { "description": "Accepted, will be processed asynchronously" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] }, "get": { "tags": [ "Shipments" ], "summary": "Get declaration item", "description": "This endpoint returns the declaration item for the provided declarationId and governmentAgencyGoodsItemId.", "parameters": [ { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "governmentAgencyGoodsItemId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGovernmentAgencyGoodsItem" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGovernmentAgencyGoodsItem" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:declarations" ] } ] }, "patch": { "tags": [ "Shipments" ], "summary": "Update declaration item", "description": "This endpoint updates the declaration item from given payload for the provided declarationId and governmentAgencyGoodsItemId.", "parameters": [ { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "governmentAgencyGoodsItemId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGovernmentAgencyGoodsItemEditable" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGovernmentAgencyGoodsItemEditable" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGovernmentAgencyGoodsItemEditable" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/declarations/{declarationId}/receiptreport": { "post": { "tags": [ "Shipments" ], "summary": "Submit report of receipt", "description": "Submit report of receipt for excise movement when allowed.", "parameters": [ { "name": "declarationId", "in": "path", "description": "This declarationId is used as the Declaration ID for your declaration in CAS", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Report of receipt action parameters", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReceiptReportParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReceiptReportParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReceiptReportParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReceiptReportParameters" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReceiptReportParameters" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReceiptReportParameters" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReceiptReportParameters" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/rejectoralertead": { "post": { "tags": [ "Shipments" ], "summary": "Reject or Alert EAD", "description": "Reject or alert the electronic administrative document (EAD) for excise movements.", "parameters": [ { "name": "declarationId", "in": "path", "description": "This declarationId is used as the Declaration ID for your declaration in CAS", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Reject or alert EAD action parameters", "content": { "application/json-patch+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.RejectOrAlertEad.RejectOrAlertEadParameters" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.RejectOrAlertEad.RejectOrAlertEadParameters" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.RejectOrAlertEad.RejectOrAlertEadParameters" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.RejectOrAlertEad.RejectOrAlertEadParameters" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.RejectOrAlertEad.RejectOrAlertEadParameters" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.RejectOrAlertEad.RejectOrAlertEadParameters" } }, "application/*+xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.RejectOrAlertEad.RejectOrAlertEadParameters" } } }, "required": true }, "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/submit": { "post": { "tags": [ "Shipments" ], "summary": "Submit declaration", "description": "Submit declaration to customs when allowed. Can be used when the declaration is in the status Valid.", "parameters": [ { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/{declarationId}/unloadinginformation": { "get": { "tags": [ "Shipments" ], "summary": "Get unloading information for a declaration", "parameters": [ { "name": "declarationId", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "original", "in": "query", "schema": { "type": "boolean", "default": false } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationResponse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationResponse" } } } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:declarations" ] } ] }, "patch": { "tags": [ "Shipments" ], "summary": "Update unloading information for a declaration", "parameters": [ { "name": "declarationId", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationPatchRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationPatchRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationPatchRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/declarations/{declarationId}/validate": { "post": { "tags": [ "Shipments" ], "summary": "Validate declaration", "description": "Validates the declaration. Typically done after the declaration has been corrected after some validation errors.", "parameters": [ { "name": "declarationId", "in": "path", "description": "This declarationId is used as the Declaration ID for your declaration in CAS", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/declarations/search": { "get": { "tags": [ "Shipments" ], "summary": "Search declarations", "parameters": [ { "name": "ExternalReference", "in": "query", "description": "External reference number", "schema": { "type": "string", "description": "External reference number", "nullable": true } }, { "name": "Direction", "in": "query", "description": "Direction of the shipment, can only be \"IN\" or \"OUT\"", "schema": { "type": "string", "description": "Direction of the shipment, can only be \"IN\" or \"OUT\"", "nullable": true } }, { "name": "ShipFrom", "in": "query", "description": "Country from where shipment is send (format: ISO 3166-1 2-alpha code)", "schema": { "type": "string", "description": "Country from where shipment is send (format: ISO 3166-1 2-alpha code)", "nullable": true } }, { "name": "ShipTo", "in": "query", "description": "Country to which shipment is send (format: ISO 3166-1 2-alpha code)", "schema": { "type": "string", "description": "Country to which shipment is send (format: ISO 3166-1 2-alpha code)", "nullable": true } }, { "name": "Lrn", "in": "query", "description": "Local reference number, FunctionRefNum", "schema": { "type": "string", "description": "Local reference number, FunctionRefNum", "nullable": true } }, { "name": "Mrn", "in": "query", "description": "DocRefNum", "schema": { "type": "string", "description": "DocRefNum", "nullable": true } }, { "name": "Arc", "in": "query", "description": "Administrative reference code", "schema": { "type": "string", "description": "Administrative reference code", "nullable": true } }, { "name": "CustomsFlow", "in": "query", "description": "Customs flow name", "schema": { "type": "string", "description": "Customs flow name", "nullable": true } }, { "name": "CustomsFlowStep", "in": "query", "description": "Customs flow step name", "schema": { "type": "array", "items": { "type": "string" }, "description": "Customs flow step name", "nullable": true } }, { "name": "CurrentStatus", "in": "query", "description": "Status of declaration", "schema": { "type": "array", "items": { "type": "string" }, "description": "Status of declaration", "nullable": true } }, { "name": "Jurisdiction", "in": "query", "description": "Customs jurisdiction (format: ISO 3166-1 2-alpha code)", "schema": { "type": "array", "items": { "type": "string" }, "description": "Customs jurisdiction (format: ISO 3166-1 2-alpha code)", "nullable": true } }, { "name": "StorageLocation", "in": "query", "description": "Storage location name", "schema": { "type": "array", "items": { "type": "string" }, "description": "Storage location name", "nullable": true } }, { "name": "Ucr", "in": "query", "description": "Unique Consignment Reference", "schema": { "type": "string", "description": "Unique Consignment Reference", "nullable": true } }, { "name": "DeclarationDateFrom", "in": "query", "description": "Earliest declaration date (format: Iso8601 datetime string)", "schema": { "type": "string", "description": "Earliest declaration date (format: Iso8601 datetime string)", "format": "date-time", "nullable": true } }, { "name": "DeclarationDateTo", "in": "query", "description": "Latest declaration date (format: Iso8601 datetime string)", "schema": { "type": "string", "description": "Latest declaration date (format: Iso8601 datetime string)", "format": "date-time", "nullable": true } }, { "name": "CreationDateFrom", "in": "query", "description": "Earliest date that declaration was created (format: Iso8601 datetime string)", "schema": { "type": "string", "description": "Earliest date that declaration was created (format: Iso8601 datetime string)", "format": "date-time", "nullable": true } }, { "name": "CreationDateTo", "in": "query", "description": "Latest date that declaration was created (format: Iso8601 datetime string)", "schema": { "type": "string", "description": "Latest date that declaration was created (format: Iso8601 datetime string)", "format": "date-time", "nullable": true } }, { "name": "LastUpdatedFrom", "in": "query", "description": "Earliest that declaration was updated last (format: Iso8601 datetime string)", "schema": { "type": "string", "description": "Earliest that declaration was updated last (format: Iso8601 datetime string)", "format": "date-time", "nullable": true } }, { "name": "LastUpdatedTo", "in": "query", "description": "Latest that declaration was updated last (format: Iso8601 datetime string)", "schema": { "type": "string", "description": "Latest that declaration was updated last (format: Iso8601 datetime string)", "format": "date-time", "nullable": true } }, { "name": "Limit", "in": "query", "description": "Number of results to retrieve, max 100. Defaults to 100. (format: n..2)", "schema": { "maximum": 100, "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "Number of results to retrieve, max 100. Defaults to 100. (format: n..2)", "format": "int32", "default": 100 } }, { "name": "Offset", "in": "query", "description": "Amount of results to skip, must be at least 0. Should be divisible by the provided Cas.Public.Api.Contract.PagingRequest.Limit. Defaults to 0.", "schema": { "minimum": 0, "type": "integer", "description": "Amount of results to skip, must be at least 0. Should be divisible by the provided Cas.Public.Api.Contract.PagingRequest.Limit. Defaults to 0.", "format": "int32", "default": 0 } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.DeclarationPointers" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.DeclarationPointers" } } } }, "400": { "description": "Bad request, please fix the input", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Rffc7807BadRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Rffc7807BadRequest" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/shipments": { "post": { "tags": [ "Shipments" ], "summary": "Create shipment", "description": "Create a shipment which later can be used as a source for creating customs shipments.", "requestBody": { "description": "The shipment data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Shipment.V1.Shipment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Shipment.V1.Shipment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Shipment.V1.Shipment" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/simulations/calculateduties": { "post": { "tags": [ "Simulations" ], "summary": "Simulate duty calculations", "description": "Used to simulate duty calculations based on the provided customs shipment data. Master data is enriched from the configuration and deductions are executed as per defined decision tables", "parameters": [ { "name": "type", "in": "query", "description": "The duty types to be calculated. Required. Options: [excise]", "schema": { "type": "array", "items": { "type": "string" } } } ], "requestBody": { "description": "The customs shipment data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Declaration" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Declaration" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/formulas": { "post": { "tags": [ "Special procedures" ], "summary": "Formula", "description": "For some special procedures CAS needs to have knowledge about the formulas of the products. They can be ingested as master data, \r\ntransactionally for each individual product or batch.", "requestBody": { "description": "The formula data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Formula.V1.Formula" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Formula.V1.Formula" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Formula.V1.Formula" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/materiallists": { "post": { "tags": [ "Special procedures" ], "summary": "Material list", "description": "For some special procedures CAS needs to have knowledge about the material list of the products. \r\nThey can be ingested transactionally for each individual product or batch.", "requestBody": { "description": "The material list data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialList" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialList" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialList" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/materiallists/invalidate": { "post": { "tags": [ "Special procedures" ], "summary": "Invalidate material list", "description": "Allows to invalidate a material list that was previously added.", "requestBody": { "description": "The invaidation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialListInvalidationRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialListInvalidationRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialListInvalidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/authorizationstatus": { "get": { "tags": [ "Status" ], "summary": "Validate token", "description": "Allows validating the validity of a token for this API.\r\nThe function validates the token and return the claims found in the token.", "responses": { "200": { "description": "OK, returns info about the validated token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Infrastructure.Auth.AuthorizationDetails" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Infrastructure.Auth.AuthorizationDetails" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ ] } ] } }, "/v1/movementorders": { "post": { "tags": [ "Warehouse management system" ], "summary": "Stock movement", "description": "Create a movement request that will be processed in special procedure or tax warehouse stock management.", "requestBody": { "description": "The stock movement data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementIngest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementIngest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementIngest" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:create:wms" ] } ] } }, "/v1/movementorders/{id}": { "get": { "tags": [ "Warehouse management system" ], "summary": "Get movement order by identifier", "parameters": [ { "name": "id", "in": "path", "description": "The movement order identifier.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.MovementOrders.MovementOrder" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.MovementOrders.MovementOrder" } } } }, "404": { "description": "Not Found" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "security": [ { "Bearer": [ "scope:read:wms" ] } ] } }, "/v1/movements": { "post": { "tags": [ "Warehouse management system" ], "summary": "Stock movement", "description": "Create a movement request that will be processed in special procedure or tax warehouse stock management.", "requestBody": { "description": "The stock movement data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementIngest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementIngest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementIngest" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/{tenantId}/certificates-of-origin/{certificateOfOriginId}/{attachmentId}": { "get": { "tags": [ "Deprecated" ], "summary": "Certificate of origin document", "description": "Used to download the content of an attachment of a certificate of origin.", "parameters": [ { "name": "tenantId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "certificateOfOriginId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "307": { "description": "Temporary Redirect" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:read:documents", "tenantId" ] } ] } }, "/v1/{tenantId}/certificates-of-origin/{certificateOfOriginId}/{attachmentId}/url": { "get": { "tags": [ "Deprecated" ], "summary": "Certificate of origin document url", "description": "Used to obtain a temporarily accessible url to download the content of an attachment of a certificate of origin.", "parameters": [ { "name": "tenantId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "certificateOfOriginId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:read:documents", "tenantId" ] } ] } }, "/v1/{tenantId}/declarations/{declarationId}": { "get": { "tags": [ "Deprecated" ], "summary": "Get declaration", "description": "This endpoint returns the declaration data for the provided declarationId.", "parameters": [ { "name": "tenantId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "declarationId", "in": "path", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "include", "in": "query", "description": "Possible values: 'errors' & 'attachments'. Both can be combined by repeating the include parameter, or by providing them as comma separated values.", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "itemIndex", "in": "query", "description": "Only returns the GAGI with the provided index. Watch out: no recalculation of total values on header level, apart from TotNumItems on SAD, which will be 1. (Temporary) fix", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Declaration" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Declaration" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:read:declarations", "tenantId" ] } ] } }, "/v1/{tenantId}/declarations/{declarationId}/attachments/{documentType}/{attachmentId}": { "get": { "tags": [ "Deprecated" ], "summary": "Get declaration attachment", "parameters": [ { "name": "tenantId", "in": "path", "description": "The unique identifier of the tenant", "required": true, "schema": { "type": "string" } }, { "name": "declarationId", "in": "path", "description": "The unique identifier of the declaration", "required": true, "schema": { "type": "string" } }, { "name": "documentType", "in": "path", "description": "The document type (EAD, TSAD)", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The unique identifier of the attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK" }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:read:declarations", "tenantId" ] } ] } }, "/v1/{tenantId}/declarations/{declarationId}/attachments/{documentType}/{attachmentId}/url": { "get": { "tags": [ "Deprecated" ], "summary": "Get secured link to declaration attachment", "parameters": [ { "name": "tenantId", "in": "path", "description": "The unique identifier of the tenant", "required": true, "schema": { "type": "string" } }, { "name": "declarationId", "in": "path", "description": "The unique identifier of the declaration", "required": true, "schema": { "type": "string" } }, { "name": "documentType", "in": "path", "description": "The document type (EAD, TSAD)", "required": true, "schema": { "type": "string" } }, { "name": "attachmentId", "in": "path", "description": "The unique identifier of the attachment", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Documents.AttachmentUrl" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:read:declarations", "tenantId" ] } ] } }, "/v1/{tenantId}/messagetypes/{messageType}/messages": { "post": { "tags": [ "Deprecated" ], "summary": "Ingest message", "description": "Generic endpoint to send messages to CAS for ingestion as a string. We advise not to use this endpoint, but the specific endpoints for the message types \r\ninstead. The specific endpoints perform a message format check immediately, giving you faster feedback then this generic endpoint.\r\n\r\n| Message type | Purpose |\r\n| :------------ | :------ |\r\n| CAS.ArticleDataItems.V1 | Add article items to master data |\r\n| CAS.CertificateOfOrigin.V1 | Request a certificate of origin |\r\n| CAS.CustomsShipment.V1 | Create a customs shipment and start a customs flow |\r\n| CAS.MaterialList.V1 | Add a material list |\r\n| CAS.MaterialList.Invalidation.V1 | Invalidate a material list |\r\n| CAS.Formula.V1 | Add a formula |\r\n| CAS.Movements.V1 | Create a stock movement |\r\n| CAS.GoodsArrived.V1 | Perform a **Goods Arrived** action |\r\n| CAS.DeclarationActions.Invalidate.V1 | **Invalidate** a declaration |\r\n| CAS.Shipment.V1 | Create a shipment to be used as the source for creating a customs shipment |", "parameters": [ { "name": "tenantId", "in": "path", "description": "The optional tenant ID for which you are creating the ingestion", "required": true, "schema": { "type": "string" } }, { "name": "messageType", "in": "path", "description": "Specificy message type of the data i the request body in the format \r\n {Publisher}.{MessageContent}.{MessageVersion}", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Used to specify an optional name for this message", "schema": { "type": "string" } } ], "requestBody": { "description": "payload", "content": { "application/json": { "schema": { "type": "string" } }, "application/xml": { "schema": { "type": "string" } }, "text/xml": { "schema": { "type": "string" } } }, "required": true }, "responses": { "201": { "description": "Accepted, returns the reference to the accepted message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnCreateMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnCreateMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages", "tenantId" ] } ] } }, "/v1/{tenantId}/subscriptions": { "get": { "tags": [ "Deprecated" ], "summary": "Get active subscriptions", "description": "Gets a list of active subscriptions.", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant ID for which you are creating the subscription.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returning the list of the active subscriptions.", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "string" } } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:read:subscriptions", "tenantId" ] } ] }, "post": { "tags": [ "Deprecated" ], "summary": "Create subscription", "description": "Creates a new subscription.", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant ID for which you are creating the subscription.", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "The subscription model containing the parameters for the subscription.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.SubscriptionCreation" } } } }, "responses": { "201": { "description": "Returns the created subscription object.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.SubscriptionDetails" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:subscriptions", "tenantId" ] } ] } }, "/v1/{tenantId}/subscriptions/{subscriptionId}": { "delete": { "tags": [ "Deprecated" ], "summary": "Delete subscription", "description": "Deletes a subscription given the subscription ID.", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant ID for which you are creating the subscription.", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "ID of the subscription to delete.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "The specified subscription was successfully deleted." }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:delete:subscriptions", "tenantId" ] } ] }, "get": { "tags": [ "Deprecated" ], "summary": "Get subscription", "description": "Gets the subscription details given the subscription ID.", "operationId": "GetSubscriptionByIdOld", "parameters": [ { "name": "tenantId", "in": "path", "description": "Tenant ID for which you are creating the subscription.", "required": true, "schema": { "type": "string" } }, { "name": "subscriptionId", "in": "path", "description": "ID of the subscription", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returning the details of the subscription specified with it's ID.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.SubscriptionDetails" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "202": { "description": "Accepted, will be processed asynchronously" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:read:subscriptions", "tenantId" ] } ] } }, "/v1/amendment": { "post": { "tags": [ "Deprecated" ], "summary": "Amendment", "description": "Used to initiate the **Amendment** action, to amend declarations released by customs. It is the equivalent of\r\nclicking the **Amend** button in the user interface of CAS.", "requestBody": { "description": "The amendment data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Amendment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Amendment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Amendment" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/certificatesoforigin": { "post": { "tags": [ "Deprecated" ], "summary": "Certificate of origin", "description": "Allows to request a certificate of origin (based on a declaration).", "requestBody": { "description": "The request for certificate of origin", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateOfOrigin" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateOfOrigin" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateOfOrigin" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/declarations/amendment": { "post": { "tags": [ "Deprecated" ], "summary": "Amendment", "description": "Used to initiate the **Amendment** action, to amend declarations released by customs. It is the equivalent of\r\nclicking the **Amend** button in the user interface of CAS.", "requestBody": { "description": "The amendment data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Amendment" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Amendment" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Amendment" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/declarations/goodsarrived": { "post": { "tags": [ "Deprecated" ], "summary": "Goods arrived", "description": "Used to perform the **Goods Arrived** action, which submits a presentation notification message to customs. \r\nIt is the equivalent of clicking the **Goods Arrived** button in the user interface of CAS.", "requestBody": { "description": "The data required for the goods arrived action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.GoodsArrived" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.GoodsArrived" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.GoodsArrived" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/declarations/invalidate": { "post": { "tags": [ "Deprecated" ], "summary": "Invalidate", "description": "Used to invalidate a declaration released by customs. It is the equivalent of clicking the **Invalidate** button in the user interface\r\nof CAS.", "requestBody": { "description": "The invalidation data", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Invalidation" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Invalidation" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.Invalidation" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/goodsarrived": { "post": { "tags": [ "Deprecated" ], "summary": "Goods arrived", "description": "Used to perform the **Goods Arrived** action, which submits a presentation notification message to customs. \r\nIt is the equivalent of clicking the **Goods Arrived** button in the user interface of CAS.", "requestBody": { "description": "The data required for the goods arrived action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.GoodsArrived" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.GoodsArrived" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.DeclarationActions.V1.GoodsArrived" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } }, "/v1/materiallistinvalidationrequests": { "post": { "tags": [ "Deprecated" ], "summary": "Invalidate material list", "description": "Allows to invalidate a material list that was previously added.", "requestBody": { "description": "The invaidation request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialListInvalidationRequest" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialListInvalidationRequest" } }, "text/xml": { "schema": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialListInvalidationRequest" } } }, "required": true }, "responses": { "202": { "description": "Accepted, will be processed asynchronously", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage" } } } }, "401": { "description": "Unauthorized, make sure to add a valid token in the authorization header" }, "403": { "description": "Forbidden, make sure to pass a token with the required audience and scopes" }, "400": { "description": "Bad request, please fix the input" }, "404": { "description": "Not Found, please check the used url / ids" }, "415": { "description": "Unsupported Media Type" }, "500": { "description": "Internal Server Error" }, "502": { "description": "Bad Gateway" }, "503": { "description": "Service Unavailable" } }, "deprecated": true, "security": [ { "Bearer": [ "scope:create:messages" ] } ] } } }, "components": { "schemas": { "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItems": { "required": [ "items", "messageType" ], "type": "object", "properties": { "version": { "maxLength": 16, "type": "string", "description": "Should always be \"1.0\".", "nullable": true }, "messageType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItems-MessageTypeEnum" }, "items": { "maxItems": 9999, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "A unique human readable identifier for a given article" }, "baseUom": { "maxLength": 3, "minLength": 1, "type": "string", "description": "The base unit of measurement of the article." }, "itemVersions": { "maxItems": 99, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "activeFrom": { "type": "string", "nullable": true }, "activeTo": { "type": "string", "nullable": true }, "description1": { "maxLength": 512, "minLength": 1, "type": "string", "description": "Main description of the article used in the customs declaration" }, "description2": { "maxLength": 512, "type": "string", "description": "Second description of the article shown in CAS", "nullable": true }, "description3": { "maxLength": 512, "type": "string", "description": "Third description of the article shown in CAS", "nullable": true }, "applicableForImport": { "type": "boolean", "description": "Indicates the article may be part of import declarations" }, "applicableForExport": { "type": "boolean", "description": "Indicates the article may be part of export declarations" }, "supQtyFactor": { "type": "number", "description": "In case this is required as determined by legal content this is the factor that will be used to convert from the BaseUoM to the supplementary quantity", "format": "double", "nullable": true }, "alcoholPercentageByVolume": { "minimum": 0, "type": "number", "description": "Alcoholic strength by volume expressed as a whole-number percentage. For example, 40% should be provided as 40, not 0.4", "format": "double", "nullable": true }, "dimension": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionDimension" }, "plants": { "maxItems": 99, "type": "array", "items": { "maxLength": 64, "minLength": 1, "type": "string", "xml": { "name": "plant" } }, "description": "The list of plants for which the version applies toIf not supplied the article version applies to all plants in the organisational structure", "nullable": true, "xml": { "wrapped": true } }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "type": { "maxLength": 32, "minLength": 1, "type": "string", "description": "The type of classifications. One of 'TARIC', 'CN'" }, "code": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The classification code" }, "specialProcedure": { "maxLength": 20, "type": "string", "description": "Indicates the classification is to be used in the context of a special procedure, currently only 'End Use' is supported", "nullable": true }, "consignedFromCountry": { "maxLength": 2, "type": "string", "description": "To support an item with different TARIC code depending on where the goods are consigned from", "nullable": true }, "jurisdictions": { "maxItems": 99, "type": "array", "items": { "maxLength": 2, "minLength": 2, "type": "string", "xml": { "name": "jurisdiction" } }, "description": "List of the country codes of the version may be used in.", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "classification" } }, "description": "The list of classifications of the article versionWhen not specified the article may not be used in declarationsAn alert will be raised in such case", "nullable": true, "xml": { "wrapped": true } }, "measure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionMeasure" }, "price": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionPrice" }, "packagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item", "nullable": true } }, "xml": { "name": "packaging" } }, "description": "The list of packagings", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "itemVersion" } }, "description": "Represents data that may change over time. When creating a new article it may contain multiple versions. When updating an article, the ingest may contain only one version with its ActiveFrom date later than the previous version", "xml": { "wrapped": true } } }, "xml": { "name": "item" } }, "description": "The collection of article data items to add or update", "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "This is the model used to add and update master data of article data items in CAS." }, "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItems-MessageTypeEnum": { "enum": [ "Delta", "InitialUpload" ], "type": "string", "description": "Should always be \"Delta\". Choosing \"InitialUpload\" has no effect on the processing of the data anymore.

Possible values:

", "example": "Delta" }, "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItem": { "required": [ "baseUom", "itemId", "itemVersions" ], "type": "object", "properties": { "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "A unique human readable identifier for a given article" }, "baseUom": { "maxLength": 3, "minLength": 1, "type": "string", "description": "The base unit of measurement of the article." }, "itemVersions": { "maxItems": 99, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "activeFrom": { "type": "string", "nullable": true }, "activeTo": { "type": "string", "nullable": true }, "description1": { "maxLength": 512, "minLength": 1, "type": "string", "description": "Main description of the article used in the customs declaration" }, "description2": { "maxLength": 512, "type": "string", "description": "Second description of the article shown in CAS", "nullable": true }, "description3": { "maxLength": 512, "type": "string", "description": "Third description of the article shown in CAS", "nullable": true }, "applicableForImport": { "type": "boolean", "description": "Indicates the article may be part of import declarations" }, "applicableForExport": { "type": "boolean", "description": "Indicates the article may be part of export declarations" }, "supQtyFactor": { "type": "number", "description": "In case this is required as determined by legal content this is the factor that will be used to convert from the BaseUoM to the supplementary quantity", "format": "double", "nullable": true }, "alcoholPercentageByVolume": { "minimum": 0, "type": "number", "description": "Alcoholic strength by volume expressed as a whole-number percentage. For example, 40% should be provided as 40, not 0.4", "format": "double", "nullable": true }, "dimension": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionDimension" }, "plants": { "maxItems": 99, "type": "array", "items": { "maxLength": 64, "minLength": 1, "type": "string", "xml": { "name": "plant" } }, "description": "The list of plants for which the version applies toIf not supplied the article version applies to all plants in the organisational structure", "nullable": true, "xml": { "wrapped": true } }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "type": { "maxLength": 32, "minLength": 1, "type": "string", "description": "The type of classifications. One of 'TARIC', 'CN'" }, "code": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The classification code" }, "specialProcedure": { "maxLength": 20, "type": "string", "description": "Indicates the classification is to be used in the context of a special procedure, currently only 'End Use' is supported", "nullable": true }, "consignedFromCountry": { "maxLength": 2, "type": "string", "description": "To support an item with different TARIC code depending on where the goods are consigned from", "nullable": true }, "jurisdictions": { "maxItems": 99, "type": "array", "items": { "maxLength": 2, "minLength": 2, "type": "string", "xml": { "name": "jurisdiction" } }, "description": "List of the country codes of the version may be used in.", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "classification" } }, "description": "The list of classifications of the article versionWhen not specified the article may not be used in declarationsAn alert will be raised in such case", "nullable": true, "xml": { "wrapped": true } }, "measure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionMeasure" }, "price": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionPrice" }, "packagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item", "nullable": true } }, "xml": { "name": "packaging" } }, "description": "The list of packagings", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "itemVersion" } }, "description": "Represents data that may change over time. When creating a new article it may contain multiple versions. When updating an article, the ingest may contain only one version with its ActiveFrom date later than the previous version", "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Represents an individual article" }, "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersion": { "required": [ "applicableForExport", "applicableForImport", "description1", "plants" ], "type": "object", "properties": { "activeFrom": { "type": "string", "nullable": true }, "activeTo": { "type": "string", "nullable": true }, "description1": { "maxLength": 512, "minLength": 1, "type": "string", "description": "Main description of the article used in the customs declaration" }, "description2": { "maxLength": 512, "type": "string", "description": "Second description of the article shown in CAS", "nullable": true }, "description3": { "maxLength": 512, "type": "string", "description": "Third description of the article shown in CAS", "nullable": true }, "applicableForImport": { "type": "boolean", "description": "Indicates the article may be part of import declarations" }, "applicableForExport": { "type": "boolean", "description": "Indicates the article may be part of export declarations" }, "supQtyFactor": { "type": "number", "description": "In case this is required as determined by legal content this is the factor that will be used to convert from the BaseUoM to the supplementary quantity", "format": "double", "nullable": true }, "alcoholPercentageByVolume": { "minimum": 0, "type": "number", "description": "Alcoholic strength by volume expressed as a whole-number percentage. For example, 40% should be provided as 40, not 0.4", "format": "double", "nullable": true }, "dimension": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionDimension" }, "plants": { "maxItems": 99, "type": "array", "items": { "maxLength": 64, "minLength": 1, "type": "string", "xml": { "name": "plant" } }, "description": "The list of plants for which the version applies toIf not supplied the article version applies to all plants in the organisational structure", "nullable": true, "xml": { "wrapped": true } }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "type": { "maxLength": 32, "minLength": 1, "type": "string", "description": "The type of classifications. One of 'TARIC', 'CN'" }, "code": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The classification code" }, "specialProcedure": { "maxLength": 20, "type": "string", "description": "Indicates the classification is to be used in the context of a special procedure, currently only 'End Use' is supported", "nullable": true }, "consignedFromCountry": { "maxLength": 2, "type": "string", "description": "To support an item with different TARIC code depending on where the goods are consigned from", "nullable": true }, "jurisdictions": { "maxItems": 99, "type": "array", "items": { "maxLength": 2, "minLength": 2, "type": "string", "xml": { "name": "jurisdiction" } }, "description": "List of the country codes of the version may be used in.", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "classification" } }, "description": "The list of classifications of the article versionWhen not specified the article may not be used in declarationsAn alert will be raised in such case", "nullable": true, "xml": { "wrapped": true } }, "measure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionMeasure" }, "price": { "$ref": "#/components/schemas/Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionPrice" }, "packagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item", "nullable": true } }, "xml": { "name": "packaging" } }, "description": "The list of packagings", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionClassification": { "required": [ "code", "jurisdictions", "type" ], "type": "object", "properties": { "type": { "maxLength": 32, "minLength": 1, "type": "string", "description": "The type of classifications. One of 'TARIC', 'CN'" }, "code": { "maxLength": 10, "minLength": 1, "type": "string", "description": "The classification code" }, "specialProcedure": { "maxLength": 20, "type": "string", "description": "Indicates the classification is to be used in the context of a special procedure, currently only 'End Use' is supported", "nullable": true }, "consignedFromCountry": { "maxLength": 2, "type": "string", "description": "To support an item with different TARIC code depending on where the goods are consigned from", "nullable": true }, "jurisdictions": { "maxItems": 99, "type": "array", "items": { "maxLength": 2, "minLength": 2, "type": "string", "xml": { "name": "jurisdiction" } }, "description": "List of the country codes of the version may be used in.", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionDimension": { "type": "object", "properties": { "width": { "type": "number", "description": "Gets or Sets Width", "format": "double", "nullable": true }, "length": { "type": "number", "description": "Gets or Sets Length", "format": "double", "nullable": true }, "height": { "type": "number", "description": "Gets or Sets Height", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionMeasure": { "type": "object", "properties": { "gmass": { "minimum": 0, "type": "number", "description": "Gross mass (kg)", "format": "double", "nullable": true }, "nmass": { "minimum": 0, "type": "number", "description": "Net mass (kg)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionPackaging": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.ArticleDataItem.V1.ArticleDataItemsItemItemVersionPrice": { "type": "object", "properties": { "amount": { "minimum": 0, "type": "number", "description": "Amount of the price of the article", "format": "double", "nullable": true }, "currency": { "maxLength": 3, "type": "string", "description": "Currency of the price of the article", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.BusinessPartners.V1.Address": { "type": "object", "properties": { "street": { "maxLength": 512, "type": "string", "nullable": true }, "number": { "maxLength": 16, "type": "string", "nullable": true }, "box": { "maxLength": 16, "type": "string", "nullable": true }, "zipCode": { "maxLength": 17, "type": "string", "nullable": true }, "city": { "maxLength": 85, "type": "string", "nullable": true }, "region": { "maxLength": 16, "type": "string", "nullable": true }, "countryCode": { "pattern": "^[A-Z]{2}$", "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.BusinessPartners.V1.BusinessPartner": { "required": [ "identification", "name", "storageLocations", "type" ], "type": "object", "properties": { "activeFrom": { "type": "string", "description": "ActiveFrom of the version to be created. Attention: this will remove the possibility to create a version before this ActiveFrom later on. If left empty, the new version will become active as of the moment of ingestion (recommended).", "nullable": true }, "identification": { "maxLength": 35, "minLength": 1, "type": "string", "description": "A unique id as it is identified by the client, in the client's system(s)." }, "type": { "maxLength": 35, "minLength": 1, "type": "string", "description": "Type of business partner. If a business partner fulfills multiple types, multiple businessPartner entries should be ingested. The combination of Identification and Type is unique." }, "name": { "maxLength": 70, "minLength": 1, "type": "string", "description": "The name of the business partner" }, "address": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.Address" }, "pointsOfContact": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "name": { "maxLength": 128, "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 64, "type": "string", "nullable": true }, "faxNumber": { "maxLength": 64, "type": "string", "nullable": true }, "emailAddress": { "maxLength": 128, "type": "string", "format": "email", "nullable": true }, "language": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "directions": { "type": "array", "items": { "type": "object", "xml": { "name": "direction" } }, "nullable": true, "xml": { "wrapped": true } }, "storageLocations": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.StorageLocations" } }, "xml": { "name": "pointsOfContac" } }, "nullable": true, "xml": { "wrapped": true } }, "referenceNumbers": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "code": { "maxLength": 35, "minLength": 1, "type": "string" }, "type": { "maxLength": 25, "minLength": 1, "type": "string" } }, "xml": { "name": "referenceNumber" } }, "nullable": true, "xml": { "wrapped": true } }, "storageLocations": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.StorageLocations" } }, "additionalProperties": false }, "Cas.Ingestions.Models.BusinessPartners.V1.BusinessPartnersIngestion": { "required": [ "businessPartners" ], "type": "object", "properties": { "version": { "maxLength": 5, "type": "string", "description": "1.0", "nullable": true }, "businessPartners": { "maxItems": 1000, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "activeFrom": { "type": "string", "description": "ActiveFrom of the version to be created. Attention: this will remove the possibility to create a version before this ActiveFrom later on. If left empty, the new version will become active as of the moment of ingestion (recommended).", "nullable": true }, "identification": { "maxLength": 35, "minLength": 1, "type": "string", "description": "A unique id as it is identified by the client, in the client's system(s)." }, "type": { "maxLength": 35, "minLength": 1, "type": "string", "description": "Type of business partner. If a business partner fulfills multiple types, multiple businessPartner entries should be ingested. The combination of Identification and Type is unique." }, "name": { "maxLength": 70, "minLength": 1, "type": "string", "description": "The name of the business partner" }, "address": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.Address" }, "pointsOfContact": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "name": { "maxLength": 128, "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 64, "type": "string", "nullable": true }, "faxNumber": { "maxLength": 64, "type": "string", "nullable": true }, "emailAddress": { "maxLength": 128, "type": "string", "format": "email", "nullable": true }, "language": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "directions": { "type": "array", "items": { "type": "object", "xml": { "name": "direction" } }, "nullable": true, "xml": { "wrapped": true } }, "storageLocations": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.StorageLocations" } }, "xml": { "name": "pointsOfContac" } }, "nullable": true, "xml": { "wrapped": true } }, "referenceNumbers": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "code": { "maxLength": 35, "minLength": 1, "type": "string" }, "type": { "maxLength": 25, "minLength": 1, "type": "string" } }, "xml": { "name": "referenceNumber" } }, "nullable": true, "xml": { "wrapped": true } }, "storageLocations": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.StorageLocations" } }, "xml": { "name": "businessPartner" } }, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.BusinessPartners.V1.Direction": { "enum": [ "IN", "OUT" ], "type": "string", "description": "

Possible values:

", "example": "IN" }, "Cas.Ingestions.Models.BusinessPartners.V1.PointOfContact": { "required": [ "storageLocations" ], "type": "object", "properties": { "name": { "maxLength": 128, "type": "string", "nullable": true }, "phoneNumber": { "maxLength": 64, "type": "string", "nullable": true }, "faxNumber": { "maxLength": 64, "type": "string", "nullable": true }, "emailAddress": { "maxLength": 128, "type": "string", "format": "email", "nullable": true }, "language": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "directions": { "type": "array", "items": { "type": "object", "xml": { "name": "direction" } }, "nullable": true, "xml": { "wrapped": true } }, "storageLocations": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.StorageLocations" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.BusinessPartners.V1.ReferenceNumber": { "required": [ "code", "type" ], "type": "object", "properties": { "code": { "maxLength": 35, "minLength": 1, "type": "string" }, "type": { "maxLength": 25, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "Cas.Ingestions.Models.BusinessPartners.V1.StorageLocationLevel": { "enum": [ "Enterprise", "Company", "Plant", "StorageLocation" ], "type": "string", "description": "

Possible values:

", "example": "Enterprise" }, "Cas.Ingestions.Models.BusinessPartners.V1.StorageLocations": { "required": [ "externalIds", "level" ], "type": "object", "properties": { "level": { "$ref": "#/components/schemas/Cas.Ingestions.Models.BusinessPartners.V1.StorageLocationLevel" }, "externalIds": { "type": "array", "items": { "minLength": 1, "type": "string", "xml": { "name": "externalId" } }, "description": "Unique references of organization structure elements for which the business partner is applicable. Required for levels Company, Plant & StorageLocation.", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Ingestions.Models.CertificateOfOrigin.V1.CasDeclaration": { "type": "object", "properties": { "functionRefNum": { "type": "string", "description": "Local reference number (LRN) of the CAS declaration for which to request a certificate of origin.", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateOfOrigin": { "type": "object", "properties": { "version": { "type": "string", "description": "1.0", "nullable": true }, "type": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateType" }, "casDeclaration": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CertificateOfOrigin.V1.CasDeclaration" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "description": "Number of the commercial invoice", "nullable": true }, "fileName": { "type": "string", "description": "Filename of the attachment, including a relevant extension.", "nullable": true }, "content": { "type": "string", "description": "The binary information of the attachment in base64 format.", "format": "byte", "nullable": true }, "contentType": { "type": "string", "description": "The mime type of the attachment (only application/pdf is allowed for now).", "nullable": true } }, "xml": { "name": "attachment" } }, "description": "Documents to be attached to the COO request (commercial invoice pdf)", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateOfOriginAttachment": { "type": "object", "properties": { "invoiceNumber": { "type": "string", "description": "Number of the commercial invoice", "nullable": true }, "fileName": { "type": "string", "description": "Filename of the attachment, including a relevant extension.", "nullable": true }, "content": { "type": "string", "description": "The binary information of the attachment in base64 format.", "format": "byte", "nullable": true }, "contentType": { "type": "string", "description": "The mime type of the attachment (only application/pdf is allowed for now).", "nullable": true } }, "additionalProperties": false, "description": "Document to be added to a certificate of origin (commercial invoice PDF)." }, "Cas.Ingestions.Models.CertificateOfOrigin.V1.CertificateType": { "enum": [ "Unknown", "COO", "EUR1" ], "type": "string", "description": "

Possible values:

", "example": "Unknown" }, "Cas.Ingestions.Models.CustomsShipment.V1.ActionOnSuccess": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SuccessActionType" }, "customsFlowStep": { "type": "string", "description": "The customs flow step to apply the action to", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.AdditionalReference": { "type": "object", "properties": { "id": { "maxLength": 70, "type": "string", "description": "`\r\n Reference number for any additional declarations made which is not covered by Supporting Document, transport document or additional information (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "maxLength": 4, "type": "string", "description": "Additional reference type code (format: an..4) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.Attachment": { "type": "object", "properties": { "type": { "type": "string", "description": "The type that determines the kind of file that is attached.", "nullable": true, "example": "invoice" }, "complementaryInformation": { "type": "string", "description": "The type that determine additional information that complements the attachment type.", "nullable": true, "example": "Commercial invoice for goods declaration" }, "contentType": { "type": "string", "description": "The media type of the provided content must be application/pdf.", "nullable": true, "example": "application/pdf" }, "fileName": { "type": "string", "description": "The original file name of the attachment, typically used for display purposes in declaration details.", "nullable": true, "example": "sample-invoice.pdf" }, "content": { "type": "string", "description": "The binary content of the attachment.", "format": "byte", "nullable": true, "example": "JVBERi0xLjQNCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iaiAyIDAgb2JqPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbMyAwIFJdPj5lbmRvYmogMyAwIG9iajw8L1R5cGUvUGFnZS9QYXJlbnQgMiAwIFIvTWVkaWFCb3hbMCAwIDYxMiA3OTJdL0NvbnRlbnRzIDQgMCBSPj5lbmRvYmogNCAwIG9iajw8L0xlbmd0aCA1NT4+c3RyZWFtDQpCVA0KL0YxIDE0IFRmDQo1MCA3NTAgVGQNCihDT01NRVJDSUFMIElOVk9JQ0UgLSBTQU1QTEUpVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KeHJlZg0KMCA1DQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMDkgMDAwMDAgbg0KMDAwMDAwMDA1OCAwMDAwMCBuDQowMDAwMDAwMTE1IDAwMDAwIG4NCjAwMDAwMDAyMTQgMDAwMDAgbg0KdHJhaWxlcjw8L1NpemUgNS9Sb290IDEgMCBSPj4NCnN0YXJ0eHJlZg0KMzE4DQolJUVPRg==" } }, "additionalProperties": false, "description": "Represents an attachment associated with a customs shipment, including metadata and binary content.", "example": { "type": "invoice", "contentType": "application/pdf", "fileName": "sample-invoice.pdf", "content": "JVBERi0xLjQNCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iaiAyIDAgb2JqPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbMyAwIFJdPj5lbmRvYmogMyAwIG9iajw8L1R5cGUvUGFnZS9QYXJlbnQgMiAwIFIvTWVkaWFCb3hbMCAwIDYxMiA3OTJdL0NvbnRlbnRzIDQgMCBSPj5lbmRvYmogNCAwIG9iajw8L0xlbmd0aCA1NT4+c3RyZWFtDQpCVA0KL0YxIDE0IFRmDQo1MCA3NTAgVGQNCihDT01NRVJDSUFMIElOVk9JQ0UgLSBTQU1QTEUpVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KeHJlZg0KMCA1DQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMDkgMDAwMDAgbg0KMDAwMDAwMDA1OCAwMDAwMCBuDQowMDAwMDAwMTE1IDAwMDAwIG4NCjAwMDAwMDAyMTQgMDAwMDAgbg0KdHJhaWxlcjw8L1NpemUgNS9Sb290IDEgMCBSPj4NCnN0YXJ0eHJlZg0KMzE4DQolJUVPRg==", "complementaryInformation": "Commercial invoice for shipment" } }, "Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner": { "type": "object", "properties": { "code": { "maxLength": 35, "type": "string", "description": "Gets or Sets Code", "nullable": true }, "name": { "maxLength": 70, "type": "string", "description": "Gets or Sets Name", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartnerAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartnerContact" }, "businessPartnerReferences": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN)", "nullable": true } }, "xml": { "name": "businessPartnerReference" } }, "description": "Gets or Sets BusinessPartnerReferences", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartnerAddress": { "type": "object", "properties": { "box": { "maxLength": 16, "type": "string", "description": "Gets or Sets Box", "nullable": true }, "city": { "maxLength": 35, "type": "string", "description": "Gets or Sets City", "nullable": true }, "country": { "maxLength": 2, "type": "string", "allOf": [ { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" } ], "description": "Gets or Sets Country", "nullable": true }, "number": { "maxLength": 16, "type": "string", "description": "Gets or Sets Number", "nullable": true }, "region": { "maxLength": 16, "type": "string", "description": "Country subdivision of region", "nullable": true }, "street": { "maxLength": 512, "type": "string", "description": "Gets or Sets Street", "nullable": true }, "zipCode": { "maxLength": 17, "type": "string", "description": "Gets or Sets ZipCode", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartnerBusinessPartnerReference": { "type": "object", "properties": { "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartnerContact": { "type": "object", "properties": { "emailAddress": { "maxLength": 64, "type": "string", "description": "Gets or Sets EmailAddress", "nullable": true }, "faxNumber": { "maxLength": 64, "type": "string", "description": "Gets or Sets FaxNumber", "nullable": true }, "phoneNumber": { "maxLength": 64, "type": "string", "description": "Gets or Sets PhoneNumber", "nullable": true }, "spocName": { "maxLength": 128, "type": "string", "description": "Gets or Sets SpocName", "nullable": true }, "language": { "maxLength": 2, "type": "string", "allOf": [ { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" } ], "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment": { "required": [ "direction", "externalReference", "singleAdministrativeDocument", "storageLocationReference" ], "type": "object", "properties": { "customsFlow": { "maxLength": 255, "type": "string", "description": "Code that determines the flow that needs to be executed", "nullable": true }, "direction": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment-DirectionEnum" }, "expectedDateTimeOfMovement": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "externalReference": { "maxLength": 100, "minLength": 1, "pattern": "\\A[^|]*\\z", "type": "string", "description": "Unique reference to identify the customs shipment" }, "messageType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment-MessageTypeEnum" }, "storageLocationReference": { "maxLength": 35, "minLength": 1, "type": "string", "description": "Storage location code (as known in CAS) from where an OUT customs shipment leaves or an IN customs shipment arrives" }, "version": { "maxLength": 16, "type": "string", "description": "1.0", "nullable": true }, "singleAdministrativeDocument": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SingleAdministrativeDocument" }, "sourceSysRef": { "type": "string", "nullable": true }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Gets or sets Metadata key", "nullable": true }, "value": { "type": "string", "description": "Gets or sets Metadata value", "nullable": true } }, "xml": { "name": "metadat" } }, "description": "Arbitrary custom attributes of a customs shipment, which leverage more sophisticated customs shipments or declarations lookup", "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsShipment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.ExciseGoodsShipment" }, "attachments": { "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type that determines the kind of file that is attached.", "nullable": true, "example": "invoice" }, "complementaryInformation": { "type": "string", "description": "The type that determine additional information that complements the attachment type.", "nullable": true, "example": "Commercial invoice for goods declaration" }, "contentType": { "type": "string", "description": "The media type of the provided content must be application/pdf.", "nullable": true, "example": "application/pdf" }, "fileName": { "type": "string", "description": "The original file name of the attachment, typically used for display purposes in declaration details.", "nullable": true, "example": "sample-invoice.pdf" }, "content": { "type": "string", "description": "The binary content of the attachment.", "format": "byte", "nullable": true, "example": "JVBERi0xLjQNCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iaiAyIDAgb2JqPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbMyAwIFJdPj5lbmRvYmogMyAwIG9iajw8L1R5cGUvUGFnZS9QYXJlbnQgMiAwIFIvTWVkaWFCb3hbMCAwIDYxMiA3OTJdL0NvbnRlbnRzIDQgMCBSPj5lbmRvYmogNCAwIG9iajw8L0xlbmd0aCA1NT4+c3RyZWFtDQpCVA0KL0YxIDE0IFRmDQo1MCA3NTAgVGQNCihDT01NRVJDSUFMIElOVk9JQ0UgLSBTQU1QTEUpVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KeHJlZg0KMCA1DQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMDkgMDAwMDAgbg0KMDAwMDAwMDA1OCAwMDAwMCBuDQowMDAwMDAwMTE1IDAwMDAwIG4NCjAwMDAwMDAyMTQgMDAwMDAgbg0KdHJhaWxlcjw8L1NpemUgNS9Sb290IDEgMCBSPj4NCnN0YXJ0eHJlZg0KMzE4DQolJUVPRg==" } }, "xml": { "name": "attachment" } }, "nullable": true, "xml": { "wrapped": true } }, "options": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Options" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment-DirectionEnum": { "enum": [ "IN", "OUT" ], "type": "string", "description": "Direction of the declaration:IN or OUT

Possible values:

", "example": "IN" }, "Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment-MessageTypeEnum": { "enum": [ "New", "Update", "Amend", "Invalidate", "Delete", "Replace", "Upsert" ], "type": "string", "description": "Code that determines the state of the message: New, Update etc. If no value is provided, CAS defaults it to New

Possible values:

", "example": "New" }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.ComplementConsigneeTrader": { "type": "object", "properties": { "memberStateCode": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "serialNumberOfCertificateOfExemption": { "maxLength": 255, "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.DocumentCertificate": { "type": "object", "properties": { "documentType": { "maxLength": 4, "type": "string", "nullable": true }, "documentReference": { "maxLength": 35, "type": "string", "nullable": true }, "documentDescription": { "maxLength": 350, "type": "string", "nullable": true }, "documentDescriptionLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "referenceOfDocument": { "maxLength": 350, "type": "string", "nullable": true }, "referenceOfDocumentLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "issuingAuthority": { "maxLength": 50, "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.EadEsad": { "type": "object", "properties": { "originTypeCode": { "type": "integer", "format": "int32", "nullable": true }, "dateTimeOfDispatch": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "importSads": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "importSadNumber": { "type": "string", "nullable": true } }, "xml": { "name": "importSad" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.ExciseGoodsItem": { "type": "object", "properties": { "quantity": { "minimum": 0, "type": "number", "format": "double", "nullable": true }, "uom": { "type": "string", "nullable": true }, "alcoholicStrengthByVolumeInPercentage": { "minimum": 0, "type": "number", "format": "double", "nullable": true }, "degreePlato": { "minimum": 0, "type": "number", "format": "double", "nullable": true }, "fiscalMark": { "maxLength": 350, "type": "string", "nullable": true }, "fiscalMarkLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "fiscalMarkUsedFlag": { "type": "integer", "format": "int32", "nullable": true }, "designationOfOrigin": { "maxLength": 350, "type": "string", "nullable": true }, "designationOfOriginLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "sizeOfProducer": { "type": "integer", "format": "int32", "nullable": true }, "density": { "minimum": 0, "type": "number", "format": "double", "nullable": true }, "commercialDescription": { "maxLength": 350, "type": "string", "nullable": true }, "commercialDescriptionLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "brandNameOfProducts": { "maxLength": 350, "type": "string", "nullable": true }, "brandNameOfProductsLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "maturationPeriodOrAgeOfProducts": { "maxLength": 350, "type": "string", "nullable": true }, "maturationPeriodOrAgeOfProductsLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "independentSmallProducersDeclaration": { "maxLength": 350, "type": "string", "nullable": true }, "independentSmallProducersDeclarationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "wineProduct": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.WineProduct" } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.ExciseGoodsShipment": { "type": "object", "properties": { "submissionMessageType": { "type": "integer", "format": "int32", "nullable": true }, "deferredSubmissionFlag": { "type": "integer", "format": "int32", "nullable": true }, "exciseMovement": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.ExciseMovement" }, "consigneeTrader": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "consignorTrader": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "placeOfDispatchTrader": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "dispatchImportOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "destinationOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "deliveryPlaceTrader": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "deliveryPlaceCustomsOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "competentAuthorityDispatchOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "transportArrangerTrader": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "firstTransporterTrader": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "complementConsigneeTrader": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.ComplementConsigneeTrader" }, "transportDetails": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "transportUnitCode": { "type": "integer", "format": "int32", "nullable": true }, "identityOfTransportUnits": { "maxLength": 35, "type": "string", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "complementaryInformation": { "maxLength": 350, "type": "string", "nullable": true }, "complementaryInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true } }, "xml": { "name": "transportDetail" } }, "nullable": true, "xml": { "wrapped": true } }, "documentCertificates": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "documentType": { "maxLength": 4, "type": "string", "nullable": true }, "documentReference": { "maxLength": 35, "type": "string", "nullable": true }, "documentDescription": { "maxLength": 350, "type": "string", "nullable": true }, "documentDescriptionLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "referenceOfDocument": { "maxLength": 350, "type": "string", "nullable": true }, "referenceOfDocumentLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "issuingAuthority": { "maxLength": 50, "type": "string", "nullable": true } }, "xml": { "name": "documentCertificate" } }, "nullable": true, "xml": { "wrapped": true } }, "headerEadEsad": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.HeaderEadEsad" }, "transportMode": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.TransportMode" }, "movementGuarantee": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.MovementGuarantee" }, "EadEsad": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.EadEsad" } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.ExciseMovement": { "type": "object", "properties": { "administrativeReferenceCode": { "maxLength": 21, "type": "string", "nullable": true }, "consignorFunctionRefNum": { "type": "string", "nullable": true }, "dateAndTimeOfValidationOfEadEsad": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.HeaderEadEsad": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "destinationTypeCode": { "type": "integer", "format": "int32", "nullable": true }, "journeyTime": { "maxLength": 3, "type": "string", "nullable": true }, "transportArrangement": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.ImportSad": { "type": "object", "properties": { "importSadNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.MovementGuarantee": { "type": "object", "properties": { "guarantorTypeCode": { "type": "integer", "format": "int32", "nullable": true }, "guarantorTraders": { "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "code": { "maxLength": 35, "type": "string", "description": "Gets or Sets Code", "nullable": true }, "name": { "maxLength": 70, "type": "string", "description": "Gets or Sets Name", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartnerAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartnerContact" }, "businessPartnerReferences": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN)", "nullable": true } }, "xml": { "name": "businessPartnerReference" } }, "description": "Gets or Sets BusinessPartnerReferences", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "guarantorTrader" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.TransportDetails": { "type": "object", "properties": { "transportUnitCode": { "type": "integer", "format": "int32", "nullable": true }, "identityOfTransportUnits": { "maxLength": 35, "type": "string", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "complementaryInformation": { "maxLength": 350, "type": "string", "nullable": true }, "complementaryInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.TransportMode": { "type": "object", "properties": { "transportModeCode": { "type": "integer", "format": "int32", "nullable": true }, "complementaryInformation": { "maxLength": 350, "type": "string", "nullable": true }, "complementaryInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.WineOperation": { "type": "object", "properties": { "wineOperationCode": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Excise.WineProduct": { "type": "object", "properties": { "wineProductCategory": { "type": "integer", "format": "int32", "nullable": true }, "wineGrowingZoneCode": { "type": "integer", "format": "int32", "nullable": true }, "thirdCountryOfOrigin": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "otherInformation": { "maxLength": 350, "type": "string", "nullable": true }, "otherInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "wineOperations": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "wineOperationCode": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "wineOperation" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Metadata": { "type": "object", "properties": { "key": { "type": "string", "description": "Gets or sets Metadata key", "nullable": true }, "value": { "type": "string", "description": "Gets or sets Metadata value", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.Options": { "type": "object", "properties": { "reason": { "maxLength": 255, "type": "string", "description": "The reason for the change. Can be used in customs messages where reason is required.", "nullable": true }, "actionsOnSuccess": { "type": "array", "items": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SuccessActionType" }, "customsFlowStep": { "type": "string", "description": "The customs flow step to apply the action to", "nullable": true } }, "xml": { "name": "actionsOnSucces" } }, "description": "The actions to perform on success", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalDocument": { "type": "object", "properties": { "category": { "maxLength": 1, "type": "string", "description": "Additional document category", "nullable": true }, "issueDate": { "type": "string", "description": "The effective date of the document (e.g. license, visa, permit, certificate)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Identifier of a document providing additional information", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalDocumentSubmitter" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalDocumentSubmitter": { "type": "object", "properties": { "name": { "maxLength": 70, "type": "string", "description": "Gets or Sets Name", "nullable": true }, "roleCode": { "maxLength": 3, "type": "string", "description": "Gets or Sets RoleCode", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalInformation": { "type": "object", "properties": { "code": { "type": "string", "description": "Coded form of an additional statement", "nullable": true }, "text": { "type": "string", "description": "Description of an additional statement", "nullable": true }, "type": { "type": "string", "description": "Additional statement type", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalParty": { "type": "object", "properties": { "partyType": { "type": "string", "description": "Gets or Sets PartyType", "nullable": true }, "party": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalPartyParty" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalPartyParty": { "type": "object", "properties": { "code": { "type": "string", "description": "Gets or Sets Code", "nullable": true }, "name": { "type": "string", "description": "Gets or Sets Name", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalPartyPartyAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalPartyPartyContact" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalPartyPartyAddress": { "type": "object", "properties": { "box": { "type": "string", "description": "Gets or Sets Box", "nullable": true }, "city": { "type": "string", "description": "Gets or Sets City", "nullable": true }, "country": { "type": "string", "description": "Gets or Sets Country", "nullable": true }, "number": { "type": "string", "description": "Gets or Sets Number", "nullable": true }, "region": { "type": "string", "description": "Country subdivision of region", "nullable": true }, "street": { "type": "string", "description": "Gets or Sets Street", "nullable": true }, "zipCode": { "maxLength": 17, "type": "string", "description": "Gets or Sets ZipCode", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalPartyPartyContact": { "type": "object", "properties": { "phoneNumber": { "type": "string", "description": "Gets or Sets PhoneNumber", "nullable": true }, "spocName": { "type": "string", "description": "Gets or Sets SpocName", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADAuthorizationHolder": { "type": "object", "properties": { "authorizationId": { "maxLength": 17, "type": "string", "description": "Gets or Sets Authorization Id", "nullable": true }, "categoryCode": { "maxLength": 4, "type": "string", "description": "Gets or Sets Category Code", "nullable": true }, "authorizationReference": { "maxLength": 64, "type": "string", "description": "Gets or Sets Authorization Reference", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SADCalculationReturn": { "type": "object", "properties": { "basisQty": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base quantity", "format": "double", "nullable": true }, "basisValue": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base amount", "format": "double", "nullable": true }, "dutyRegime": { "maxLength": 3, "type": "string", "description": "Duty regime", "nullable": true }, "quotaId": { "maxLength": 17, "type": "string", "description": "Quota order number", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax rate", "format": "double", "nullable": true }, "reducedAssessed": { "minimum": 0, "type": "number", "description": "Amount of deduction from a duty or tax - assessed", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Calculation of taxes - Tax type", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADCalculationReturnPayment" } }, "additionalProperties": false, "description": "Retro-active option: to provide total duty tax fees, to validate recalculated totals are the same (within a certain fault tolarance) Return message: Totals per type of returned duty tax fees as they where calculated by customs" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADCalculationReturnPayment": { "type": "object", "properties": { "amount": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Payable tax amount", "format": "double", "nullable": true }, "assessed": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Payable tax amount", "format": "double", "nullable": true }, "methodCode": { "maxLength": 1, "type": "string", "allOf": [ { "pattern": "^[A-Za-z]*$" }, { "pattern": "^[A-Za-z]*$" } ], "description": "Calculation Of Taxes – Method Of Payment (A, B, C, D, E, G, H, J, K, O, P, R, S, T, U, V)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADCurrencyExchange": { "type": "object", "properties": { "currency": { "maxLength": 3, "type": "string", "description": "Internal Currency Unit (ISO 4217 3-alpha code)", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Exchange rate", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADDutyTaxFee": { "type": "object", "properties": { "basisQty": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax base quantity", "format": "double", "nullable": true }, "basisValue": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax base amount", "format": "double", "nullable": true }, "dutyRegime": { "maxLength": 3, "type": "string", "description": "Code specifying a type of duty regime", "nullable": true }, "quotaId": { "maxLength": 17, "type": "string", "description": "Quota order number", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax rate", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Calculation of taxes - Tax type", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADDutyTaxFeePayment" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADDutyTaxFeePayment": { "type": "object", "properties": { "amount": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Payable tax amount", "format": "double", "nullable": true }, "assessed": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Total assessed", "format": "double", "nullable": true }, "methodCode": { "maxLength": 1, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Calculation of taxes - Method of Payment (A, B, C, D, E, G, H, J, K, O, P, R, S, T, U, V)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignment": { "required": [ "transitOfficeCodes" ], "type": "object", "properties": { "container": { "maximum": 10, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Container (0,1)", "format": "int32", "nullable": true }, "transitOfficeCodes": { "maxItems": 99, "type": "array", "items": { "maxLength": 17, "minLength": 1, "type": "string", "xml": { "name": "transitOfficeCode" } }, "nullable": true, "xml": { "wrapped": true } }, "arrivalTransportMeans": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentArrivalTransportMeans" }, "borderTransportMeans": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentBorderTransportMeans" }, "carrier": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "departureTransportMeans": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentDepartureTransportMeans" }, "goodsLocation": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentGoodsLocation" }, "itineraries": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "routeId": { "maxLength": 64, "type": "string", "nullable": true }, "routeIdType": { "maxLength": 64, "type": "string", "nullable": true } }, "xml": { "name": "itinerary" } }, "nullable": true, "xml": { "wrapped": true } }, "transportEquipments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "identification": { "maxLength": 17, "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Type of transport equipment (format: a2)", "nullable": true }, "sealQuantity": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of seals", "format": "int32", "nullable": true }, "seals": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "description": "Seal identifier", "nullable": true } }, "xml": { "name": "seal" } }, "nullable": true, "xml": { "wrapped": true } }, "goodsReferences": { "maxItems": 999, "type": "array", "items": { "type": "string", "xml": { "name": "goodsReference" } }, "description": "References to the consignment's government agency goods items that are loaded in this transport equipment.\r\nUse the seqNum of the goods item as the reference value.", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "transportEquipment" } }, "nullable": true, "xml": { "wrapped": true } }, "transportContractDocuments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "id": { "maxLength": 70, "type": "string", "description": "Transport contract document id", "nullable": true }, "typeCode": { "maxLength": 4, "type": "string", "description": "Transport contract document type code", "nullable": true } }, "xml": { "name": "transportContractDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "transportAndInsuranceCostsToTheDestination": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentTransportAndInsuranceCostsToTheDestination" }, "loadingLocation": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentLoadingLocation" }, "unloadingLocation": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentUnloadingLocation" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentArrivalTransportMeans": { "type": "object", "properties": { "identification": { "maxLength": 35, "type": "string", "description": "Gets or Sets Identification", "nullable": true }, "identificationType": { "maxLength": 4, "type": "string", "description": "Gets or Sets IdentificationType", "nullable": true }, "mode": { "maxLength": 4, "type": "string", "description": "Gets or Sets Mode", "nullable": true }, "journeyId": { "maxLength": 35, "type": "string", "description": "Gets or Sets JourneyId", "nullable": true }, "name": { "maxLength": 70, "type": "string", "description": "Gets or Sets Name", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentBorderTransportMeans": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Nationality Of Active Means Of Transport Crossing The Border (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "bookingReference": { "maxLength": 64, "type": "string", "description": "Used in the context of some port community systems (PCS). The vehicle booking reference (format: an..64) (cardinality: 1x)", "nullable": true }, "departureLocation": { "maxLength": 17, "type": "string", "description": "Used in the context of some port community systems (PCS). Represent the terminal where the vehicle arrives. (format: an..17) (cardinality: 1x)", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "description": "Identification of actual means of transport crossing the border (format: an..35) (cardinality: 1x)", "nullable": true }, "identificationType": { "maxLength": 4, "type": "string", "description": "Type of actual means of transport crossing the border (format: an..4) (cardinality: 1x)", "nullable": true }, "mode": { "maxLength": 4, "type": "string", "description": "Mode Of Transport At The Border (1, 2, 3, 4, 5, 6, 7, 8, 9, 10) (format: an..4) (cardinality: 1x)", "nullable": true }, "isAccompanied": { "type": "boolean", "description": "A flag indicating whether or not the goods are accompanied. Needed for mapping to customs (especially PCS): Which vehicle number to declare: Truck or trailer (format: bool) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentDepartureTransportMeans": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Gets or Sets Country", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "description": "Gets or Sets Identification", "nullable": true }, "identificationType": { "maxLength": 4, "type": "string", "description": "Gets or Sets IdentificationType", "nullable": true }, "mode": { "maxLength": 4, "type": "string", "description": "Gets or Sets Mode", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentGoodsLocation": { "type": "object", "properties": { "name": { "maxLength": 35, "type": "string", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "nullable": true }, "type": { "maxLength": 1, "type": "string", "nullable": true }, "identificationType": { "maxLength": 1, "type": "string", "description": "Code/Identifier for the identification of the goods location", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentGoodsLocationAddress" }, "additionalIdentifier": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentGoodsLocationAddress": { "type": "object", "properties": { "box": { "maxLength": 16, "type": "string", "description": "Gets or Sets Box", "nullable": true }, "city": { "maxLength": 35, "type": "string", "description": "Gets or Sets City", "nullable": true }, "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Gets or Sets Country", "nullable": true }, "number": { "maxLength": 16, "type": "string", "description": "Gets or Sets Number", "nullable": true }, "region": { "maxLength": 16, "type": "string", "description": "Country subdivision of region", "nullable": true }, "street": { "maxLength": 70, "type": "string", "description": "Gets or Sets Street", "nullable": true }, "zipCode": { "maxLength": 17, "type": "string", "description": "Gets or Sets ZipCode", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentItinerary": { "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "routeId": { "maxLength": 64, "type": "string", "nullable": true }, "routeIdType": { "maxLength": 64, "type": "string", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentLoadingLocation": { "type": "object", "properties": { "placeCode": { "maxLength": 17, "type": "string", "description": "Place code (format: an..17) (cardinality: 1x)", "nullable": true }, "place": { "maxLength": 35, "type": "string", "description": "Place (format: an..35) (cardinality: 1x)", "nullable": true }, "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Country (format: a2) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentTransportAndInsuranceCostsToTheDestination": { "type": "object", "properties": { "amount": { "minimum": 0, "type": "number", "description": "The amount of postal charges paid", "format": "double", "nullable": true }, "currency": { "maxLength": 3, "type": "string", "description": "Currency (ISO 4217 3-alpha code)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentTransportContractDocument": { "type": "object", "properties": { "id": { "maxLength": 70, "type": "string", "description": "Transport contract document id", "nullable": true }, "typeCode": { "maxLength": 4, "type": "string", "description": "Transport contract document type code", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentTransportEquipment": { "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "identification": { "maxLength": 17, "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Type of transport equipment (format: a2)", "nullable": true }, "sealQuantity": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of seals", "format": "int32", "nullable": true }, "seals": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "description": "Seal identifier", "nullable": true } }, "xml": { "name": "seal" } }, "nullable": true, "xml": { "wrapped": true } }, "goodsReferences": { "maxItems": 999, "type": "array", "items": { "type": "string", "xml": { "name": "goodsReference" } }, "description": "References to the consignment's government agency goods items that are loaded in this transport equipment.\r\nUse the seqNum of the goods item as the reference value.", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentTransportEquipmentSeal": { "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "description": "Seal identifier", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignmentUnloadingLocation": { "type": "object", "properties": { "dateArrival": { "type": "string", "description": "Date of arrival at the unloading location.", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "placeCode": { "maxLength": 17, "type": "string", "description": "Place code (format: an..17) (cardinality: 1x)", "nullable": true }, "place": { "maxLength": 35, "type": "string", "description": "Place (format: an..35) (cardinality: 1x)", "nullable": true }, "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Country (format: a2) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSCustomsValuation": { "type": "object", "properties": { "chargeDeductions": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "currencyExchange": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSCustomsValuationChargeDeductionCurrencyExchange" }, "otherChargeDeductionAmount": { "minimum": 0, "type": "number", "description": "Gets or Sets OtherChargeDeductionAmount", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Gets or Sets Type", "nullable": true } }, "xml": { "name": "chargeDeduction" } }, "description": "Gets or Sets ChargeDeductions", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSCustomsValuationChargeDeduction": { "type": "object", "properties": { "currencyExchange": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSCustomsValuationChargeDeductionCurrencyExchange" }, "otherChargeDeductionAmount": { "minimum": 0, "type": "number", "description": "Gets or Sets OtherChargeDeductionAmount", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Gets or Sets Type", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSCustomsValuationChargeDeductionCurrencyExchange": { "type": "object", "properties": { "currency": { "maxLength": 3, "type": "string", "description": "Gets or Sets Currency", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Gets or Sets Rate", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSDestination": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "This data element can only be given once, either on header level or on item level.", "nullable": true }, "region": { "maxLength": 16, "type": "string", "description": "This data element can only be given once, either on header level or on item level.", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSDomesticDutyTaxParty": { "type": "object", "properties": { "identification": { "maxLength": 17, "type": "string", "description": "To identify a party responsible for the national VAT or Goods & Services Tax", "nullable": true }, "roleCode": { "maxLength": 3, "type": "string", "description": "VAT-related fiscal references: FR1 (importer), FR2 (customer), FR3 (tax representative), FR4 (holder of the deferred payment authorisation)", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSDomesticDutyTaxPartyAddress" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSDomesticDutyTaxPartyAddress": { "type": "object", "properties": { "box": { "type": "string", "description": "Gets or Sets Box", "nullable": true }, "city": { "type": "string", "description": "Gets or Sets City", "nullable": true }, "country": { "type": "string", "description": "Gets or Sets Country", "nullable": true }, "number": { "type": "string", "description": "Gets or Sets Number", "nullable": true }, "region": { "type": "string", "description": "Country subdivision of region", "nullable": true }, "street": { "type": "string", "description": "Gets or Sets Street", "nullable": true }, "zipCode": { "maxLength": 17, "type": "string", "description": "Gets or Sets ZipCode", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSElo": { "type": "object", "properties": { "lorryType": { "type": "string", "description": "Lorry type (possible values: PLEIN, VIDE)", "nullable": true }, "fisheryGoods": { "type": "boolean", "description": "Fishery goods", "nullable": true }, "tirAtaFormalities": { "type": "boolean", "description": "TIR/ATA formalities", "nullable": true }, "sanitaryGoods": { "type": "boolean", "description": "Sanitary goods", "nullable": true }, "postalGoods": { "type": "boolean", "description": "Postal goods", "nullable": true }, "emptyPackaging": { "type": "boolean", "description": "Empty packaging", "nullable": true }, "transportContracts": { "type": "boolean", "description": "Transport contracts", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGAGIUcr": { "type": "object", "properties": { "traderReference": { "maxLength": 35, "type": "string", "description": "This data element can only be given once, either on header level or on item level.", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocument": { "type": "object", "properties": { "category": { "maxLength": 1, "type": "string", "description": "Additional document category", "nullable": true }, "issueDate": { "type": "string", "description": "The effective date of the document (e.g. license, visa, permit, certificate)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Additional document status code", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocumentSubmitter" }, "name": { "maxLength": 35, "type": "string", "description": "Free text description for additional document - additional document name", "nullable": true }, "writeOff": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocumentWriteOff" }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocumentSubmitter": { "type": "object", "properties": { "name": { "maxLength": 70, "type": "string", "description": "Gets or Sets Name", "nullable": true }, "roleCode": { "maxLength": 3, "type": "string", "description": "Gets or Sets RoleCode", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocumentWriteOff": { "type": "object", "properties": { "quantity": { "minimum": 0, "type": "number", "description": "Gets or Sets Quantity", "format": "double", "nullable": true }, "unit": { "maxLength": 5, "type": "string", "description": "Gets or Sets Unit", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalInformation": { "type": "object", "properties": { "code": { "type": "string", "description": "Coded form of an additional statement", "nullable": true }, "text": { "type": "string", "description": "Description of an additional statement", "nullable": true }, "type": { "type": "string", "description": "Additional statement type", "nullable": true, "example": "type" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiBlendResult": { "type": "object", "properties": { "itemId": { "maxLength": 256, "type": "string", "description": "Reference to the master data item representing the result of the blend", "nullable": true }, "productReference": { "maxLength": 256, "type": "string", "description": "Typically the batch number or unique identifier for the blended product", "nullable": true }, "classifications": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "type": { "maxLength": 32, "type": "string", "description": "Main types to be used:\r\n- CN: Combined nomenclature, 8 digits\r\n- TARIC: Taric code, 10 digits\r\n- UKGTExport: Combined nomenclature, 8 digits, used for GB\r\n- UKGTImEx: Taric code, 10 digits; used for GB\r\n- ExciseProductCode; excise product code e.g., E430", "nullable": true }, "code": { "maxLength": 10, "type": "string", "description": "The classification code", "nullable": true } }, "xml": { "name": "classification" } }, "description": "Used to provide the excise product code for the blended result (e.g., E430) and/or the tariff classification", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Represents the outcome of blending goods within a customs or tax warehouse, typically for energy excise products (e.g., fuel) combined in a storage tank. This class captures key identifiers and measurement details of the resulting blended product." }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiBlendResultClassification": { "type": "object", "properties": { "type": { "maxLength": 32, "type": "string", "description": "Main types to be used:\r\n- CN: Combined nomenclature, 8 digits\r\n- TARIC: Taric code, 10 digits\r\n- UKGTExport: Combined nomenclature, 8 digits, used for GB\r\n- UKGTImEx: Taric code, 10 digits; used for GB\r\n- ExciseProductCode; excise product code e.g., E430", "nullable": true }, "code": { "maxLength": 10, "type": "string", "description": "The classification code", "nullable": true } }, "additionalProperties": false, "description": "Used to provide the excise product code for the blended result (e.g., E430) and/or the tariff classification" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodity": { "type": "object", "properties": { "description": { "maxLength": 512, "type": "string", "description": "Description of goods", "nullable": true }, "isBonded": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is bonded. Only applicable for special procedures.", "nullable": true }, "isTemporaryAdmission": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is Temporary Admission. Only applicable for special procedures.", "nullable": true }, "itemId": { "maxLength": 256, "type": "string", "description": "External reference of the item (as known in CAS in article master data)", "nullable": true }, "storageLocationReference": { "maxLength": 35, "type": "string", "description": "Storage location code (as known in CAS) from where an line item leaves or arrives (or where it is produced). Only applicable for special procedures.", "nullable": true }, "classifications": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "code": { "maxLength": 10, "type": "string", "description": "Classification code", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Classification type (e.g. TARIC, UKGTImEx, MEURS, ...)", "nullable": true } }, "xml": { "name": "classification" } }, "nullable": true, "xml": { "wrapped": true } }, "dutyTaxFees": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "basisQty": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base quantity", "format": "double", "nullable": true }, "basisValue": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base amount", "format": "double", "nullable": true }, "dutyRegime": { "maxLength": 3, "type": "string", "nullable": true }, "quotaId": { "maxLength": 17, "type": "string", "description": "Quota order number", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax rate", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Calculation of taxes – Tax type", "nullable": true }, "nationalType": { "type": "string", "description": "Calculation of taxes – National tax type", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodityDutyTaxFeePayment" }, "unitQualifier": { "maxLength": 6, "type": "string", "nullable": true }, "unitType": { "maxLength": 6, "type": "string", "nullable": true }, "rateId": { "type": "string", "description": "The rate id for the VAT taxes applicable.", "nullable": true } }, "xml": { "name": "dutyTaxFee" } }, "nullable": true, "xml": { "wrapped": true } }, "invoiceLine": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodityInvoiceLine" }, "calculationReturns": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "basisQty": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base quantity", "format": "double", "nullable": true }, "basisValue": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base amount", "format": "double", "nullable": true }, "dutyRegime": { "maxLength": 3, "type": "string", "description": "Duty regime", "nullable": true }, "quotaId": { "maxLength": 17, "type": "string", "description": "Quota order number", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax rate", "format": "double", "nullable": true }, "reducedAssessed": { "minimum": 0, "type": "number", "description": "Amount of deduction from a duty or tax - assessed", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Calculation of taxes - Tax type", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADCalculationReturnPayment" } }, "xml": { "name": "calculationReturn" } }, "nullable": true, "xml": { "wrapped": true } }, "transportEquipments": { "maxItems": 9999, "type": "array", "items": { "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 1, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "identification": { "maxLength": 17, "minLength": 1, "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container" } }, "xml": { "name": "transportEquipment" } }, "nullable": true, "xml": { "wrapped": true } }, "isExcise": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is excise. Only applicable for special procedures", "nullable": true }, "isProductExcise": { "type": "boolean", "description": "Identifier that determines whether the product linked to the line item (Gagi) is excise. Only applicable for special procedures.", "nullable": true }, "isEndUse": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is end use. Only applicable for special procedures.", "nullable": true }, "containsOutwardProcessing": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is outward processing. Only applicable for special procedures.", "nullable": true }, "receivingStorageLocationReference": { "maxLength": 35, "type": "string", "description": "To be provided when the customs shipment will be used to transfer the goods within the same or different SP authorisation, where a declaration is needed. For example when ownership and valuation changes", "nullable": true }, "receivingAuthorizationId": { "maxLength": 255, "type": "string", "description": "To be provided when the customs shipment will be used to transfer the goods within the same or different SP authorisation, where a declaration is needed. For example when ownership and valuation changes", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodityClassification": { "type": "object", "properties": { "code": { "maxLength": 10, "type": "string", "description": "Classification code", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Classification type (e.g. TARIC, UKGTImEx, MEURS, ...)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodityDutyTaxFee": { "type": "object", "properties": { "basisQty": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base quantity", "format": "double", "nullable": true }, "basisValue": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base amount", "format": "double", "nullable": true }, "dutyRegime": { "maxLength": 3, "type": "string", "nullable": true }, "quotaId": { "maxLength": 17, "type": "string", "description": "Quota order number", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax rate", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Calculation of taxes – Tax type", "nullable": true }, "nationalType": { "type": "string", "description": "Calculation of taxes – National tax type", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodityDutyTaxFeePayment" }, "unitQualifier": { "maxLength": 6, "type": "string", "nullable": true }, "unitType": { "maxLength": 6, "type": "string", "nullable": true }, "rateId": { "type": "string", "description": "The rate id for the VAT taxes applicable.", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodityDutyTaxFeePayment": { "type": "object", "properties": { "amount": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Payable tax amount", "format": "double", "nullable": true }, "assessed": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Payable tax amount", "format": "double", "nullable": true }, "methodCode": { "maxLength": 1, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Calculation Of Taxes – Method Of Payment (A, B, C, D, E, G, H, J, K, O, P, R, S, T, U, V)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodityInvoiceLine": { "type": "object", "properties": { "itemAmount": { "minimum": 0, "type": "number", "description": "Item price/amount", "format": "double", "nullable": true }, "unitPrice": { "minimum": 0, "type": "number", "description": "Unit price of the goods, specified in the invoice currency", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodityTransportEquipment": { "required": [ "identification" ], "type": "object", "properties": { "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 1, "type": "integer", "description": "Sequence number", "format": "int32", "nullable": true }, "identification": { "maxLength": 17, "minLength": 1, "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCustomsValuation": { "type": "object", "properties": { "valuationMethod": { "maxLength": 3, "type": "string", "description": "Valuation Method (1, 2, 3, 4, 5, 6)", "nullable": true }, "chargeDeductions": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "otherChargeDeductionAmount": { "minimum": 0, "type": "number", "description": "Gets or Sets OtherChargeDeductionAmount", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Gets or Sets Type", "nullable": true }, "otherPercentage": { "minimum": 0, "type": "number", "description": "Gets or Sets OtherPercentage", "format": "double", "nullable": true }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCustomsValuationChargeDeductionCurrencyExchange" } }, "xml": { "name": "chargeDeduction" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCustomsValuationChargeDeduction": { "type": "object", "properties": { "otherChargeDeductionAmount": { "minimum": 0, "type": "number", "description": "Gets or Sets OtherChargeDeductionAmount", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Gets or Sets Type", "nullable": true }, "otherPercentage": { "minimum": 0, "type": "number", "description": "Gets or Sets OtherPercentage", "format": "double", "nullable": true }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCustomsValuationChargeDeductionCurrencyExchange" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCustomsValuationChargeDeductionCurrencyExchange": { "type": "object", "properties": { "currency": { "maxLength": 3, "type": "string", "description": "Gets or Sets Currency", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Gets or Sets Rate", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiDestination": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "This data element can only be given once, either on header level or on item level.", "nullable": true }, "region": { "maxLength": 16, "type": "string", "description": "This data element can only be given once, either on header level or on item level.", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiGoodsMeasure": { "type": "object", "properties": { "gmass": { "minimum": 0, "type": "number", "description": "Gross mass (kg)", "format": "double", "nullable": true }, "nmass": { "minimum": 0, "type": "number", "description": "Net mass (kg)", "format": "double", "nullable": true }, "qty": { "minimum": 0, "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records)", "format": "double", "nullable": true }, "supQty": { "minimum": 0, "type": "number", "description": "Supplementary units", "format": "double", "nullable": true }, "supQtyUom": { "maxLength": 5, "type": "string", "description": "Unit of measure for supplementary units (SupQty).", "nullable": true }, "uom": { "maxLength": 5, "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records)", "nullable": true }, "quantities": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "minimum": 0, "type": "number", "description": "An additional quantity", "format": "double", "nullable": true }, "uom": { "maxLength": 5, "type": "string", "description": "The UoM of the additional quantity", "nullable": true } }, "xml": { "name": "quantity" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiGoodsMeasureQuantity": { "type": "object", "properties": { "quantity": { "minimum": 0, "type": "number", "description": "An additional quantity", "format": "double", "nullable": true }, "uom": { "maxLength": 5, "type": "string", "description": "The UoM of the additional quantity", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiGovernmentProcedure": { "type": "object", "properties": { "proc": { "maxLength": 7, "type": "string", "description": "Code specifying a procedure", "nullable": true }, "prevProc": { "maxLength": 7, "type": "string", "description": "Code specifying the previous procedure", "nullable": true }, "declProcType": { "maxLength": 1, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Declaration procedure code (A,B,C,D,E,F,G,H,I,J,K) that defines the Government Agency data setNote: only needed for BE", "nullable": true }, "procEU": { "maxLength": 7, "type": "string", "description": "Additional EU government procedure code as defined by Council Regulation (EC) No 1186/2009", "nullable": true }, "procNat1": { "maxLength": 7, "type": "string", "description": "Additional national government procedure code", "nullable": true }, "procNat2": { "maxLength": 7, "type": "string", "description": "Additional national government procedure code", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiInnerPackaging": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of inner packages", "format": "int32", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of inner package of an item", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiMaterial": { "type": "object", "properties": { "equivalent": { "type": "boolean", "description": "Gets or Sets Equivalent", "nullable": true }, "isBonded": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is bonded. Only applicable for special procedures.", "nullable": true }, "itemId": { "maxLength": 256, "type": "string", "description": "ItemId of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data)", "nullable": true }, "itemGroup": { "maxLength": 256, "type": "string", "description": "ItemGroup of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data)", "nullable": true }, "origin": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "County of origin", "nullable": true }, "qty": { "minimum": 0, "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records)", "format": "double", "nullable": true }, "storageLocationReference": { "maxLength": 35, "type": "string", "description": "Storage location code (as known in CAS) from where an the materials which were used in processing. Only applicable for special procedures.", "nullable": true }, "uom": { "maxLength": 6, "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the (semi-)produced product", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiOrigin": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Country of origin (ISO 3166-1 2-alpha code)", "nullable": true }, "region": { "maxLength": 5, "type": "string", "description": "Country subdivision of region", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Origin type (PreferentialOrigin, NonPreferentialOrigin)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiPackaging": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiPreviousDocument": { "type": "object", "properties": { "art": { "maxLength": 70, "type": "string", "nullable": true }, "billOfLoading": { "maxLength": 70, "type": "string", "nullable": true }, "category": { "maxLength": 2, "type": "string", "nullable": true }, "date": { "type": "string", "description": "Date of the previous document in accordance with national legislation", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "item": { "maxLength": 70, "type": "string", "nullable": true }, "lineNumber": { "maximum": 10000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Item number pertaining to the previous Customs filing", "format": "int32", "nullable": true }, "loc": { "maxLength": 35, "type": "string", "nullable": true }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Type of document used for declaration previously presented", "nullable": true }, "typeOfPackages": { "maxLength": 2, "type": "string", "description": "Type of packages", "nullable": true }, "numberOfPackages": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of packages", "format": "int32", "nullable": true }, "measurementUnitAndQualifier": { "maxLength": 4, "type": "string", "description": "Measurement unit and qualifier", "nullable": true }, "quantity": { "minimum": 0, "type": "number", "description": "Quantity of packages", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiTradeTerms": { "type": "object", "properties": { "placeCode": { "maxLength": 17, "type": "string", "nullable": true }, "place": { "maxLength": 512, "type": "string", "description": "Name of the point or port of departure, shipment or destination, as required under the applicable terms of delivery, e.g. Incoterm", "nullable": true }, "termsCode": { "maxLength": 3, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Delivery Terms (DAF, EXW, FCA, CPT, CIP, DAT, DAP, DDP, DDU, FAS, FOB, CFR, CIF, DES, DEQ, XXX)", "nullable": true }, "countryRelationshipCode": { "type": "integer", "description": "Indication whether the place specified for the performance of a (contractual) obligation is located in the country where the declaration is made, in another member country of the same economic or Customs union, or in a third country", "format": "int32", "nullable": true }, "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiValuationAdjustment": { "type": "object", "properties": { "amount": { "minimum": 0, "type": "number", "description": "Monetary amount by which the valuation was adjusted", "format": "double", "nullable": true }, "qualifier": { "maxLength": 4, "type": "string", "description": "This data element is required when using valuation method 1 (transaction of the imported goods), otherwise it should be left blank.", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGovernmentAgencyGoodsItem": { "type": "object", "properties": { "addDeclType2": { "maxLength": 6, "type": "string", "description": "Transit declaration/Proof of customs status type", "nullable": true }, "containerIdentification": { "maxLength": 17, "type": "string", "description": "DEPRECATED - Use the goodsReferences field on the goods shipment level transportEquipment instead, providing the seqNum of the goods item.", "nullable": true, "deprecated": true }, "customsValue": { "minimum": 0, "type": "number", "format": "double", "nullable": true }, "productReference": { "maxLength": 256, "type": "string", "description": "Unique identifier for a specific product or batch (e.g. serial number, VIN, batch number)", "nullable": true }, "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Goods item (sequence) number", "format": "int32", "nullable": true }, "statValue": { "minimum": 0, "type": "number", "description": "Statistical value", "format": "double", "nullable": true }, "trxNatCode": { "maximum": 100, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "This data element can only be given once, either on header level or on item level.", "format": "int32", "nullable": true }, "heatId": { "maxLength": 15, "type": "string", "description": "Heat ID", "nullable": true }, "supplierHeatId": { "maxLength": 15, "type": "string", "description": "Supplier Heat ID", "nullable": true }, "undgs": { "maxItems": 99, "type": "array", "items": { "maxLength": 4, "type": "string", "xml": { "name": "undg" } }, "description": "UN Dangerous Goods Codes", "nullable": true, "xml": { "wrapped": true } }, "additionalDocuments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "category": { "maxLength": 1, "type": "string", "description": "Additional document category", "nullable": true }, "issueDate": { "type": "string", "description": "The effective date of the document (e.g. license, visa, permit, certificate)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Additional document status code", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocumentSubmitter" }, "name": { "maxLength": 35, "type": "string", "description": "Free text description for additional document - additional document name", "nullable": true }, "writeOff": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocumentWriteOff" }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "additionalDocument" } }, "nullable": true, "xml": { "wrapped": true }, "example": [ { "category": "C", "type": "ABC", "refNum": "DOC-2024-001", "lpcoExemptionCode": "AE", "issueDate": "2024-01-15T09:30:00Z", "name": "Import License" }, { "type": "ABCD", "refNum": "DOC-2024-002", "lpcoExemptionCode": "XX", "issueDate": "2024-01-15T09:30:00Z", "name": "Certificate of Origin" } ] }, "additionalInformations": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Coded form of an additional statement", "nullable": true }, "text": { "type": "string", "description": "Description of an additional statement", "nullable": true }, "type": { "type": "string", "description": "Additional statement type", "nullable": true, "example": "type" } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } }, "commodity": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodity" }, "customsValuation": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCustomsValuation" }, "destination": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiDestination" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiGoodsMeasure" }, "governmentProcedure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiGovernmentProcedure" }, "materials": { "maxItems": 999, "type": "array", "items": { "type": "object", "properties": { "equivalent": { "type": "boolean", "description": "Gets or Sets Equivalent", "nullable": true }, "isBonded": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is bonded. Only applicable for special procedures.", "nullable": true }, "itemId": { "maxLength": 256, "type": "string", "description": "ItemId of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data)", "nullable": true }, "itemGroup": { "maxLength": 256, "type": "string", "description": "ItemGroup of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data)", "nullable": true }, "origin": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "County of origin", "nullable": true }, "qty": { "minimum": 0, "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records)", "format": "double", "nullable": true }, "storageLocationReference": { "maxLength": 35, "type": "string", "description": "Storage location code (as known in CAS) from where an the materials which were used in processing. Only applicable for special procedures.", "nullable": true }, "uom": { "maxLength": 6, "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the (semi-)produced product", "nullable": true } }, "xml": { "name": "material" } }, "description": "Materials used in the goods, used for transactional bill of materials", "nullable": true, "xml": { "wrapped": true } }, "origins": { "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Country of origin (ISO 3166-1 2-alpha code)", "nullable": true }, "region": { "maxLength": 5, "type": "string", "description": "Country subdivision of region", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Origin type (PreferentialOrigin, NonPreferentialOrigin)", "nullable": true } }, "xml": { "name": "origin" } }, "nullable": true, "xml": { "wrapped": true } }, "packagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "nullable": true, "xml": { "wrapped": true } }, "innerPackagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of inner packages", "format": "int32", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of inner package of an item", "nullable": true } }, "xml": { "name": "innerPackaging" } }, "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "maxItems": 9999, "type": "array", "items": { "type": "object", "properties": { "art": { "maxLength": 70, "type": "string", "nullable": true }, "billOfLoading": { "maxLength": 70, "type": "string", "nullable": true }, "category": { "maxLength": 2, "type": "string", "nullable": true }, "date": { "type": "string", "description": "Date of the previous document in accordance with national legislation", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "item": { "maxLength": 70, "type": "string", "nullable": true }, "lineNumber": { "maximum": 10000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Item number pertaining to the previous Customs filing", "format": "int32", "nullable": true }, "loc": { "maxLength": 35, "type": "string", "nullable": true }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Type of document used for declaration previously presented", "nullable": true }, "typeOfPackages": { "maxLength": 2, "type": "string", "description": "Type of packages", "nullable": true }, "numberOfPackages": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of packages", "format": "int32", "nullable": true }, "measurementUnitAndQualifier": { "maxLength": 4, "type": "string", "description": "Measurement unit and qualifier", "nullable": true }, "quantity": { "minimum": 0, "type": "number", "description": "Quantity of packages", "format": "double", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "tradeTerms": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiTradeTerms" }, "ucr": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGAGIUcr" }, "valuationAdjustments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "amount": { "minimum": 0, "type": "number", "description": "Monetary amount by which the valuation was adjusted", "format": "double", "nullable": true }, "qualifier": { "maxLength": 4, "type": "string", "description": "This data element is required when using valuation method 1 (transaction of the imported goods), otherwise it should be left blank.", "nullable": true } }, "xml": { "name": "valuationAdjustment" } }, "nullable": true, "xml": { "wrapped": true } }, "consignee": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "processingType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGovernmentAgencyGoodsItem-ProcessingTypeEnum" }, "exporter": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "additionalReferences": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "id": { "maxLength": 70, "type": "string", "description": "`\r\n Reference number for any additional declarations made which is not covered by Supporting Document, transport document or additional information (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "maxLength": 4, "type": "string", "description": "Additional reference type code (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.ExciseGoodsItem" }, "blendResult": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiBlendResult" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSGovernmentAgencyGoodsItem-ProcessingTypeEnum": { "enum": [ "0", "1", "2", "4", "8" ], "type": "string", "description": "

Possible values:

", "example": "1" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSInvoice": { "type": "object", "properties": { "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "number": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSSurety": { "type": "object", "properties": { "code": { "type": "string", "description": "The identifier of the party who agrees to be responsible for the debt or obligation of another", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSTradeTerms": { "type": "object", "properties": { "placeCode": { "maxLength": 17, "type": "string", "nullable": true }, "place": { "maxLength": 512, "type": "string", "description": "Name of the point or port of departure, shipment or destination, as required under the applicable terms of delivery, e.g. Incoterm", "nullable": true }, "termsCode": { "maxLength": 3, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Delivery Terms (DAF, EXW, FCA, CPT, CIP, DAT, DAP, DDP, DDU, FAS, FOB, CFR, CIF, DES, DEQ, XXX)", "nullable": true }, "countryRelationshipCode": { "type": "integer", "description": "Indication whether the place specified for the performance of a (contractual) obligation is located in the country where the declaration is made, in another member country of the same economic or Customs union, or in a third country", "format": "int32", "nullable": true }, "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSUcr": { "type": "object", "properties": { "traderReference": { "maxLength": 35, "type": "string", "description": "This data element can only be given once, either on header level or on item level.", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGSWarehouse": { "type": "object", "properties": { "type": { "maxLength": 3, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Identification Of Warehouse (T, B, s, D, E, FS specific; procedure, X, Y, Z)", "nullable": true }, "externalReference": { "maxLength": 35, "type": "string", "description": "Identification of warehouse", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGoodsMeasure": { "type": "object", "properties": { "gmass": { "minimum": 0, "type": "number", "description": "Gross mass (kg)", "format": "double", "nullable": true }, "nmass": { "minimum": 0, "type": "number", "description": "Net mass (kg)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGoodsShipment": { "type": "object", "properties": { "exportCountry": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Country of Dispatch/Export", "nullable": true }, "trxNatCode": { "maximum": 100, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "This data element can only be given once, either on header level or on item level.", "format": "int32", "nullable": true }, "consignee": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "consignment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSConsignment" }, "consignor": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "customsValuation": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSCustomsValuation" }, "destination": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSDestination" }, "domesticDutyTaxParties": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "identification": { "maxLength": 17, "type": "string", "description": "To identify a party responsible for the national VAT or Goods & Services Tax", "nullable": true }, "roleCode": { "maxLength": 3, "type": "string", "description": "VAT-related fiscal references: FR1 (importer), FR2 (customer), FR3 (tax representative), FR4 (holder of the deferred payment authorisation)", "nullable": true }, "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSDomesticDutyTaxPartyAddress" } }, "xml": { "name": "domesticDutyTaxParty" } }, "nullable": true, "xml": { "wrapped": true } }, "exporter": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "seller": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "buyer": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "surety": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSSurety" }, "tradeTerms": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSTradeTerms" }, "ucr": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSUcr" }, "warehouse": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSWarehouse" }, "elo": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSElo" }, "additionalReferences": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "id": { "maxLength": 70, "type": "string", "description": "`\r\n Reference number for any additional declarations made which is not covered by Supporting Document, transport document or additional information (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "maxLength": 4, "type": "string", "description": "Additional reference type code (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } }, "governmentAgencyGoodsItems": { "maxItems": 9999, "type": "array", "items": { "type": "object", "properties": { "addDeclType2": { "maxLength": 6, "type": "string", "description": "Transit declaration/Proof of customs status type", "nullable": true }, "containerIdentification": { "maxLength": 17, "type": "string", "description": "DEPRECATED - Use the goodsReferences field on the goods shipment level transportEquipment instead, providing the seqNum of the goods item.", "nullable": true, "deprecated": true }, "customsValue": { "minimum": 0, "type": "number", "format": "double", "nullable": true }, "productReference": { "maxLength": 256, "type": "string", "description": "Unique identifier for a specific product or batch (e.g. serial number, VIN, batch number)", "nullable": true }, "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Goods item (sequence) number", "format": "int32", "nullable": true }, "statValue": { "minimum": 0, "type": "number", "description": "Statistical value", "format": "double", "nullable": true }, "trxNatCode": { "maximum": 100, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "This data element can only be given once, either on header level or on item level.", "format": "int32", "nullable": true }, "heatId": { "maxLength": 15, "type": "string", "description": "Heat ID", "nullable": true }, "supplierHeatId": { "maxLength": 15, "type": "string", "description": "Supplier Heat ID", "nullable": true }, "undgs": { "maxItems": 99, "type": "array", "items": { "maxLength": 4, "type": "string", "xml": { "name": "undg" } }, "description": "UN Dangerous Goods Codes", "nullable": true, "xml": { "wrapped": true } }, "additionalDocuments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "category": { "maxLength": 1, "type": "string", "description": "Additional document category", "nullable": true }, "issueDate": { "type": "string", "description": "The effective date of the document (e.g. license, visa, permit, certificate)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Additional document status code", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocumentSubmitter" }, "name": { "maxLength": 35, "type": "string", "description": "Free text description for additional document - additional document name", "nullable": true }, "writeOff": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiAdditionalDocumentWriteOff" }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "additionalDocument" } }, "nullable": true, "xml": { "wrapped": true }, "example": [ { "category": "C", "type": "ABC", "refNum": "DOC-2024-001", "lpcoExemptionCode": "AE", "issueDate": "2024-01-15T09:30:00Z", "name": "Import License" }, { "type": "ABCD", "refNum": "DOC-2024-002", "lpcoExemptionCode": "XX", "issueDate": "2024-01-15T09:30:00Z", "name": "Certificate of Origin" } ] }, "additionalInformations": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Coded form of an additional statement", "nullable": true }, "text": { "type": "string", "description": "Description of an additional statement", "nullable": true }, "type": { "type": "string", "description": "Additional statement type", "nullable": true, "example": "type" } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } }, "commodity": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCommodity" }, "customsValuation": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiCustomsValuation" }, "destination": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiDestination" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiGoodsMeasure" }, "governmentProcedure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiGovernmentProcedure" }, "materials": { "maxItems": 999, "type": "array", "items": { "type": "object", "properties": { "equivalent": { "type": "boolean", "description": "Gets or Sets Equivalent", "nullable": true }, "isBonded": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is bonded. Only applicable for special procedures.", "nullable": true }, "itemId": { "maxLength": 256, "type": "string", "description": "ItemId of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data)", "nullable": true }, "itemGroup": { "maxLength": 256, "type": "string", "description": "ItemGroup of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data)", "nullable": true }, "origin": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "County of origin", "nullable": true }, "qty": { "minimum": 0, "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records)", "format": "double", "nullable": true }, "storageLocationReference": { "maxLength": 35, "type": "string", "description": "Storage location code (as known in CAS) from where an the materials which were used in processing. Only applicable for special procedures.", "nullable": true }, "uom": { "maxLength": 6, "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the (semi-)produced product", "nullable": true } }, "xml": { "name": "material" } }, "description": "Materials used in the goods, used for transactional bill of materials", "nullable": true, "xml": { "wrapped": true } }, "origins": { "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "country": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "description": "Country of origin (ISO 3166-1 2-alpha code)", "nullable": true }, "region": { "maxLength": 5, "type": "string", "description": "Country subdivision of region", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Origin type (PreferentialOrigin, NonPreferentialOrigin)", "nullable": true } }, "xml": { "name": "origin" } }, "nullable": true, "xml": { "wrapped": true } }, "packagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "maxLength": 2, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "nullable": true, "xml": { "wrapped": true } }, "innerPackagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of inner packages", "format": "int32", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of inner package of an item", "nullable": true } }, "xml": { "name": "innerPackaging" } }, "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "maxItems": 9999, "type": "array", "items": { "type": "object", "properties": { "art": { "maxLength": 70, "type": "string", "nullable": true }, "billOfLoading": { "maxLength": 70, "type": "string", "nullable": true }, "category": { "maxLength": 2, "type": "string", "nullable": true }, "date": { "type": "string", "description": "Date of the previous document in accordance with national legislation", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "item": { "maxLength": 70, "type": "string", "nullable": true }, "lineNumber": { "maximum": 10000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Item number pertaining to the previous Customs filing", "format": "int32", "nullable": true }, "loc": { "maxLength": 35, "type": "string", "nullable": true }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Type of document used for declaration previously presented", "nullable": true }, "typeOfPackages": { "maxLength": 2, "type": "string", "description": "Type of packages", "nullable": true }, "numberOfPackages": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of packages", "format": "int32", "nullable": true }, "measurementUnitAndQualifier": { "maxLength": 4, "type": "string", "description": "Measurement unit and qualifier", "nullable": true }, "quantity": { "minimum": 0, "type": "number", "description": "Quantity of packages", "format": "double", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "tradeTerms": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiTradeTerms" }, "ucr": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGAGIUcr" }, "valuationAdjustments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "amount": { "minimum": 0, "type": "number", "description": "Monetary amount by which the valuation was adjusted", "format": "double", "nullable": true }, "qualifier": { "maxLength": 4, "type": "string", "description": "This data element is required when using valuation method 1 (transaction of the imported goods), otherwise it should be left blank.", "nullable": true } }, "xml": { "name": "valuationAdjustment" } }, "nullable": true, "xml": { "wrapped": true } }, "consignee": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "processingType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGovernmentAgencyGoodsItem-ProcessingTypeEnum" }, "exporter": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "additionalReferences": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "id": { "maxLength": 70, "type": "string", "description": "`\r\n Reference number for any additional declarations made which is not covered by Supporting Document, transport document or additional information (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "maxLength": 4, "type": "string", "description": "Additional reference type code (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.ExciseGoodsItem" }, "blendResult": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSGagiBlendResult" } }, "xml": { "name": "governmentAgencyGoodsItem" } }, "nullable": true, "xml": { "wrapped": true } }, "invoice": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGSInvoice" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADGovernmentProcedure": { "type": "object", "properties": { "proc": { "type": "string", "description": "Gets or Sets Proc", "nullable": true }, "prevProc": { "type": "string", "description": "Gets or Sets PrevProc", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADObligationGuarantee": { "type": "object", "properties": { "securityDetails": { "maxLength": 16, "type": "string", "description": "Guarantee type", "nullable": true }, "reference": { "maxLength": 64, "type": "string", "nullable": true }, "access": { "maxLength": 4, "type": "string", "nullable": true }, "amount": { "minimum": 0, "type": "number", "description": "Amount (in the currency of the jurisdiction of the declaration as per SingleAdministrativeDocument.CurrencyExchange.Currency)", "format": "double", "nullable": true }, "excludedCountries": { "maxItems": 99, "type": "array", "items": { "pattern": "^[a-zA-Z]{2}$", "type": "string", "xml": { "name": "excludedCountry" } }, "nullable": true, "xml": { "wrapped": true } }, "declarationOffice": { "maxLength": 8, "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SADPackaging": { "type": "object", "properties": { "quantity": { "maximum": 100000000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of packages", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADPreviousDocument": { "type": "object", "properties": { "billOfLoading": { "maxLength": 70, "type": "string", "nullable": true }, "category": { "maxLength": 2, "type": "string", "description": "Description of an additional statement", "nullable": true }, "date": { "type": "string", "description": "Date of the previous document in accordance with national legislation", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "The number of a previous document", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADReferenceNumber": { "required": [ "number", "type" ], "type": "object", "properties": { "number": { "maxLength": 35, "minLength": 1, "type": "string", "description": "Reference number (format: an..35) (cardinality: 1x)" }, "type": { "maxLength": 32, "minLength": 1, "type": "string", "description": "Reference type (format: an..15) (cardinality: 1x)" } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADStatusHistory": { "type": "object", "properties": { "status": { "maxLength": 17, "type": "string", "description": "Historic status of the declaration (only used in return files)", "nullable": true }, "statusDateTime": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" } }, "additionalProperties": false, "description": "List of statuses of the declaration (only used in return files)" }, "Cas.Ingestions.Models.CustomsShipment.V1.SADWriteoffRule": { "type": "object", "properties": { "authorizationId": { "maxLength": 255, "type": "string", "description": "The ID of the authorisation as defined in master data", "nullable": true }, "customsStatus": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.WriteOffCustomsStatus" }, "isOfPreferentialOrigin": { "type": "boolean", "description": "One of\r\n0: If stock needs to be picked that isn’t of preferential origin\r\n1: If stock needs to be picked that is of preferential origin, regardless of country of preferential origin. Typically used when goods need to be released for free circulation so that reduced duties need can be used.", "nullable": true }, "preferentialOriginCountry": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country of preferential origin to pick stock for", "nullable": true }, "nonPreferentialOriginCountry": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country of non-preferential origin to pick stock for", "nullable": true }, "inboundDocRefNum": { "maxLength": 255, "type": "string", "description": "The MRN of the inbound declaration from which stock is written off", "nullable": true }, "inboundFunctionRefNum": { "maxLength": 255, "type": "string", "description": "The LRN of the inbound declaration from which stock is written off\r\n(It is advised to only use InboundFunctionRefNum if the inbound declaration was an EIDR, and thus doesn’t have an MRN)", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.CustomsShipment.V1.SingleAdministrativeDocument": { "required": [ "goodsShipment" ], "type": "object", "properties": { "accDateCode": { "type": "string", "description": "Date of acceptance of the declaration. Also referred to as tax point.", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "addDeclType1": { "type": "string", "description": "Additional Declaration Type (A, B, C, D, E, F, X, Y, Z)", "nullable": true }, "addDeclType2": { "maxLength": 5, "type": "string", "description": "Transit declaration/Proof of customs status type (T, T1, T2, T2L, T2LF)", "nullable": true }, "agentStatus": { "type": "string", "description": "Agent Status (1, 2, 3)", "nullable": true, "example": "1" }, "amalgamate": { "type": "boolean", "description": "In the context of MCP Destin8, indicates whether multiple consignments are combined under a single customs declaration.\r\nWhen set to true, the consignment is part of an amalgamated (grouped) shipment UCN.", "nullable": true }, "beginDatePeriod": { "type": "string", "description": "Begin date of the globalization period", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "endDatePeriod": { "type": "string", "description": "/// \r\nEnd date of the globalization period\r\nEnd date of the globalization period", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "declarationOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "declType": { "maxLength": 2, "type": "string", "description": "Declaration Type (IM, CO, EX)", "nullable": true }, "destinationOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "docRefNum": { "maxLength": 35, "type": "string", "description": "MRN - document reference number", "nullable": true }, "entryOfficeCode": { "maxLength": 17, "type": "string", "description": "Customs office of entry", "nullable": true }, "exitOfficeCode": { "maxLength": 17, "type": "string", "description": "Customs office of exit", "nullable": true }, "functionRefNum": { "maxLength": 35, "type": "string", "description": "LRN - functional reference number", "nullable": true }, "invoiceCurrency": { "maxLength": 3, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "issueDate": { "type": "string", "description": "Declaration date - issue date at which a document was issued", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "presentationDate": { "type": "string", "description": "Presentation date - date at which goods are presented to customs (format: an..35) (cardinality: 1x)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "loadingDate": { "type": "string", "description": "Loading date - date at which goods are loaded (format: an..35) (cardinality: 1x)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "issuePlaceCode": { "maxLength": 35, "type": "string", "description": "Declaration place - issue place at which a document was issued and when (format: an..35) (cardinality: 1x)", "nullable": true }, "pointOfExit": { "maxLength": 64, "type": "string", "description": "A free text field that may be used to determine the customs flow and possibly other deductions that are based on decision tables.It is not used by CAS other than that (format: an..64) (cardinality: 1x)", "nullable": true }, "pointOfEntry": { "maxLength": 64, "type": "string", "description": "A free text field that may be used to determine the customs flow and possibly other deductions that are based on decision tables.It is not used by CAS other than that (format: an..64) (cardinality: 1x)", "nullable": true }, "presentationOfficeCode": { "maxLength": 17, "type": "string", "description": "Customs office of presentation (format: an..17) (cardinality: 1x)", "nullable": true }, "status": { "maxLength": 17, "type": "string", "description": "Status of the declaration (only used in return files)", "nullable": true }, "supervisingOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "totalInvoiceAmount": { "minimum": 0, "type": "number", "description": "Total amount invoiced", "format": "double", "nullable": true }, "totNumItems": { "maximum": 99999, "minimum": 0, "type": "integer", "description": "Total number of items", "format": "int32", "nullable": true }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Coded form of an additional statement", "nullable": true }, "text": { "type": "string", "description": "Description of an additional statement", "nullable": true }, "type": { "type": "string", "description": "Additional statement type", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalParties": { "type": "array", "items": { "type": "object", "properties": { "partyType": { "type": "string", "description": "Gets or Sets PartyType", "nullable": true }, "party": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalPartyParty" } }, "xml": { "name": "additionalParty" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalDocuments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "category": { "maxLength": 1, "type": "string", "description": "Additional document category", "nullable": true }, "issueDate": { "type": "string", "description": "The effective date of the document (e.g. license, visa, permit, certificate)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Identifier of a document providing additional information", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADAdditionalDocumentSubmitter" } }, "xml": { "name": "additionalDocument" } }, "nullable": true, "xml": { "wrapped": true }, "example": [ { "category": "C", "type": "ABC", "refNum": "DOC-2024-001", "lpcoExemptionCode": "AE", "issueDate": "2024-01-15T09:30:00Z", "name": "Import License" }, { "type": "ABCD", "refNum": "DOC-2024-002", "lpcoExemptionCode": "XX", "issueDate": "2024-01-15T09:30:00Z", "name": "Certificate of Origin" } ] }, "agent": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "calculationReturns": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "basisQty": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base quantity", "format": "double", "nullable": true }, "basisValue": { "minimum": 0, "type": "number", "description": "Calculation of taxes – Tax base amount", "format": "double", "nullable": true }, "dutyRegime": { "maxLength": 3, "type": "string", "description": "Duty regime", "nullable": true }, "quotaId": { "maxLength": 17, "type": "string", "description": "Quota order number", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax rate", "format": "double", "nullable": true }, "reducedAssessed": { "minimum": 0, "type": "number", "description": "Amount of deduction from a duty or tax - assessed", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Calculation of taxes - Tax type", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADCalculationReturnPayment" } }, "xml": { "name": "calculationReturn" } }, "nullable": true, "xml": { "wrapped": true } }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADCurrencyExchange" }, "declarant": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "dutyTaxFees": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "basisQty": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax base quantity", "format": "double", "nullable": true }, "basisValue": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax base amount", "format": "double", "nullable": true }, "dutyRegime": { "maxLength": 3, "type": "string", "description": "Code specifying a type of duty regime", "nullable": true }, "quotaId": { "maxLength": 17, "type": "string", "description": "Quota order number", "nullable": true }, "rate": { "minimum": 0, "type": "number", "description": "Calculation of taxes - Tax rate", "format": "double", "nullable": true }, "type": { "maxLength": 3, "type": "string", "description": "Calculation of taxes - Tax type", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADDutyTaxFeePayment" } }, "xml": { "name": "dutyTaxFee" } }, "nullable": true, "xml": { "wrapped": true } }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGoodsMeasure" }, "goodsShipment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGoodsShipment" }, "governmentProcedure": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADGovernmentProcedure" }, "importer": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.BusinessPartner" }, "packaging": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADPackaging" }, "previousDocument": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADPreviousDocument" }, "statusHistories": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "status": { "maxLength": 17, "type": "string", "description": "Historic status of the declaration (only used in return files)", "nullable": true }, "statusDateTime": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" } }, "xml": { "name": "statusHistory" } }, "nullable": true, "xml": { "wrapped": true } }, "referenceNumbers": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "number": { "maxLength": 35, "minLength": 1, "type": "string", "description": "Reference number (format: an..35) (cardinality: 1x)" }, "type": { "maxLength": 32, "minLength": 1, "type": "string", "description": "Reference type (format: an..15) (cardinality: 1x)" } }, "xml": { "name": "referenceNumber" } }, "nullable": true, "xml": { "wrapped": true } }, "obligationGuarantee": { "allOf": [ { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SADObligationGuarantee" } ], "description": "DEPRECATED - Use obligationGuarantees instead.", "deprecated": true }, "obligationGuarantees": { "maxItems": 999, "type": "array", "items": { "type": "object", "properties": { "securityDetails": { "maxLength": 16, "type": "string", "description": "Guarantee type", "nullable": true }, "reference": { "maxLength": 64, "type": "string", "nullable": true }, "access": { "maxLength": 4, "type": "string", "nullable": true }, "amount": { "minimum": 0, "type": "number", "description": "Amount (in the currency of the jurisdiction of the declaration as per SingleAdministrativeDocument.CurrencyExchange.Currency)", "format": "double", "nullable": true }, "excludedCountries": { "maxItems": 99, "type": "array", "items": { "pattern": "^[a-zA-Z]{2}$", "type": "string", "xml": { "name": "excludedCountry" } }, "nullable": true, "xml": { "wrapped": true } }, "declarationOffice": { "maxLength": 8, "type": "string", "nullable": true } }, "xml": { "name": "obligationGuarantee" } }, "nullable": true, "xml": { "wrapped": true } }, "authorizationHolders": { "type": "array", "items": { "type": "object", "properties": { "authorizationId": { "maxLength": 17, "type": "string", "description": "Gets or Sets Authorization Id", "nullable": true }, "categoryCode": { "maxLength": 4, "type": "string", "description": "Gets or Sets Category Code", "nullable": true }, "authorizationReference": { "maxLength": 64, "type": "string", "description": "Gets or Sets Authorization Reference", "nullable": true } }, "xml": { "name": "authorizationHolder" } }, "nullable": true, "xml": { "wrapped": true } }, "exportOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "previousDocuments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "billOfLoading": { "maxLength": 70, "type": "string", "nullable": true }, "category": { "maxLength": 2, "type": "string", "description": "Description of an additional statement", "nullable": true }, "date": { "type": "string", "description": "Date of the previous document in accordance with national legislation", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "The number of a previous document", "nullable": true } }, "xml": { "name": "previousDocument" } }, "description": "Gets or Sets Previous Documents (should be used instead of PreviousDocument property in the future)", "nullable": true, "xml": { "wrapped": true } }, "transitProcedure": { "type": "string", "nullable": true }, "writeoffRules": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "authorizationId": { "maxLength": 255, "type": "string", "description": "The ID of the authorisation as defined in master data", "nullable": true }, "customsStatus": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.WriteOffCustomsStatus" }, "isOfPreferentialOrigin": { "type": "boolean", "description": "One of\r\n0: If stock needs to be picked that isn’t of preferential origin\r\n1: If stock needs to be picked that is of preferential origin, regardless of country of preferential origin. Typically used when goods need to be released for free circulation so that reduced duties need can be used.", "nullable": true }, "preferentialOriginCountry": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country of preferential origin to pick stock for", "nullable": true }, "nonPreferentialOriginCountry": { "maxLength": 2, "minLength": 2, "type": "string", "description": "The country of non-preferential origin to pick stock for", "nullable": true }, "inboundDocRefNum": { "maxLength": 255, "type": "string", "description": "The MRN of the inbound declaration from which stock is written off", "nullable": true }, "inboundFunctionRefNum": { "maxLength": 255, "type": "string", "description": "The LRN of the inbound declaration from which stock is written off\r\n(It is advised to only use InboundFunctionRefNum if the inbound declaration was an EIDR, and thus doesn’t have an MRN)", "nullable": true } }, "xml": { "name": "writeoffRule" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "" }, "Cas.Ingestions.Models.CustomsShipment.V1.SuccessActionType": { "enum": [ "submit", "amend", "submitOrAmend" ], "type": "string", "description": "The type of action to perform on success

Possible values:

", "example": "submit" }, "Cas.Ingestions.Models.CustomsShipment.V1.WriteOffCustomsStatus": { "enum": [ "Unknown", "Free", "Bonded" ], "type": "string", "description": "

Possible values:

", "example": "Unknown" }, "Cas.Ingestions.Models.DeclarationActions.V1.Amendment": { "type": "object", "properties": { "functionRefNum": { "type": "string", "description": "LRN of the declaration to amend.", "nullable": true }, "amendmentType": { "type": "string", "description": "Type of amendment to perform.", "nullable": true }, "goodsLocationIdentification": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.DeclarationActions.V1.GoodsArrived": { "type": "object", "properties": { "functionRefNum": { "type": "string", "description": "LRN of the declaration to arrive.", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.DeclarationActions.V1.Invalidation": { "type": "object", "properties": { "functionRefNum": { "type": "string", "description": "LRN of the declaration to invalidate.", "nullable": true }, "reason": { "type": "string", "description": "Reason why the declaration is being invalidated.", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.Formula.V1.Formula": { "required": [ "activeFromDate", "formulaLines", "itemId", "processingType", "quantity", "uom" ], "type": "object", "properties": { "version": { "maxLength": 16, "type": "string", "nullable": true }, "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "External reference of the item (as known in CAS in article master data). Unique identifier of the produced item" }, "documentReference": { "type": "string", "description": "Reference to the document that triggered the creation of the formula version", "nullable": true }, "activeFromDate": { "type": "string", "example": "2024-01-15T09:30:00Z" }, "activeUntilDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "quantity": { "type": "number", "description": "Quantity of the (semi-)produced product", "format": "double" }, "uom": { "maxLength": 5, "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" }, "processingType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Formula.V1.Formula-ProcessingTypeEnum" }, "formulaLines": { "maxItems": 9999, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Unique technical identifier of the formula line" }, "quantity": { "type": "number", "description": "Quantity of the material/semi-finished product", "format": "double" }, "uom": { "maxLength": 5, "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" } }, "xml": { "name": "formulaLine" } }, "description": "List of formula lines", "xml": { "wrapped": true } }, "storageLocationReference": { "maxLength": 255, "type": "string", "description": "External reference of the storage location", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.Formula.V1.Formula-ProcessingTypeEnum": { "enum": [ "0", "1", "2", "4", "5" ], "type": "string", "description": "

Possible values:

", "example": "1" }, "Cas.Ingestions.Models.Formula.V1.FormulaLine": { "required": [ "itemId", "quantity", "uom" ], "type": "object", "properties": { "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Unique technical identifier of the formula line" }, "quantity": { "type": "number", "description": "Quantity of the material/semi-finished product", "format": "double" }, "uom": { "maxLength": 5, "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" } }, "additionalProperties": false }, "Cas.Ingestions.Models.MaterialList.V1.MaterialList": { "required": [ "byProducts", "externalReference", "itemId", "materialListLines", "processingType", "productionDate", "quantity", "storageLocationReference", "uom" ], "type": "object", "properties": { "version": { "maxLength": 16, "type": "string", "nullable": true }, "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "External reference of the item (as known in CAS in article master data). Unique identifier of the produced item" }, "externalReference": { "minLength": 1, "type": "string", "description": "Unique external reference of the material list" }, "documentReference": { "type": "string", "description": "Reference to the document that triggered the creation of material list", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the (semi-)produced product\r\nE.g. VIN number", "nullable": true }, "productionDate": { "type": "string", "example": "2024-01-15T09:30:00Z" }, "quantity": { "type": "number", "description": "Quantity of the (semi-)produced product", "format": "double" }, "uom": { "maxLength": 5, "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" }, "storageLocationReference": { "minLength": 1, "type": "string", "description": "Storage location reference (as known in CAS)" }, "processingType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.MaterialList.V1.MaterialList-ProcessingTypeEnum" }, "materialListLines": { "maxItems": 9999, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Unique technical identifier of the material list line" }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the semi-finished product", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of the material/semi-finished product", "format": "double" }, "uom": { "maxLength": 5, "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" }, "storageLocationReference": { "type": "string", "description": "Storage location reference (as known in CAS)", "nullable": true } }, "xml": { "name": "materialListLine" } }, "xml": { "wrapped": true } }, "byProducts": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Unique technical identifier of the material list line" }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the semi-finished product", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of the material/semi-finished product", "format": "double" }, "uom": { "maxLength": 5, "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" }, "storageLocationReference": { "type": "string", "description": "Storage location reference (as known in CAS)", "nullable": true } }, "xml": { "name": "byProduct" } }, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Ingestions.Models.MaterialList.V1.MaterialList-ProcessingTypeEnum": { "enum": [ "0", "1", "2", "4", "5" ], "type": "string", "description": "

Possible values:

", "example": "1" }, "Cas.Ingestions.Models.MaterialList.V1.MaterialListInvalidationRequest": { "required": [ "externalReference", "version" ], "type": "object", "properties": { "version": { "minLength": 1, "type": "string" }, "externalReference": { "minLength": 1, "type": "string", "description": "Unique external reference of the material list" }, "reason": { "type": "string", "description": "Invalidation reason", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.MaterialList.V1.MaterialListLine": { "required": [ "itemId", "quantity", "uom" ], "type": "object", "properties": { "itemId": { "maxLength": 128, "minLength": 1, "type": "string", "description": "Unique technical identifier of the material list line" }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the semi-finished product", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of the material/semi-finished product", "format": "double" }, "uom": { "maxLength": 5, "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" }, "storageLocationReference": { "type": "string", "description": "Storage location reference (as known in CAS)", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.Movement.V1.Direction": { "enum": [ "UNKNOWN", "IN", "OUT", "TRANSFER" ], "type": "string", "description": "

Possible values:

", "example": "UNKNOWN" }, "Cas.Ingestions.Models.Movement.V1.Movement": { "required": [ "externalReference", "movementLines", "timestamp" ], "type": "object", "properties": { "timestamp": { "type": "string", "example": "2024-01-15T09:30:00Z" }, "documentReference": { "maxLength": 255, "type": "string", "description": "Reference to the document that triggered the creation of movement (SAP: ZMBLNR)", "nullable": true }, "externalReference": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Unique external reference movement" }, "externalMovementType": { "maxLength": 255, "type": "string", "description": "Type of movement as known by inventory or warehouse management system", "nullable": true }, "customsMovementType": { "type": "string", "description": "Deprecated, replaced by Movement Type", "nullable": true }, "movementLines": { "maxItems": 9999, "type": "array", "items": { "type": "object", "properties": { "itemId": { "minLength": 1, "type": "string", "description": "Unique identifier of the item/material as defined in master data" }, "itemDescription": { "minLength": 1, "type": "string", "description": "An optional description for the item. Will be displayed in stock and movement views.\r\nIf not provided, CAS will deduct it from Master Data." }, "direction": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.Direction" }, "serialBatchReference": { "minLength": 1, "type": "string", "description": "Unique serial or batch number of the item" }, "quantity": { "type": "number", "description": "Quantity of the item in the base unit of measure as defined in master data", "format": "double" }, "uom": { "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined.\r\n\r\nMain used codes:\r\n- DTN: Hectokilogram\r\n- HLT: Hectolitre\r\n- KGM: Kilogram\r\n- LPA: Litre pure (100%) alcohol\r\n- LTR: Litre\r\n- L15: Litres at 15 °C\r\n- L20: Litres at 20 °C\r\n- MTK: Square metre\r\n- NAR: Piece\r\n- 101: Hectolitres pure alcohol at 20 °C\r\n- 102: 1.000 litres at 15 °C\r\n- KGV: KGM Vacuum" }, "storageLocationReference": { "minLength": 1, "type": "string", "description": "Storage location reference (as known in CAS)" }, "receivingStorageLocationReference": { "type": "string", "description": "For transfer movements (TRFA, TRFR)\r\nMandatory for TRFR", "nullable": true }, "receivingAuthorizationId": { "type": "string", "description": "For transfer movement between authorizations (TRFA)\r\nMandatory for TRFA", "nullable": true }, "stockRecordId": { "type": "integer", "description": "Stock record id, only used for movements initiated by CAS UI", "format": "int64", "nullable": true }, "authorisationId": { "type": "string", "description": "Deprecated, replaced by AuthorizationId", "nullable": true, "deprecated": true }, "authorizationId": { "type": "string", "description": "For transfer movements (TRFA, TRFR)\r\nMandatory for movement type TRFA, and when there are multiple special procedure and/or tax warehouse authorisations on the storage location", "nullable": true }, "exciseProductCode": { "type": "string", "description": "Excise Product code.\r\nIf not provided CAS will try to deduct it from Item Master Data.\r\n\r\nSome example codes:\r\n- B000: Beer\r\n- E300: Mineral oils\r\n- S300: Ethyl alcohol\r\n- W300: Sparkling wine\r\n\r\nFor movements of excise products in Belgium the excise product code is needed to correctly construct the excise register.", "nullable": true }, "density": { "type": "number", "description": "The Density as ingested or indicated by a user,\r\nWhich can then be used to calculate an additional quantity and to be taken over in subsequent outbound EMCS movements\r\nOnly used for IN lines: result of a production or positive stock adjustment", "format": "double", "nullable": true }, "asv": { "type": "number", "description": "Alcohol % by volume, sometimes also abbreviated as ABV\r\nApplicable in case of production of an alcoholic product.", "format": "double", "nullable": true }, "preferentialOriginCountry": { "type": "string", "description": "The preferential origin country of a good being produced.\r\nMay be provided in the IN movement line for PROC, UFOH and ADJP movement types", "nullable": true }, "nonPreferentialOriginCountry": { "type": "string", "description": "The non-preferential origin country of a good being produced.\r\nMay be provided in the IN movement line for PROC, UFOH and ADJP movement types", "nullable": true }, "quantities": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "type": "number", "description": "Quantity of the item in a given UoM", "format": "double" }, "uom": { "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" } }, "xml": { "name": "quantity" } }, "description": "Quantities", "nullable": true, "xml": { "wrapped": true } }, "blendResult": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementLineBlendResult" } }, "xml": { "name": "movementLine" } }, "description": "The item level data of the movement", "xml": { "wrapped": true } }, "movementType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementType" }, "category": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementCategory" }, "remark": { "maxLength": 255, "type": "string", "description": "If used for a tax warehouse stock correction, it will be shown in column '7. Remarks' of the excise register", "nullable": true }, "movementAdjustmentData": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementAdjustmentData" } }, "additionalProperties": false }, "Cas.Ingestions.Models.Movement.V1.MovementAdjustmentData": { "type": "object", "properties": { "arc": { "maxLength": 21, "type": "string", "description": "Administrative reference code of an e-AD, for a positive or negative correction movement related to an e-AD", "nullable": true }, "arcSequenceNumber": { "type": "integer", "description": "Sequence number of an e-AD, for a positive or negative correction movement related to an e-AD", "format": "int32", "nullable": true }, "mrn": { "maxLength": 21, "type": "string", "description": "MRN of a related export, for a positive or negative correction movement related to an e-AD for export", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.Movement.V1.MovementCategory": { "enum": [ "Unknown", "DispatchUnderSuspension", "Export", "ArrivalUnderSuspension", "Production", "OtherArrival" ], "type": "string", "description": "

Possible values:

", "example": "Unknown" }, "Cas.Ingestions.Models.Movement.V1.MovementIngest": { "required": [ "movements", "version" ], "type": "object", "properties": { "version": { "minLength": 1, "type": "string", "description": "Version of the service contract, in this case ‘1.0’" }, "movements": { "maxItems": 999, "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "2024-01-15T09:30:00Z" }, "documentReference": { "maxLength": 255, "type": "string", "description": "Reference to the document that triggered the creation of movement (SAP: ZMBLNR)", "nullable": true }, "externalReference": { "maxLength": 255, "minLength": 1, "type": "string", "description": "Unique external reference movement" }, "externalMovementType": { "maxLength": 255, "type": "string", "description": "Type of movement as known by inventory or warehouse management system", "nullable": true }, "customsMovementType": { "type": "string", "description": "Deprecated, replaced by Movement Type", "nullable": true }, "movementLines": { "maxItems": 9999, "type": "array", "items": { "type": "object", "properties": { "itemId": { "minLength": 1, "type": "string", "description": "Unique identifier of the item/material as defined in master data" }, "itemDescription": { "minLength": 1, "type": "string", "description": "An optional description for the item. Will be displayed in stock and movement views.\r\nIf not provided, CAS will deduct it from Master Data." }, "direction": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.Direction" }, "serialBatchReference": { "minLength": 1, "type": "string", "description": "Unique serial or batch number of the item" }, "quantity": { "type": "number", "description": "Quantity of the item in the base unit of measure as defined in master data", "format": "double" }, "uom": { "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined.\r\n\r\nMain used codes:\r\n- DTN: Hectokilogram\r\n- HLT: Hectolitre\r\n- KGM: Kilogram\r\n- LPA: Litre pure (100%) alcohol\r\n- LTR: Litre\r\n- L15: Litres at 15 °C\r\n- L20: Litres at 20 °C\r\n- MTK: Square metre\r\n- NAR: Piece\r\n- 101: Hectolitres pure alcohol at 20 °C\r\n- 102: 1.000 litres at 15 °C\r\n- KGV: KGM Vacuum" }, "storageLocationReference": { "minLength": 1, "type": "string", "description": "Storage location reference (as known in CAS)" }, "receivingStorageLocationReference": { "type": "string", "description": "For transfer movements (TRFA, TRFR)\r\nMandatory for TRFR", "nullable": true }, "receivingAuthorizationId": { "type": "string", "description": "For transfer movement between authorizations (TRFA)\r\nMandatory for TRFA", "nullable": true }, "stockRecordId": { "type": "integer", "description": "Stock record id, only used for movements initiated by CAS UI", "format": "int64", "nullable": true }, "authorisationId": { "type": "string", "description": "Deprecated, replaced by AuthorizationId", "nullable": true, "deprecated": true }, "authorizationId": { "type": "string", "description": "For transfer movements (TRFA, TRFR)\r\nMandatory for movement type TRFA, and when there are multiple special procedure and/or tax warehouse authorisations on the storage location", "nullable": true }, "exciseProductCode": { "type": "string", "description": "Excise Product code.\r\nIf not provided CAS will try to deduct it from Item Master Data.\r\n\r\nSome example codes:\r\n- B000: Beer\r\n- E300: Mineral oils\r\n- S300: Ethyl alcohol\r\n- W300: Sparkling wine\r\n\r\nFor movements of excise products in Belgium the excise product code is needed to correctly construct the excise register.", "nullable": true }, "density": { "type": "number", "description": "The Density as ingested or indicated by a user,\r\nWhich can then be used to calculate an additional quantity and to be taken over in subsequent outbound EMCS movements\r\nOnly used for IN lines: result of a production or positive stock adjustment", "format": "double", "nullable": true }, "asv": { "type": "number", "description": "Alcohol % by volume, sometimes also abbreviated as ABV\r\nApplicable in case of production of an alcoholic product.", "format": "double", "nullable": true }, "preferentialOriginCountry": { "type": "string", "description": "The preferential origin country of a good being produced.\r\nMay be provided in the IN movement line for PROC, UFOH and ADJP movement types", "nullable": true }, "nonPreferentialOriginCountry": { "type": "string", "description": "The non-preferential origin country of a good being produced.\r\nMay be provided in the IN movement line for PROC, UFOH and ADJP movement types", "nullable": true }, "quantities": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "type": "number", "description": "Quantity of the item in a given UoM", "format": "double" }, "uom": { "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" } }, "xml": { "name": "quantity" } }, "description": "Quantities", "nullable": true, "xml": { "wrapped": true } }, "blendResult": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementLineBlendResult" } }, "xml": { "name": "movementLine" } }, "description": "The item level data of the movement", "xml": { "wrapped": true } }, "movementType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementType" }, "category": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementCategory" }, "remark": { "maxLength": 255, "type": "string", "description": "If used for a tax warehouse stock correction, it will be shown in column '7. Remarks' of the excise register", "nullable": true }, "movementAdjustmentData": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementAdjustmentData" } }, "xml": { "name": "movement" } }, "description": "The header level data of the movement", "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "The root of the request" }, "Cas.Ingestions.Models.Movement.V1.MovementLine": { "required": [ "direction", "itemDescription", "itemId", "quantity", "serialBatchReference", "storageLocationReference", "uom" ], "type": "object", "properties": { "itemId": { "minLength": 1, "type": "string", "description": "Unique identifier of the item/material as defined in master data" }, "itemDescription": { "minLength": 1, "type": "string", "description": "An optional description for the item. Will be displayed in stock and movement views.\r\nIf not provided, CAS will deduct it from Master Data." }, "direction": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.Direction" }, "serialBatchReference": { "minLength": 1, "type": "string", "description": "Unique serial or batch number of the item" }, "quantity": { "type": "number", "description": "Quantity of the item in the base unit of measure as defined in master data", "format": "double" }, "uom": { "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined.\r\n\r\nMain used codes:\r\n- DTN: Hectokilogram\r\n- HLT: Hectolitre\r\n- KGM: Kilogram\r\n- LPA: Litre pure (100%) alcohol\r\n- LTR: Litre\r\n- L15: Litres at 15 °C\r\n- L20: Litres at 20 °C\r\n- MTK: Square metre\r\n- NAR: Piece\r\n- 101: Hectolitres pure alcohol at 20 °C\r\n- 102: 1.000 litres at 15 °C\r\n- KGV: KGM Vacuum" }, "storageLocationReference": { "minLength": 1, "type": "string", "description": "Storage location reference (as known in CAS)" }, "receivingStorageLocationReference": { "type": "string", "description": "For transfer movements (TRFA, TRFR)\r\nMandatory for TRFR", "nullable": true }, "receivingAuthorizationId": { "type": "string", "description": "For transfer movement between authorizations (TRFA)\r\nMandatory for TRFA", "nullable": true }, "stockRecordId": { "type": "integer", "description": "Stock record id, only used for movements initiated by CAS UI", "format": "int64", "nullable": true }, "authorisationId": { "type": "string", "description": "Deprecated, replaced by AuthorizationId", "nullable": true, "deprecated": true }, "authorizationId": { "type": "string", "description": "For transfer movements (TRFA, TRFR)\r\nMandatory for movement type TRFA, and when there are multiple special procedure and/or tax warehouse authorisations on the storage location", "nullable": true }, "exciseProductCode": { "type": "string", "description": "Excise Product code.\r\nIf not provided CAS will try to deduct it from Item Master Data.\r\n\r\nSome example codes:\r\n- B000: Beer\r\n- E300: Mineral oils\r\n- S300: Ethyl alcohol\r\n- W300: Sparkling wine\r\n\r\nFor movements of excise products in Belgium the excise product code is needed to correctly construct the excise register.", "nullable": true }, "density": { "type": "number", "description": "The Density as ingested or indicated by a user,\r\nWhich can then be used to calculate an additional quantity and to be taken over in subsequent outbound EMCS movements\r\nOnly used for IN lines: result of a production or positive stock adjustment", "format": "double", "nullable": true }, "asv": { "type": "number", "description": "Alcohol % by volume, sometimes also abbreviated as ABV\r\nApplicable in case of production of an alcoholic product.", "format": "double", "nullable": true }, "preferentialOriginCountry": { "type": "string", "description": "The preferential origin country of a good being produced.\r\nMay be provided in the IN movement line for PROC, UFOH and ADJP movement types", "nullable": true }, "nonPreferentialOriginCountry": { "type": "string", "description": "The non-preferential origin country of a good being produced.\r\nMay be provided in the IN movement line for PROC, UFOH and ADJP movement types", "nullable": true }, "quantities": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "type": "number", "description": "Quantity of the item in a given UoM", "format": "double" }, "uom": { "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" } }, "xml": { "name": "quantity" } }, "description": "Quantities", "nullable": true, "xml": { "wrapped": true } }, "blendResult": { "$ref": "#/components/schemas/Cas.Ingestions.Models.Movement.V1.MovementLineBlendResult" } }, "additionalProperties": false }, "Cas.Ingestions.Models.Movement.V1.MovementLineBlendResult": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Unique identifier of the item/material as defined in master data that will be the result of a TRFB (Transfer + Blend) movement", "nullable": true }, "exciseProductCode": { "type": "string", "description": "Excise Product code.\r\nIf not provided CAS will try to deduct it from Resulting Item Master Data.\r\n\r\nSome example codes:\r\nB000: Beer\r\nE300: Mineral oils\r\nS300: Ethyl alcohol\r\nW300: Sparkling wine\r\n…\r\n\r\nFor TRFB movements of excise products in Belgium the resulting excise product code is needed to correctly construct the excise register.", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the result of a TRFB (Transfer + Blend) movement", "nullable": true } }, "additionalProperties": false }, "Cas.Ingestions.Models.Movement.V1.MovementLineQuantity": { "required": [ "quantity", "uom" ], "type": "object", "properties": { "quantity": { "type": "number", "description": "Quantity of the item in a given UoM", "format": "double" }, "uom": { "minLength": 1, "type": "string", "description": "Unit of measure in which the quantity is defined" } }, "additionalProperties": false }, "Cas.Ingestions.Models.Movement.V1.MovementType": { "enum": [ "UNKNOWN", "PROC", "UFOH", "ADJP", "ADJN", "TRFA", "TRFR", "TRFB", "INVD", "DCSV", "RFFC" ], "type": "string", "description": "

Possible values:

", "example": "UNKNOWN" }, "Cas.Ingestions.Models.Shipment.V1.Shipment": { "required": [ "direction", "externalReference", "singleAdministrativeDocument", "storageLocationReference" ], "type": "object", "properties": { "customsFlow": { "type": "string", "description": "Code that determines the flow that needs to be executed", "nullable": true }, "direction": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment-DirectionEnum" }, "expectedDateTimeOfMovement": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "externalReference": { "maxLength": 64, "minLength": 1, "type": "string", "description": "Unique reference to identify the customs shipment" }, "excludeInShipmentOverview": { "type": "boolean", "description": "Determines whether the shipment needs to be shown on the shipment overview screen", "nullable": true }, "messageType": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.CustomsShipment-MessageTypeEnum" }, "storageLocationReference": { "minLength": 1, "type": "string", "description": "Storage location code (as known in CAS) from where an OUT customs shipment leaves or an IN customs shipment arrives" }, "version": { "type": "string", "description": "1.0", "nullable": true }, "singleAdministrativeDocument": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.SingleAdministrativeDocument" }, "sourceSysRef": { "type": "string", "nullable": true }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "description": "Gets or sets Metadata key", "nullable": true }, "value": { "type": "string", "description": "Gets or sets Metadata value", "nullable": true } }, "xml": { "name": "metadat" } }, "description": "Arbitrary custom attributes of a customs shipment, which leverage more sophisticated customs shipments or declarations lookup", "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsShipment": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Excise.ExciseGoodsShipment" }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type that determines the kind of file that is attached.", "nullable": true, "example": "invoice" }, "complementaryInformation": { "type": "string", "description": "The type that determine additional information that complements the attachment type.", "nullable": true, "example": "Commercial invoice for goods declaration" }, "contentType": { "type": "string", "description": "The media type of the provided content must be application/pdf.", "nullable": true, "example": "application/pdf" }, "fileName": { "type": "string", "description": "The original file name of the attachment, typically used for display purposes in declaration details.", "nullable": true, "example": "sample-invoice.pdf" }, "content": { "type": "string", "description": "The binary content of the attachment.", "format": "byte", "nullable": true, "example": "JVBERi0xLjQNCjEgMCBvYmo8PC9UeXBlL0NhdGFsb2cvUGFnZXMgMiAwIFI+PmVuZG9iaiAyIDAgb2JqPDwvVHlwZS9QYWdlcy9Db3VudCAxL0tpZHNbMyAwIFJdPj5lbmRvYmogMyAwIG9iajw8L1R5cGUvUGFnZS9QYXJlbnQgMiAwIFIvTWVkaWFCb3hbMCAwIDYxMiA3OTJdL0NvbnRlbnRzIDQgMCBSPj5lbmRvYmogNCAwIG9iajw8L0xlbmd0aCA1NT4+c3RyZWFtDQpCVA0KL0YxIDE0IFRmDQo1MCA3NTAgVGQNCihDT01NRVJDSUFMIElOVk9JQ0UgLSBTQU1QTEUpVGoNCkVUDQplbmRzdHJlYW0NCmVuZG9iag0KeHJlZg0KMCA1DQowMDAwMDAwMDAwIDY1NTM1IGYNCjAwMDAwMDAwMDkgMDAwMDAgbg0KMDAwMDAwMDA1OCAwMDAwMCBuDQowMDAwMDAwMTE1IDAwMDAwIG4NCjAwMDAwMDAyMTQgMDAwMDAgbg0KdHJhaWxlcjw8L1NpemUgNS9Sb290IDEgMCBSPj4NCnN0YXJ0eHJlZg0KMzE4DQolJUVPRg==" } }, "xml": { "name": "attachment" } }, "nullable": true, "xml": { "wrapped": true } }, "options": { "$ref": "#/components/schemas/Cas.Ingestions.Models.CustomsShipment.V1.Options" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ChangeDestinationParameters": { "type": "object", "properties": { "invoice": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.Invoice" }, "exciseGoodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ExciseGoodsShipment" } }, "additionalProperties": false, "description": "Change of destination action parameters" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.ExciseGoodsShipment": { "type": "object", "properties": { "headerEadEsad": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.HeaderEadEsad" }, "transportMode": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.TransportMode" }, "consigneeTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "deliveryPlaceTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "transportDetails": { "type": "array", "items": { "type": "object", "properties": { "commercialSealIdentification": { "type": "string", "description": "Commercial seal identification", "nullable": true }, "complementaryInformation": { "type": "string", "description": "Complementary information", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "description": "Complementary information language", "nullable": true }, "identityOfTransportUnits": { "type": "string", "description": "Identity of transport units", "nullable": true }, "sealInformation": { "type": "string", "description": "Seal information", "nullable": true }, "sealInformationLanguage": { "type": "string", "description": "Seal information language", "nullable": true }, "transportUnitCode": { "type": "integer", "description": "Transport unit code", "format": "int32", "nullable": true } }, "xml": { "name": "transportDetail" } }, "description": "Transport details", "nullable": true, "xml": { "wrapped": true } }, "movementGuarantee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.MovementGuarantee" }, "deliveryPlaceCustomsOfficeCode": { "type": "string", "description": "Delivery place customs office code", "nullable": true } }, "additionalProperties": false, "description": "Excise goods shipment details for the change of destination action" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.HeaderEadEsad": { "type": "object", "properties": { "destinationTypeCode": { "type": "integer", "description": "Destination type code", "format": "int32", "nullable": true }, "journeyTime": { "type": "string", "description": "Journey time", "nullable": true } }, "additionalProperties": false, "description": "Header EAD/ESAD details for the change of destination action" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.Invoice": { "type": "object", "properties": { "date": { "type": "string", "description": "Invoice date", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "number": { "type": "string", "description": "Invoice number", "nullable": true } }, "additionalProperties": false, "description": "Invoice details for the change of destination action" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.MovementGuarantee": { "type": "object", "properties": { "guarantorTypeCode": { "type": "integer", "description": "Guarantor type code", "format": "int32", "nullable": true }, "guarantorTraders": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Business partner unique identifier (format: an..16) (cardinality: 1x)", "nullable": true }, "name": { "maxLength": 70, "type": "string", "description": "Business partner name (format: an..70) (cardinality: 1x)", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerContact" }, "businessPartnerReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number) (format: an.17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "businessPartnerReference" } }, "description": "(format: BusinessPartner.BusinessPartnerReference) (cardinality: 9x)", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "guarantorTrader" } }, "description": "Guarantor traders", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Movement guarantee details for the change of destination action" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.TransportDetail": { "type": "object", "properties": { "commercialSealIdentification": { "type": "string", "description": "Commercial seal identification", "nullable": true }, "complementaryInformation": { "type": "string", "description": "Complementary information", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "description": "Complementary information language", "nullable": true }, "identityOfTransportUnits": { "type": "string", "description": "Identity of transport units", "nullable": true }, "sealInformation": { "type": "string", "description": "Seal information", "nullable": true }, "sealInformationLanguage": { "type": "string", "description": "Seal information language", "nullable": true }, "transportUnitCode": { "type": "integer", "description": "Transport unit code", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Transport detail for the change of destination action" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ChangeOfDestination.TransportMode": { "type": "object", "properties": { "complementaryInformation": { "type": "string", "description": "Complementary information", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "description": "Complementary information language", "nullable": true }, "transportModeCode": { "type": "integer", "description": "Transport mode code", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "Transport mode details for the change of destination action" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.BodyAnalysis": { "type": "object", "properties": { "explanation": { "type": "string", "description": "Explanation text for this goods item", "nullable": true }, "explanationLanguage": { "type": "string", "description": "Explanation language", "nullable": true }, "actualQuantity": { "type": "number", "description": "Actual quantity", "format": "double", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationAnalysis": { "required": [ "globalExplanation" ], "type": "object", "properties": { "globalExplanation": { "minLength": 1, "type": "string", "description": "Global explanation text" }, "globalExplanationLanguage": { "type": "string", "description": "Global explanation language", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationExciseGoodsItem": { "type": "object", "properties": { "bodyAnalysis": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.BodyAnalysis" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationExciseGoodsShipment": { "type": "object", "properties": { "analysis": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationAnalysis" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationGovernmentAgencyGoodsItem": { "type": "object", "properties": { "casReference": { "type": "string", "description": "CAS reference for the goods item", "nullable": true }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationExciseGoodsItem" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationParameters": { "type": "object", "properties": { "exciseGoodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationExciseGoodsShipment" }, "governmentAgencyGoodsItems": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "description": "CAS reference for the goods item", "nullable": true }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ComplementaryExplanation.ComplementaryExplanationExciseGoodsItem" } }, "xml": { "name": "governmentAgencyGoodsItem" } }, "description": "Government agency goods items", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Complementary explanation action parameters" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.DelayForDelivery.DelayForDeliveryParameters": { "required": [ "explanationCode" ], "type": "object", "properties": { "explanationCode": { "minLength": 1, "type": "string", "description": "Explanation code for the delay" }, "messageRole": { "type": "string", "description": "Message role", "nullable": true }, "complementaryInformation": { "type": "string", "description": "Complementary information", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "description": "Complementary information language", "nullable": true } }, "additionalProperties": false, "description": "Delay for delivery action parameters" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.Invalidation.InvalidationParameters": { "type": "object", "properties": { "reason": { "type": "string", "description": "The reason the declaration needs to be invalidated", "nullable": true } }, "additionalProperties": false, "description": "Invalidation action parameters" }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.BodyReportOfReceipt": { "type": "object", "properties": { "indicatorOfShortageOrExcess": { "type": "string", "nullable": true }, "observedShortageOrExcess": { "type": "number", "format": "double", "nullable": true }, "exciseProductCode": { "type": "string", "nullable": true }, "refusedQuantity": { "type": "number", "format": "double", "nullable": true }, "unsatisfactoryReasons": { "type": "array", "items": { "type": "object", "properties": { "unsatisfactoryReasonCode": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "nullable": true } }, "xml": { "name": "unsatisfactoryReason" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ExciseGoodsItem": { "type": "object", "properties": { "bodyReportOfReceipt": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.BodyReportOfReceipt" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ExciseGoodsShipment": { "type": "object", "properties": { "destinationOfficeCode": { "type": "string", "nullable": true }, "exciseMovement": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ExciseMovement" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ExciseMovement": { "type": "object", "properties": { "reportOfReceipt": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReportOfReceipt" }, "internalReference": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReceiptReportParameters": { "type": "object", "properties": { "exciseGoodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ExciseGoodsShipment" }, "governmentAgencyGoodsItems": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.SADGSGagiCommodity" }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ExciseGoodsItem" } }, "xml": { "name": "governmentAgencyGoodsItem" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ReportOfReceipt": { "type": "object", "properties": { "dateOfArrivalOfExciseProducts": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "globalConclusionOfReceipt": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.SADGSGagiCommodity": { "type": "object", "properties": { "itemId": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.SADGSGovernmentAgencyGoodsItem": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.SADGSGagiCommodity" }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.ExciseGoodsItem" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.ReceiptReport.UnsatisfactoryReason": { "type": "object", "properties": { "unsatisfactoryReasonCode": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.ActionParameters.RejectOrAlertEad.RejectOrAlertEadParameters": { "required": [ "alertOrRejectionOfMovementReasonCode", "destinationOfficeCode", "eadEsadRejectedFlag" ], "type": "object", "properties": { "destinationOfficeCode": { "minLength": 1, "type": "string", "description": "Destination office code" }, "eadEsadRejectedFlag": { "type": "boolean", "description": "Flag indicating if the EAD/ESAD is rejected" }, "alertOrRejectionOfMovementReasonCode": { "minLength": 1, "type": "string", "description": "Alert or rejection of movement reason code.\r\nValid values: 0 = Other, 1 = The received e-AD/e-SAD does not concern the recipient, 2 = The excise product(s) does(do) not match with the order, 3 = The quantity(ies) does(do) not match with the order" }, "complementaryInformation": { "type": "string", "description": "Complementary information", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "description": "Complementary information language", "nullable": true } }, "additionalProperties": false, "description": "Reject or alert EAD action parameters" }, "Cas.Public.Api.Contract.Declarations.DeclarationPointers": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "externalReference": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "docRefNum": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "functionRefNum": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "arc": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "customsFlow": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "customsFlowStep": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "ucr": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "creationDate": { "type": "string", "description": "(cardinality: 1x)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lastUpdated": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "currentStatus": { "type": "string", "description": "(cardinality: 1x)", "nullable": true } }, "xml": { "name": "dat" } }, "description": "(cardinality: 1x)", "nullable": true, "xml": { "wrapped": true } }, "links": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.DeclarationPointersLinks" } }, "additionalProperties": false, "description": "DeclarationPointers" }, "Cas.Public.Api.Contract.Declarations.DeclarationPointersData": { "type": "object", "properties": { "id": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "externalReference": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "docRefNum": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "functionRefNum": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "arc": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "customsFlow": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "customsFlowStep": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "ucr": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "creationDate": { "type": "string", "description": "(cardinality: 1x)", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lastUpdated": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "currentStatus": { "type": "string", "description": "(cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "DeclarationPointerLinks" }, "Cas.Public.Api.Contract.Declarations.DeclarationPointersLinks": { "type": "object", "properties": { "self": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "prev": { "type": "string", "description": "(cardinality: 1x)", "nullable": true }, "next": { "type": "string", "description": "(cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "DeclarationPointerLinks" }, "Cas.Public.Api.Contract.Declarations.Detail.AdditionalReference": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "id": { "type": "string", "description": "Id (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "type": "string", "description": "TypeCode (format: an..4) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "AdditionalReference" }, "Cas.Public.Api.Contract.Declarations.Detail.Attachment": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "creationDate": { "type": "string", "format": "date-time", "example": "2024-01-15T09:30:00Z" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Business partner unique identifier (format: an..16) (cardinality: 1x)", "nullable": true }, "name": { "maxLength": 70, "type": "string", "description": "Business partner name (format: an..70) (cardinality: 1x)", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerContact" }, "businessPartnerReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number) (format: an.17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "businessPartnerReference" } }, "description": "(format: BusinessPartner.BusinessPartnerReference) (cardinality: 9x)", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "BusinessPartner" }, "Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerAddress": { "type": "object", "properties": { "box": { "maxLength": 16, "type": "string", "description": "Business partner address box (format: an..16) (cardinality: 1x)", "nullable": true }, "city": { "maxLength": 50, "type": "string", "description": "Business partner address city (format: an..35) (cardinality: 1x)", "nullable": true }, "country": { "type": "string", "description": "Country (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "number": { "maxLength": 16, "type": "string", "description": "Business partner address number (format: an..16) (cardinality: 1x)", "nullable": true }, "region": { "maxLength": 16, "type": "string", "description": "Country subdivision of region (format: an..16) (cardinality: 1x)", "nullable": true }, "street": { "maxLength": 512, "type": "string", "description": "Business partner address street (format: an..70) (cardinality: 1x)", "nullable": true }, "zipCode": { "maxLength": 17, "type": "string", "description": "Business partner address zipCode (format: an..9) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "BusinessPartnerAddress" }, "Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerBusinessPartnerReference": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number) (format: an.17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN) (format: an..4) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "BusinessPartnerBusinessPartnerReference" }, "Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerContact": { "type": "object", "properties": { "emailAddress": { "maxLength": 64, "type": "string", "description": "Business partner contact - email address (format: an..64) (cardinality: 1x)", "nullable": true }, "faxNumber": { "maxLength": 64, "type": "string", "description": "Business partner contact - fax number (format: an..64) (cardinality: 1x)", "nullable": true }, "phoneNumber": { "maxLength": 64, "type": "string", "description": "Business partner contact - phone number (format: an..64) (cardinality: 1x)", "nullable": true }, "spocName": { "maxLength": 128, "type": "string", "description": "Business partner contact - spoc name (format: an..128) (cardinality: 1x)", "nullable": true }, "language": { "type": "string", "description": "Business partner contact - language (format: a..2) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "BusinessPartnerContact" }, "Cas.Public.Api.Contract.Declarations.Detail.Declaration": { "type": "object", "properties": { "version": { "type": "string", "description": "(format: an..16) (cardinality: 1x)", "nullable": true }, "customsShipmentExternalReference": { "type": "string", "description": "Unique reference to identify the customs shipment (format: an..35) (cardinality: 1x)", "nullable": true }, "casShipmentReference": { "type": "string", "description": "CAS reference to identify the customs shipment (format: an..38) (cardinality: 1x)", "nullable": true }, "casStorageLocationReference": { "type": "string", "description": "CAS reference to identify the customs shipment storage location (format: an..38) (cardinality: 1x)", "nullable": true }, "creationDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "customsFlow": { "type": "string", "description": "Customs Flow (format: an..35) (cardinality: 1x)", "nullable": true }, "customsFlowStep": { "type": "string", "description": "Customs Flow Step (format: an..35) (cardinality: 1x)", "nullable": true }, "jurisdiction": { "type": "string", "description": "Jurisdiction (format: an..3) (cardinality: 1x)", "nullable": true }, "singleAdministrativeDocument": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SingleAdministrativeDocument" }, "storageLocationReference": { "type": "string", "description": "Storage Location Reference (format: an..35) (cardinality: 1x)", "nullable": true }, "direction": { "type": "string", "description": "Direction (format: an..3) (cardinality: 1x)", "nullable": true }, "errors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "fieldReferences": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true } }, "xml": { "name": "fieldReference" } }, "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "error" } }, "description": "Validation errors encountered for this declaration. Only returned when ```include=errors``` is provided as querystring parameter on the request.", "nullable": true, "xml": { "wrapped": true } }, "metadata": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "xml": { "name": "metadat" } }, "nullable": true, "xml": { "wrapped": true } }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "nullable": true }, "fileName": { "type": "string", "nullable": true }, "contentType": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "creationDate": { "type": "string", "format": "date-time", "example": "2024-01-15T09:30:00Z" } }, "xml": { "name": "attachment" } }, "description": "Attachments generated for this declaration, typically PDFs. Only returned when ```include=attachments``` is provided as querystring parameter on the request.", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Declaration" }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.BodyReportOfReceipt": { "type": "object", "properties": { "indicatorOfShortageOrExcess": { "type": "string", "nullable": true }, "observedShortageOrExcess": { "type": "number", "format": "double", "nullable": true }, "exciseProductCode": { "type": "string", "nullable": true }, "refusedQuantity": { "type": "number", "format": "double", "nullable": true }, "unsatisfactoryReasons": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "unsatisfactoryReasonCode": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "nullable": true } }, "xml": { "name": "unsatisfactoryReason" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.ComplementConsigneeTrader": { "type": "object", "properties": { "memberStateCode": { "maxLength": 2, "type": "string", "nullable": true }, "serialNumberOfCertificateOfExemption": { "maxLength": 255, "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.DocumentCertificate": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "documentType": { "maxLength": 4, "type": "string", "nullable": true }, "documentReference": { "maxLength": 35, "type": "string", "nullable": true }, "documentDescription": { "maxLength": 350, "type": "string", "nullable": true }, "documentDescriptionLanguage": { "maxLength": 2, "type": "string", "nullable": true }, "referenceOfDocument": { "maxLength": 350, "type": "string", "nullable": true }, "referenceOfDocumentLanguage": { "maxLength": 2, "type": "string", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "issuingAuthority": { "maxLength": 50, "type": "string", "description": "Authority that issued the document/certificate (format: an..50) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.EadEsad": { "type": "object", "properties": { "originTypeCode": { "type": "integer", "format": "int32", "nullable": true }, "dateTimeOfDispatch": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "importSads": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "importSadNumber": { "type": "string", "nullable": true } }, "xml": { "name": "importSad" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseGoodsItem": { "type": "object", "properties": { "quantity": { "type": "number", "format": "double", "nullable": true }, "uom": { "type": "string", "nullable": true }, "alcoholicStrengthByVolumeInPercentage": { "type": "number", "format": "double", "nullable": true }, "degreePlato": { "type": "number", "format": "double", "nullable": true }, "fiscalMark": { "type": "string", "nullable": true }, "fiscalMarkLanguage": { "type": "string", "nullable": true }, "fiscalMarkUsedFlag": { "type": "integer", "format": "int32", "nullable": true }, "designationOfOrigin": { "type": "string", "nullable": true }, "designationOfOriginLanguage": { "type": "string", "nullable": true }, "sizeOfProducer": { "type": "integer", "format": "int32", "nullable": true }, "density": { "type": "number", "format": "double", "nullable": true }, "commercialDescription": { "type": "string", "nullable": true }, "commercialDescriptionLanguage": { "type": "string", "nullable": true }, "brandNameOfProducts": { "type": "string", "nullable": true }, "brandNameOfProductsLanguage": { "type": "string", "nullable": true }, "maturationPeriodOrAgeOfProducts": { "type": "string", "nullable": true }, "maturationPeriodOrAgeOfProductsLanguage": { "type": "string", "nullable": true }, "independentSmallProducersDeclaration": { "type": "string", "nullable": true }, "independentSmallProducersDeclarationLanguage": { "type": "string", "nullable": true }, "wineProduct": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.WineProduct" }, "bodyReportOfReceipt": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.BodyReportOfReceipt" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseGoodsShipment": { "type": "object", "properties": { "submissionMessageType": { "type": "integer", "format": "int32", "nullable": true }, "deferredSubmissionFlag": { "type": "integer", "format": "int32", "nullable": true }, "exciseMovement": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseMovement" }, "consigneeTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "consignorTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "placeOfDispatchTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "dispatchImportOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "destinationOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "deliveryPlaceTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "deliveryPlaceCustomsOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "competentAuthorityDispatchOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "transportArrangerTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "firstTransporterTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "complementConsigneeTrader": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.ComplementConsigneeTrader" }, "transportDetails": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "transportUnitCode": { "type": "integer", "format": "int32", "nullable": true }, "identityOfTransportUnits": { "maxLength": 35, "type": "string", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "complementaryInformation": { "maxLength": 350, "type": "string", "nullable": true }, "complementaryInformationLanguage": { "maxLength": 2, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "maxLength": 2, "type": "string", "nullable": true } }, "xml": { "name": "transportDetail" } }, "nullable": true, "xml": { "wrapped": true } }, "documentCertificates": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "documentType": { "maxLength": 4, "type": "string", "nullable": true }, "documentReference": { "maxLength": 35, "type": "string", "nullable": true }, "documentDescription": { "maxLength": 350, "type": "string", "nullable": true }, "documentDescriptionLanguage": { "maxLength": 2, "type": "string", "nullable": true }, "referenceOfDocument": { "maxLength": 350, "type": "string", "nullable": true }, "referenceOfDocumentLanguage": { "maxLength": 2, "type": "string", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "issuingAuthority": { "maxLength": 50, "type": "string", "description": "Authority that issued the document/certificate (format: an..50) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "documentCertificate" } }, "nullable": true, "xml": { "wrapped": true } }, "headerEadEsad": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.HeaderEadEsad" }, "transportMode": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.TransportMode" }, "movementGuarantee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.MovementGuarantee" }, "EadEsad": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.EadEsad" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseMovement": { "type": "object", "properties": { "administrativeReferenceCode": { "maxLength": 21, "type": "string", "nullable": true }, "consignorFunctionRefNum": { "type": "string", "nullable": true }, "internalReference": { "type": "string", "nullable": true }, "dateAndTimeOfValidationOfEadEsad": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "dateOfArrivalOfExciseProducts": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "reportOfReceipt": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.ReportOfReceipt" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.HeaderEadEsad": { "type": "object", "properties": { "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "destinationTypeCode": { "type": "integer", "format": "int32", "nullable": true }, "journeyTime": { "maxLength": 3, "type": "string", "nullable": true }, "transportArrangement": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.ImportSad": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "importSadNumber": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.MovementGuarantee": { "type": "object", "properties": { "guarantorTypeCode": { "type": "integer", "format": "int32", "nullable": true }, "guarantorTraders": { "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Business partner unique identifier (format: an..16) (cardinality: 1x)", "nullable": true }, "name": { "maxLength": 70, "type": "string", "description": "Business partner name (format: an..70) (cardinality: 1x)", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerContact" }, "businessPartnerReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number) (format: an.17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "businessPartnerReference" } }, "description": "(format: BusinessPartner.BusinessPartnerReference) (cardinality: 9x)", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "guarantorTrader" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.ReportOfReceipt": { "type": "object", "properties": { "dateOfArrivalOfExciseProducts": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "globalConclusionOfReceipt": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.TransportDetails": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "transportUnitCode": { "type": "integer", "format": "int32", "nullable": true }, "identityOfTransportUnits": { "maxLength": 35, "type": "string", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "complementaryInformation": { "maxLength": 350, "type": "string", "nullable": true }, "complementaryInformationLanguage": { "maxLength": 2, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "maxLength": 2, "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.TransportMode": { "type": "object", "properties": { "transportModeCode": { "type": "integer", "format": "int32", "nullable": true }, "complementaryInformation": { "maxLength": 350, "type": "string", "nullable": true }, "complementaryInformationLanguage": { "maxLength": 2, "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.UnsatisfactoryReason": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "unsatisfactoryReasonCode": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "complementaryInformationLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.WineOperation": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "wineOperationCode": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Excise.WineProduct": { "type": "object", "properties": { "wineProductCategory": { "type": "integer", "format": "int32", "nullable": true }, "wineGrowingZoneCode": { "type": "integer", "format": "int32", "nullable": true }, "thirdCountryOfOrigin": { "type": "string", "nullable": true }, "otherInformation": { "type": "string", "nullable": true }, "otherInformationLanguage": { "type": "string", "nullable": true }, "wineOperations": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "wineOperationCode": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "wineOperation" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Header.SADGoodsShipmentEditable": { "type": "object", "properties": { "exportCountry": { "type": "string", "description": "Country Of Dispatch/Export (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "trxNatCode": { "type": "integer", "description": "This data element can only be given once, either on header level or on item level. (format: n..2) (cardinality: 1X)", "format": "int32", "nullable": true }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "consignment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignment" }, "consignor": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "customsValuation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSCustomsValuation" }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSDestination" }, "domesticDutyTaxParties": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "identification": { "type": "string", "description": "To identify a party responsible for the national VAT or Goods & Services Tax (format: an..17) (cardinality: 1x)", "nullable": true }, "roleCode": { "type": "string", "description": "VAT-related fiscal references: FR1 (importer), FR2 (customer), FR3 (tax representative), FR4 (holder of the deferred payment authorisation) (format: an..3) (cardinality: 1x)", "nullable": true }, "code": { "type": "string", "description": "Business partner unique identifier (format: an..16) (cardinality: 1x)", "nullable": true }, "name": { "type": "string", "description": "Business partner name (format: an..70) (cardinality: 1x)", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerContact" }, "businessPartnerReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number) (format: an.17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "businessPartnerReference" } }, "description": "(format: BusinessPartner.BusinessPartnerReference) (cardinality: 9x)", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "domesticDutyTaxParty" } }, "description": "(format: SAD.GS.DomesticDutyTaxParty) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "exporter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "seller": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "surety": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSSurety" }, "tradeTerms": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSTradeTerms" }, "ucr": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSUcr" }, "warehouse": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSWarehouse" }, "elo": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSElo" }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "id": { "type": "string", "description": "Id (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "type": "string", "description": "TypeCode (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalReference" } }, "description": "(format: AdditionalReference) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "exportRegion": { "type": "string", "description": "(format: SAD.GS.ExportRegion) (cardinality: 1x)", "nullable": true }, "exitDateTime": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "invoice": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSInvoice" } }, "additionalProperties": false, "description": "(cardinality: 1x)" }, "Cas.Public.Api.Contract.Declarations.Detail.Header.SingleAdministrativeDocumentEditable": { "type": "object", "properties": { "goodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Header.SADGoodsShipmentEditable" }, "accDateCode": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "addDeclType1": { "maxLength": 5, "type": "string", "nullable": true }, "addDeclType2": { "maxLength": 5, "type": "string", "nullable": true }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "type": "string", "description": "Coded form of an additional statement (format: an..17) (cardinality: 1x)", "nullable": true }, "text": { "type": "string", "description": "Description of an additional statement (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Additional statement type (format: an..3) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "description": "CAS internal reference", "nullable": true }, "category": { "type": "string", "description": "Additional document category", "nullable": true }, "issueDate": { "type": "string", "description": "The issue date for XML serialization", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "type": "string", "description": "Additional document status code", "nullable": true }, "refNum": { "type": "string", "description": "Identifier of a document providing additional information", "nullable": true }, "type": { "type": "string", "description": "Additional document type", "nullable": true }, "submitter": { "type": "string", "description": "Document submitter name", "nullable": true } }, "xml": { "name": "additionalDocument" } }, "nullable": true, "xml": { "wrapped": true }, "example": [ { "category": "C", "type": "ABC", "refNum": "DOC-2024-001", "lpcoExemptionCode": "AE", "issueDate": "2024-01-15T09:30:00Z", "name": "Import License" }, { "type": "ABCD", "refNum": "DOC-2024-002", "lpcoExemptionCode": "XX", "issueDate": "2024-01-15T09:30:00Z", "name": "Certificate of Origin" } ] }, "additionalParties": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "partyType": { "type": "string", "description": "Type of the additional party (format: an..3) (cardinality: 1x)", "nullable": true }, "party": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalPartyParty" } }, "xml": { "name": "additionalParty" } }, "nullable": true, "xml": { "wrapped": true } }, "agentStatus": { "type": "integer", "format": "int32", "nullable": true }, "declarationOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "declType": { "maxLength": 2, "type": "string", "nullable": true }, "destinationOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "docRefNum": { "maxLength": 35, "type": "string", "nullable": true }, "crn": { "type": "string", "nullable": true }, "entryOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "exitOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "invoiceCurrency": { "maxLength": 3, "pattern": "^[A-Za-z]*$", "type": "string", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "loadingDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "presentationDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "issuePlaceCode": { "maxLength": 35, "type": "string", "nullable": true }, "pointOfExit": { "maxLength": 64, "type": "string", "nullable": true }, "pointOfEntry": { "maxLength": 64, "type": "string", "nullable": true }, "presentationOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "supervisingOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "totalInvoiceAmount": { "type": "number", "format": "double", "nullable": true }, "agent": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADCurrencyExchange" }, "declarant": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "importer": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "packaging": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADPackaging" }, "referenceNumbers": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "number": { "type": "string", "description": "Reference number (format: an..35) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Reference type (format: an..15) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "referenceNumber" } }, "nullable": true, "xml": { "wrapped": true } }, "authorizationHolders": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "categoryCode": { "type": "string", "description": "Category code of an authorization holder (format: an..38) (cardinality: 1x)", "nullable": true }, "reference": { "type": "string", "description": "Reference of an authorization holder (format: an..35) (cardinality: 1x)", "nullable": true }, "identifier": { "type": "string", "description": "Identifier of an authorization holder (format: an..35) (cardinality: 1x)", "nullable": true }, "authorizationId": { "type": "string", "description": "Authorization Id of an authorization holder (format: an..17) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "authorizationHolder" } }, "nullable": true, "xml": { "wrapped": true } }, "controlResult": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADControlResult" }, "obligationGuarantee": { "allOf": [ { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADObligationGuarantee" } ], "description": "DEPRECATED - Use obligationGuarantees instead.", "deprecated": true }, "obligationGuarantees": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "access": { "type": "string", "description": "Access (format: an..4) (cardinality: 1x)", "nullable": true }, "reference": { "type": "string", "description": "Reference (format: an..64) (cardinality: 1x)", "nullable": true }, "securityDetails": { "type": "string", "description": "Guarantee type (format: an..16) (cardinality: 1x)", "nullable": true }, "amount": { "type": "number", "description": "amount (format: decimal) (cardinality: 1x)", "format": "double", "nullable": true }, "excludedCountries": { "type": "array", "items": { "type": "string", "xml": { "name": "excludedCountry" } }, "description": "Excluded countries (format: a..2) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "declarationOffice": { "type": "string", "description": "Declaration office (format: an..8) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "obligationGuarantee" } }, "nullable": true, "xml": { "wrapped": true } }, "exportOfficeCode": { "maxLength": 17, "type": "string", "nullable": true }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "billOfLoading": { "type": "string", "description": "Bill of loading (format: an..70) (cardinality: 1x)", "nullable": true }, "category": { "type": "string", "description": "Category of the document (format: an..2) (cardinality: 1x)\r\nThe declaration for temporary storage represented by ‘X’\r\nThe simplified declaration or the entry in the declarant’s records, represented by ‘Y’\r\nThe previous document, represented by ‘Z’", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "number": { "type": "string", "description": "The reference number of a previous document (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Type of document used for declaration previously presented (format: an..3) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseGoodsShipment" }, "transitProcedure": { "maxLength": 5, "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGagiCommodityEditable": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "isBonded": { "type": "boolean", "nullable": true }, "itemId": { "type": "string", "nullable": true }, "storageLocationReference": { "type": "string", "nullable": true }, "receivingStorageLocationReference": { "type": "string", "nullable": true }, "receivingAuthorizationId": { "type": "string", "nullable": true }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "type": "string", "description": "Classification code (format: an..10) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Classification type (e.g. TARIC) (format: an..32) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "classification" } }, "nullable": true, "xml": { "wrapped": true } }, "dutyTaxFees": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "description": "Calculation of taxes – Tax base quantity (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "basisValue": { "type": "number", "description": "Calculation of taxes – Tax base amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "description": "Duty regime (format: an..3) (cardinality: 1x)", "nullable": true }, "quotaId": { "type": "string", "description": "Quota order number (format: an..17) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Calculation of taxes – Tax rate (format: n..17,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Calculation of taxes – Tax type (format: an..3) (cardinality: 1x)", "nullable": true }, "nationalType": { "type": "string", "description": "National tax type (format: an4) (cardinality: 1x)", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityDutyTaxFeePayment" }, "rateId": { "type": "string", "description": "The rate Id for the VAT taxes applicable. (format: an..10) (cardinality: 1x)", "nullable": true }, "unitQualifier": { "type": "string", "description": "Unit qualifier (format: an..6) (cardinality: 1x)", "nullable": true }, "unitType": { "type": "string", "description": "Unit type (format: an..6) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "dutyTaxFee" } }, "nullable": true, "xml": { "wrapped": true } }, "invoiceLine": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityInvoiceLine" }, "transportEquipments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "identification": { "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container (format: an..17) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "transportEquipment" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGovernmentAgencyGoodsItemEditable": { "type": "object", "properties": { "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Items.SADGSGagiCommodityEditable" }, "addDeclType2": { "maxLength": 6, "type": "string", "description": "Transit declaration/Proof of customs status type (format: an..6) (cardinality: 1x)", "nullable": true }, "productReference": { "maxLength": 256, "type": "string", "description": "Unique identifier for a specific product or batch (e.g. serial number, VIN, batch number) (format: an..256) (cardinality: 1x)", "nullable": true }, "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Goods item number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "trxNatCode": { "maximum": 100, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "This data element can only be given once, either on header level or on item level. (format: n..2) (cardinality: 1x)", "format": "int32", "nullable": true }, "undgs": { "maxItems": 99, "type": "array", "items": { "maxLength": 4, "type": "string", "xml": { "name": "undg" } }, "description": "UN Dangerous Goods code (format: an..4) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "additionalDocuments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "category": { "maxLength": 1, "type": "string", "description": "Additional document category (format: an1) (cardinality: 1x)", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code (format: an..3) (cardinality: 1x)", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Identifier of a document providing additional information (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type (format: an..3) (cardinality: 1x)", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentSubmitter" }, "name": { "maxLength": 35, "type": "string", "description": "Additional document name (format: an..35) (cardinality: 1x)", "nullable": true }, "writeOff": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentWriteOff" }, "lineNumber": { "type": "integer", "description": "(format: SAD.GS.Gagi.AdditionalDocument.LineNumber) (cardinality: 1x)", "format": "int32", "nullable": true } }, "xml": { "name": "additionalDocument" } }, "description": "(format: SAD.GS.Gagi.AdditionalDocument) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true }, "example": [ { "category": "C", "type": "ABC", "refNum": "DOC-2024-001", "lpcoExemptionCode": "AE", "issueDate": "2024-01-15T09:30:00Z", "name": "Import License" }, { "type": "ABCD", "refNum": "DOC-2024-002", "lpcoExemptionCode": "XX", "issueDate": "2024-01-15T09:30:00Z", "name": "Certificate of Origin" } ] }, "additionalInformations": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 17, "type": "string", "description": "Coded form of an additional statement (format: an..17) (cardinality: 1x)", "nullable": true }, "text": { "maxLength": 512, "type": "string", "description": "Description of an additional statement (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 5, "type": "string", "description": "Additional statement type (format: an..3) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "description": "(format: SAD.GS.Gagi.AdditionalInformation) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "customsValuation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCustomsValuation" }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiDestination" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGoodsMeasure" }, "governmentProcedure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGovernmentProcedure" }, "materials": { "maxItems": 999, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "equivalent": { "type": "boolean", "description": "Equivalent (format: bool) (cardinality: 1x)", "nullable": true }, "isBonded": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is bonded. Only applicable for special procedures. (format: bool) (cardinality: 1x)", "nullable": true }, "itemId": { "maxLength": 256, "type": "string", "description": "ItemId of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data) (format: an..256) (cardinality: 1x)", "nullable": true }, "itemGroup": { "maxLength": 256, "type": "string", "description": "ItemGroup of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data) (format: an..256) (cardinality: 1x)", "nullable": true }, "origin": { "type": "string", "description": "County of origin (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "qty": { "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "storageLocationReference": { "maxLength": 35, "type": "string", "description": "Storage location code (as known in CAS) from where an the materials which were used in processing. Only applicable for special procedures. (format: an..35) (cardinality: 1x)", "nullable": true }, "uom": { "maxLength": 5, "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records) (format: an..6) (cardinality: 1x)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the (semi-)produced product (format: an..255) (cardinality: 1x).", "nullable": true } }, "xml": { "name": "material" } }, "description": "Materials used in the goods, used for transactional bill of materials (format: SAD.GS.Gagi.Material) (cardinality: 999x)", "nullable": true, "xml": { "wrapped": true } }, "origins": { "maxItems": 2, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Country of origin (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "region": { "maxLength": 5, "type": "string", "description": "Origin region (format: an..32) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Origin type (PreferentialOrigin, NonPreferentialOrigin) (format: an..32) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "origin" } }, "description": "(format: SAD.GS.Gagi.Origin) (cardinality: 2x)", "nullable": true, "xml": { "wrapped": true } }, "packagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item (format: an..2) (cardinality: 1x)", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "description": "(format: SAD.GS.Gagi.Packaging) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "innerPackagings": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "description": "Number of inner packages (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of inner package of an item (format: an..2) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "innerPackaging" } }, "description": "(format: SAD.GS.Gagi.InnerPackaging) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "maxItems": 9999, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "art": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "billOfLoading": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "category": { "maxLength": 2, "type": "string", "description": "Only needed in BE (format: an..2) (cardinality: 1x)", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "item": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "lineNumber": { "type": "integer", "description": "Item number pertaining to the previous Customs filing (format: n..4) (cardinality: 1x)", "format": "int32", "nullable": true }, "loc": { "maxLength": 35, "type": "string", "description": "Only needed in BE (format: an..35) (cardinality: 1x)", "nullable": true }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Type of document used for declaration previously presented (format: an..3) (cardinality: 1x)", "nullable": true }, "typeOfPackages": { "maxLength": 2, "type": "string", "description": "Type of packages (format: an..2) (cardinality: 1x)", "nullable": true }, "numberOfPackages": { "type": "integer", "description": "Number of packages (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "measurementUnitAndQualifier": { "type": "string", "description": "Measurement unit and qualifier (format: an..4) (cardinality: 1x)", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of packages (format: n..16.6) (cardinality: 1x)", "format": "double", "nullable": true } }, "xml": { "name": "previousDocument" } }, "description": "(format: SAD.GS.Gagi.PreviousDocument) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "tradeTerms": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiTradeTerms" }, "ucr": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGAGIUcr" }, "valuationAdjustments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "amount": { "type": "number", "description": "Monetary amount by which the valuation was adjusted (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "qualifier": { "maxLength": 4, "type": "string", "description": "This data element is required when using valuation method 1 (transaction of the imported goods)otherwise it should be left blank.Using the relevant codes, enter the combination of indicators required to declare whether the value ofthe goods is affected by specific factors.The code comprises four digits, each of which being either a ‘0’ or a ‘1’.Enter a ‘1’ if the indicator affects the customs value.Enter a ‘0’ if the indicator does not affect the customs value.Each ‘1’ or ‘0’ digit reflects whether or not a valuation indicator has an impact on the Customs Value ofthe goods concerned (for example, they affect the item price).a) First digit: Enter code ‘1’ where there is a price influence as a result of a Party Relationshipbetween the buyer and seller.b) Second digit: Enter code ‘1’ where there are restrictions as to the disposal or use of the goodsby the buyer in accordance with Article 70(3)(a) of the Code.c) Third digit: Enter code ‘1’ where the sale or price is subject to some condition or considerationin accordance with Article 70(3)(b) of the Code.d) Fourth digit: Enter code ‘1’ where the sale is subject to an arrangement under which part of theproceeds of any subsequent resale, disposal or use accrues directly or indirectly to the seller.In all cases, enter code ‘0’ where there is no effect on the customs value or item price of the goods.(0000, 0001, 0010, 0011, 0100, 0101, 0110, 0111, 1000, 1001, 1010, 1011, 1100, 1101, 1110, 1111) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "valuationAdjustment" } }, "description": "(format: SAD.GS.Gagi.ValuationAdjustment) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "exporter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "additionalReferences": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "id": { "type": "string", "description": "Id (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "type": "string", "description": "TypeCode (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalReference" } }, "description": "(format: AdditionalReference) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseGoodsItem" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.Metadata": { "type": "object", "properties": { "key": { "type": "string", "nullable": true }, "value": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "Metadata" }, "Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalDocument": { "type": "object", "properties": { "casReference": { "type": "string", "description": "CAS internal reference", "nullable": true }, "category": { "type": "string", "description": "Additional document category", "nullable": true }, "issueDate": { "type": "string", "description": "The issue date for XML serialization", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "type": "string", "description": "Additional document status code", "nullable": true }, "refNum": { "type": "string", "description": "Identifier of a document providing additional information", "nullable": true }, "type": { "type": "string", "description": "Additional document type", "nullable": true }, "submitter": { "type": "string", "description": "Document submitter name", "nullable": true } }, "additionalProperties": false, "description": "SADAdditionalDocument - Header level additional document" }, "Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalInformation": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "type": "string", "description": "Coded form of an additional statement (format: an..17) (cardinality: 1x)", "nullable": true }, "text": { "type": "string", "description": "Description of an additional statement (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Additional statement type (format: an..3) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADAdditionalInformation" }, "Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalParty": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "partyType": { "type": "string", "description": "Type of the additional party (format: an..3) (cardinality: 1x)", "nullable": true }, "party": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalPartyParty" } }, "additionalProperties": false, "description": "SADAdditionalParty" }, "Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalPartyParty": { "type": "object", "properties": { "code": { "type": "string", "description": "Party unique identifier (format: an..16) (cardinality: 1x)", "nullable": true }, "name": { "type": "string", "description": "Party name (format: an..70) (cardinality: 1x)", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalPartyPartyAddress" } }, "additionalProperties": false, "description": "SADAdditionalPartyParty" }, "Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalPartyPartyAddress": { "type": "object", "properties": { "street": { "type": "string", "description": "Party address street (format: an..70) (cardinality: 1x)", "nullable": true }, "number": { "type": "string", "description": "Party address number (format: an..16) (cardinality: 1x)", "nullable": true }, "box": { "type": "string", "description": "Party address address box (format: an..16) (cardinality: 1x)", "nullable": true }, "zipCode": { "type": "string", "description": "Party address zipCode (format: an..9) (cardinality: 1x)", "nullable": true }, "city": { "type": "string", "description": "Party address city (format: an..35) (cardinality: 1x)", "nullable": true }, "region": { "type": "string", "description": "Country subdivision of region (format: an..16) (cardinality: 1x)", "nullable": true }, "country": { "type": "string", "description": "Country (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADAdditionalPartyPartyAddress" }, "Cas.Public.Api.Contract.Declarations.Detail.SADAuthorizationHolder": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "categoryCode": { "type": "string", "description": "Category code of an authorization holder (format: an..38) (cardinality: 1x)", "nullable": true }, "reference": { "type": "string", "description": "Reference of an authorization holder (format: an..35) (cardinality: 1x)", "nullable": true }, "identifier": { "type": "string", "description": "Identifier of an authorization holder (format: an..35) (cardinality: 1x)", "nullable": true }, "authorizationId": { "type": "string", "description": "Authorization Id of an authorization holder (format: an..17) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADAuthorizationHolder" }, "Cas.Public.Api.Contract.Declarations.Detail.SADCalculationReturn": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "description": "Calculation of taxes – Tax base quantity (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "basisValue": { "type": "number", "description": "Calculation of taxes – Tax base amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "description": "Duty regime (format: an..3) (cardinality: 1x)", "nullable": true }, "quotaId": { "type": "string", "description": "Quota order number (format: an..17) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Calculation of taxes – Tax rate (format: n..11,3) (cardinality: 1x)", "format": "double", "nullable": true }, "reducedAssessed": { "type": "number", "description": "Amount of deduction from a duty or tax - assessed (format: n..11,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Calculation of taxes – Tax type (format: an..3) (cardinality: 1x)", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADCalculationReturnPayment" } }, "additionalProperties": false, "description": "Retro-active option: to provide total duty tax fees, to validate recalculated totals are the same (within a certain fault tolarance) Return message: Totals per type of returned duty tax fees as they where calculated by customs" }, "Cas.Public.Api.Contract.Declarations.Detail.SADCalculationReturnPayment": { "type": "object", "properties": { "amount": { "type": "number", "description": "Calculation of taxes – Payable tax amount (format: n..11,3) (cardinality: 1x)", "format": "double", "nullable": true }, "assessed": { "type": "number", "description": "Calculation of taxes – Total (format: n..11,3) (cardinality: 1x)", "format": "double", "nullable": true }, "methodCode": { "type": "string", "description": "Calculation Of Taxes – Method Of Payment (A, B, C, D, E, G, H, J, K, O, P, R, S, T, U, V) (format: a1) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADCalculationReturnPayment" }, "Cas.Public.Api.Contract.Declarations.Detail.SADControlResult": { "type": "object", "properties": { "resultType": { "type": "string", "description": "Result type (format: an.5) (cardinality: 1x)", "nullable": true }, "dateLimit": { "type": "string", "description": "Date limit (format: DateTimeOffset) (cardinality: 1x)", "format": "date-time", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "storingFlag": { "type": "boolean", "description": "Storing flag (format: bool) (cardinality: 1x)", "nullable": true }, "discrepanciesExist": { "type": "boolean", "description": "Discrepancies exist (format: bool) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADControlResult" }, "Cas.Public.Api.Contract.Declarations.Detail.SADCurrencyExchange": { "type": "object", "properties": { "currency": { "type": "string", "description": "Internal Currency Unit (ISO 4217 3-alpha code) (format: a3) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Exchange rate (format: n..12,5) (cardinality: 1x)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "SADCurrencyExchange" }, "Cas.Public.Api.Contract.Declarations.Detail.SADDutyTaxFee": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "description": "Calculation of taxes – Tax base quantity (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "basisValue": { "type": "number", "description": "Calculation of taxes – Tax base amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "description": "Code specifying a type of duty regime (format: an..3) (cardinality: 1x)", "nullable": true }, "quotaId": { "type": "string", "description": "Quota order number (format: an..17) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Calculation of taxes – Tax rate (format: n..17,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Calculation of taxes – Tax type (format: an..3) (cardinality: 1x)", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADDutyTaxFeePayment" }, "rateId": { "type": "string", "description": "The rate Id for the VAT taxes applicable. (format: an..10) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADDutyTaxFee" }, "Cas.Public.Api.Contract.Declarations.Detail.SADDutyTaxFeePayment": { "type": "object", "properties": { "amount": { "type": "number", "description": "Calculation of taxes – Payable tax amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "assessed": { "type": "number", "description": "Calculation of taxes – Total assessed (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "methodCode": { "type": "string", "description": "Calculation Of Taxes – Method Of Payment (A, B, C, D, E, G, H, J, K, O, P, R, S, T, U, V) (format: a1) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADDutyTaxFeePayment" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignment": { "type": "object", "properties": { "container": { "type": "integer", "description": "Container (0, 1) (format: n1) (cardinality: 1x)", "format": "int32", "nullable": true }, "transitOfficeCodes": { "type": "array", "items": { "type": "string", "xml": { "name": "transitOfficeCode" } }, "description": "Intended offices of transit (format: an..17) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "arrivalTransportMeans": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentArrivalTransportMeans" }, "borderTransportMeans": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentBorderTransportMeans" }, "carrier": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "departureTransportMeans": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentDepartureTransportMeans" }, "itineraries": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "country": { "type": "string", "description": "Country (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "routeId": { "type": "string", "description": "ID of the crossing route (format: an..64) (cardinality: 1x)", "nullable": true }, "routeIdType": { "type": "string", "description": "Type of the crossing route (format: an..64) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "itinerary" } }, "description": "(format: SAD.GS.Consignment.Itinerary) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "transportEquipments": { "maxItems": 99, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "identification": { "maxLength": 17, "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container (format: an..17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Type of transport equipment (format: a..2) (cardinality: 1x)", "nullable": true }, "sealQuantity": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of seals (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "seals": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "description": "Seal identifier (format: an..35) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "seal" } }, "description": "(format: SAD.GS.Consignment.TransportEquipment.Seal) (cardinality: 9x)", "nullable": true, "xml": { "wrapped": true } }, "goodsReferences": { "type": "array", "items": { "type": "string", "xml": { "name": "goodsReference" } }, "description": "References to the consignment's government agency goods items that are loaded in this transport equipment.\r\nUse the casReference of the goods item as the reference value.", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "transportEquipment" } }, "description": "(format: SAD.GS.Consignment.TransportEquipment) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "goodsLocation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentGoodsLocation" }, "transportAndInsuranceCostsToTheDestination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentTransportAndInsuranceCostsToTheDestination" }, "transportContractDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "id": { "type": "string", "description": "Id (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "type": "string", "description": "Type Code (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "transportContractDocument" } }, "description": "(format: SAD.GS.Consignment.TransportContractDocument) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "loadingLocation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentLoadingLocation" } }, "additionalProperties": false, "description": "SADGSConsignment" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentArrivalTransportMeans": { "type": "object", "properties": { "identification": { "maxLength": 35, "type": "string", "description": "Identity of means of transport on arrival (format: an..35) (cardinality: 1x)", "nullable": true }, "identificationType": { "maxLength": 4, "type": "string", "description": "Identity of means of transport on arrival (format: an..4) (cardinality: 1x)", "nullable": true }, "mode": { "maxLength": 4, "type": "string", "description": "Inland Mode Of Transport (1, 2, 3, 4, 5, 7, 8, 9) (format: an..4) (cardinality: 1x)", "nullable": true }, "journeyId": { "maxLength": 35, "type": "string", "description": "Journey identifier (format: an..35) (cardinality: 1x)", "nullable": true }, "name": { "maxLength": 70, "type": "string", "description": "Name of the means of transport (format: an..70) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSConsignmentArrivalTransportMeans" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentBorderTransportMeans": { "type": "object", "properties": { "country": { "type": "string", "description": "Nationality Of Active Means Of Transport Crossing The Border (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "bookingReference": { "type": "string", "description": "Used in the context of some port community systems (PCS). The vehicle booking reference (format: an..64) (cardinality: 1x)", "nullable": true }, "departureLocation": { "type": "string", "description": "Used in the context of some port community systems (PCS). Represent the terminal where the vehicle arrives. (format: an..17) (cardinality: 1x)", "nullable": true }, "identification": { "type": "string", "description": "Identification of actual means of transport crossing the border (format: an..35) (cardinality: 1x)", "nullable": true }, "identificationType": { "type": "string", "description": "Type of actual means of transport crossing the border (format: an..4) (cardinality: 1x)", "nullable": true }, "mode": { "type": "string", "description": "Mode Of Transport At The Border (1, 2, 3, 4, 5, 6, 7, 8, 9, 10) (format: an..4) (cardinality: 1x)", "nullable": true }, "isAccompanied": { "type": "boolean", "description": "A flag indicating whether or not the goods are accompanied. Needed for mapping to customs (especially PCS): Which vehicle number to declare: Truck or trailer (format: bool) (cardinality: 1x)", "nullable": true }, "departureDateTime": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" } }, "additionalProperties": false, "description": "SADGSConsignmentBorderTransportMeans" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentDepartureTransportMeans": { "type": "object", "properties": { "country": { "type": "string", "description": "Nationality of means of transport at departure (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "identification": { "type": "string", "description": "Identity of means of transport at departure (format: an..35) (cardinality: 1x)", "nullable": true }, "identificationType": { "type": "string", "description": "type of means of transport at departure (format: an..4) (cardinality: 1x)", "nullable": true }, "mode": { "type": "string", "description": "Inland Mode Of Transport (1, 2, 3, 4, 5, 7, 8, 9) (format: an..4) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSConsignmentDepartureTransportMeans" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentGoodsLocation": { "type": "object", "properties": { "identification": { "type": "string", "description": "Identification of goods location (format: an..35) (cardinality: 1x)", "nullable": true }, "identificationType": { "type": "string", "description": "Code/formatIdentifier SAD.GS for Consignment.GoodsLocation the Addressidentification of the goods location (cardinality: 1x)", "nullable": true }, "name": { "type": "string", "description": "Name of goods location (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Type of goods location (cardinality: 1x)", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentGoodsLocationAddress" }, "additionalIdentifier": { "type": "string", "description": "An additional Identifier (format: an..8***) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSConsignmentGoodsLocation" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentGoodsLocationAddress": { "type": "object", "properties": { "box": { "type": "string", "description": "Goods location address box (format: an..16) (cardinality: 1x)", "nullable": true }, "city": { "type": "string", "description": "Goods location address city (format: an..35) (cardinality: 1x)", "nullable": true }, "country": { "type": "string", "description": "Country (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "number": { "type": "string", "description": "Goods location address number (format: an..16) (cardinality: 1x)", "nullable": true }, "region": { "type": "string", "description": "Country subdivision of region (format: an..16) (cardinality: 1x)", "nullable": true }, "street": { "type": "string", "description": "Goods location address street (format: an..70) (cardinality: 1x)", "nullable": true }, "zipCode": { "type": "string", "description": "Goods location address zipCode (format: an..9) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSConsignmentGoodsLocationAddress" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentItinerary": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "country": { "type": "string", "description": "Country (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "routeId": { "type": "string", "description": "ID of the crossing route (format: an..64) (cardinality: 1x)", "nullable": true }, "routeIdType": { "type": "string", "description": "Type of the crossing route (format: an..64) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSConsignmentItinerary" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentLoadingLocation": { "type": "object", "additionalProperties": false, "description": "SADGSConsignmentLoadingLocation" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentTransportAndInsuranceCostsToTheDestination": { "type": "object", "properties": { "amount": { "type": "number", "description": "Amount (format: n..16,2) (cardinality: 1x)", "format": "double", "nullable": true }, "currency": { "type": "string", "description": "Currency (ISO 4217 3-alpha code) (format: an..3) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSConsignmentTransportAndInsuranceCostsToTheDestination" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentTransportEquipment": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "identification": { "maxLength": 17, "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container (format: an..17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Type of transport equipment (format: a..2) (cardinality: 1x)", "nullable": true }, "sealQuantity": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Number of seals (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "seals": { "maxItems": 9, "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "description": "Seal identifier (format: an..35) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "seal" } }, "description": "(format: SAD.GS.Consignment.TransportEquipment.Seal) (cardinality: 9x)", "nullable": true, "xml": { "wrapped": true } }, "goodsReferences": { "type": "array", "items": { "type": "string", "xml": { "name": "goodsReference" } }, "description": "References to the consignment's government agency goods items that are loaded in this transport equipment.\r\nUse the casReference of the goods item as the reference value.", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "SADGSConsignmentTransportEquipment" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignmentTransportEquipmentSeal": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "maximum": 100000, "exclusiveMaximum": true, "minimum": 0, "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "identification": { "maxLength": 35, "type": "string", "description": "Seal identifier (format: an..35) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSConsignmentTransportEquipmentSeal" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSCustomsValuation": { "type": "object", "properties": { "chargeDeductions": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSCustomsValuationChargeDeductionCurrencyExchange" }, "otherChargeDeductionAmount": { "type": "number", "description": "Additions and deductions amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Additions and deductions code (format: an..3) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "chargeDeduction" } }, "description": "(format: SAD.GS.CustomsValuation.ChargeDeduction) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "SADGSCustomsValuation" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSCustomsValuationChargeDeduction": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSCustomsValuationChargeDeductionCurrencyExchange" }, "otherChargeDeductionAmount": { "type": "number", "description": "Additions and deductions amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Additions and deductions code (format: an..3) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSCustomsValuationChargeDeduction" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSCustomsValuationChargeDeductionCurrencyExchange": { "type": "object", "properties": { "currency": { "type": "string", "description": "Exchange rate (ISO 4217 3-alpha code) (format: a3) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Exchange rate (format: n..12,5) (cardinality: 1x)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "SADGSCustomsValuationChargeDeductionCurrencyExchange" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSDestination": { "type": "object", "properties": { "country": { "type": "string", "description": "Destination country (ISO 3166-1 2-alpha code) This data element can only be given once, either on header level or on item level. (format: a2) (cardinality: 1x)", "nullable": true }, "region": { "type": "string", "description": "This data element can only be given once, either on header level or on item level. (format: an..16) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSDestination" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSDomesticDutyTaxParty": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "identification": { "type": "string", "description": "To identify a party responsible for the national VAT or Goods & Services Tax (format: an..17) (cardinality: 1x)", "nullable": true }, "roleCode": { "type": "string", "description": "VAT-related fiscal references: FR1 (importer), FR2 (customer), FR3 (tax representative), FR4 (holder of the deferred payment authorisation) (format: an..3) (cardinality: 1x)", "nullable": true }, "code": { "type": "string", "description": "Business partner unique identifier (format: an..16) (cardinality: 1x)", "nullable": true }, "name": { "type": "string", "description": "Business partner name (format: an..70) (cardinality: 1x)", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerContact" }, "businessPartnerReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number) (format: an.17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "businessPartnerReference" } }, "description": "(format: BusinessPartner.BusinessPartnerReference) (cardinality: 9x)", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "SADGSDomesticDutyTaxParty" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSElo": { "type": "object", "properties": { "lorryType": { "type": "string", "description": "Lorry type (possible values: PLEIN, VIDE) (format: an..35) (cardinality: 1x)", "nullable": true }, "fisheryGoods": { "type": "boolean", "description": "Fishery goods (cardinality: 1x)", "nullable": true }, "tirAtaFormalities": { "type": "boolean", "description": "TIR/ATA formalities (cardinality: 1x)", "nullable": true }, "sanitaryGoods": { "type": "boolean", "description": "Sanitary goods (cardinality: 1x)", "nullable": true }, "postalGoods": { "type": "boolean", "description": "Postal goods (cardinality: 1x)", "nullable": true }, "emptyPackaging": { "type": "boolean", "description": "Empty packaging (cardinality: 1x)", "nullable": true }, "transportContracts": { "type": "boolean", "description": "Transport contracts (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSElo" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGAGIUcr": { "type": "object", "properties": { "traderReference": { "type": "string", "description": "This data element can only be given once, either on header level or on item level. (format: an..35) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGAGIUcr" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocument": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "category": { "maxLength": 1, "type": "string", "description": "Additional document category (format: an1) (cardinality: 1x)", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code (format: an..3) (cardinality: 1x)", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Identifier of a document providing additional information (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type (format: an..3) (cardinality: 1x)", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentSubmitter" }, "name": { "maxLength": 35, "type": "string", "description": "Additional document name (format: an..35) (cardinality: 1x)", "nullable": true }, "writeOff": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentWriteOff" }, "lineNumber": { "type": "integer", "description": "(format: SAD.GS.Gagi.AdditionalDocument.LineNumber) (cardinality: 1x)", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiAdditionalDocument" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentSubmitter": { "type": "object", "properties": { "name": { "type": "string", "description": "Submitter Name (format: an..70) (cardinality: 1x)", "nullable": true }, "roleCode": { "type": "string", "description": "Submitter Role code (format: an..3) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiAdditionalDocumentSubmitter" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentWriteOff": { "type": "object", "properties": { "quantity": { "type": "string", "description": "Quantity (format: n..16,6) (cardinality: 1x)", "nullable": true }, "unit": { "type": "string", "description": "Unit (format: an..5) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiAdditionalDocumentWriteOff" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalInformation": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 17, "type": "string", "description": "Coded form of an additional statement (format: an..17) (cardinality: 1x)", "nullable": true }, "text": { "maxLength": 512, "type": "string", "description": "Description of an additional statement (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 5, "type": "string", "description": "Additional statement type (format: an..3) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiAdditionalInformation" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodity": { "type": "object", "properties": { "casItemReference": { "type": "string", "nullable": true }, "casStorageLocationReference": { "type": "string", "nullable": true }, "casReceivingStorageLocationReference": { "type": "string", "nullable": true }, "calculationReturns": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "format": "double", "nullable": true }, "basisValue": { "type": "number", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "nullable": true }, "quotaId": { "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "reducedAssessed": { "type": "number", "format": "double", "nullable": true }, "type": { "type": "string", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityCalculationReturnPayment" } }, "xml": { "name": "calculationReturn" } }, "nullable": true, "xml": { "wrapped": true } }, "description": { "type": "string", "nullable": true }, "isBonded": { "type": "boolean", "nullable": true }, "itemId": { "type": "string", "nullable": true }, "storageLocationReference": { "type": "string", "nullable": true }, "receivingStorageLocationReference": { "type": "string", "nullable": true }, "receivingAuthorizationId": { "type": "string", "nullable": true }, "classifications": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "type": "string", "description": "Classification code (format: an..10) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Classification type (e.g. TARIC) (format: an..32) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "classification" } }, "nullable": true, "xml": { "wrapped": true } }, "dutyTaxFees": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "description": "Calculation of taxes – Tax base quantity (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "basisValue": { "type": "number", "description": "Calculation of taxes – Tax base amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "description": "Duty regime (format: an..3) (cardinality: 1x)", "nullable": true }, "quotaId": { "type": "string", "description": "Quota order number (format: an..17) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Calculation of taxes – Tax rate (format: n..17,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Calculation of taxes – Tax type (format: an..3) (cardinality: 1x)", "nullable": true }, "nationalType": { "type": "string", "description": "National tax type (format: an4) (cardinality: 1x)", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityDutyTaxFeePayment" }, "rateId": { "type": "string", "description": "The rate Id for the VAT taxes applicable. (format: an..10) (cardinality: 1x)", "nullable": true }, "unitQualifier": { "type": "string", "description": "Unit qualifier (format: an..6) (cardinality: 1x)", "nullable": true }, "unitType": { "type": "string", "description": "Unit type (format: an..6) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "dutyTaxFee" } }, "nullable": true, "xml": { "wrapped": true } }, "invoiceLine": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityInvoiceLine" }, "transportEquipments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "identification": { "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container (format: an..17) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "transportEquipment" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityCalculationReturn": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "format": "double", "nullable": true }, "basisValue": { "type": "number", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "nullable": true }, "quotaId": { "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "reducedAssessed": { "type": "number", "format": "double", "nullable": true }, "type": { "type": "string", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityCalculationReturnPayment" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityCalculationReturnPayment": { "type": "object", "properties": { "amount": { "type": "number", "format": "double", "nullable": true }, "assessed": { "type": "number", "format": "double", "nullable": true }, "methodCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityClassification": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "type": "string", "description": "Classification code (format: an..10) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Classification type (e.g. TARIC) (format: an..32) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiCommodityClassification" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityDutyTaxFee": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "description": "Calculation of taxes – Tax base quantity (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "basisValue": { "type": "number", "description": "Calculation of taxes – Tax base amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "description": "Duty regime (format: an..3) (cardinality: 1x)", "nullable": true }, "quotaId": { "type": "string", "description": "Quota order number (format: an..17) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Calculation of taxes – Tax rate (format: n..17,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Calculation of taxes – Tax type (format: an..3) (cardinality: 1x)", "nullable": true }, "nationalType": { "type": "string", "description": "National tax type (format: an4) (cardinality: 1x)", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityDutyTaxFeePayment" }, "rateId": { "type": "string", "description": "The rate Id for the VAT taxes applicable. (format: an..10) (cardinality: 1x)", "nullable": true }, "unitQualifier": { "type": "string", "description": "Unit qualifier (format: an..6) (cardinality: 1x)", "nullable": true }, "unitType": { "type": "string", "description": "Unit type (format: an..6) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiCommodityDutyTaxFee" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityDutyTaxFeePayment": { "type": "object", "properties": { "amount": { "type": "number", "description": "Calculation of taxes – Payable tax amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "assessed": { "type": "number", "description": "Calculation of taxes – Total (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "methodCode": { "type": "string", "description": "Calculation Of Taxes – Method Of Payment (A, B, C, D, E, G, H, J, K, O, P, R, S, T, U, V) (format: a1) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiCommodityDutyTaxFeePayment" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityInvoiceLine": { "type": "object", "properties": { "itemAmount": { "type": "number", "description": "Item price/amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "unitPrice": { "type": "number", "description": "Unit price of the goods, specified in the invoice currency (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiCommodityInvoiceLine" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodityTransportEquipment": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "seqNum": { "type": "integer", "description": "Sequence number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "identification": { "type": "string", "description": "Marks (letters and/or numbers) which identify equipment e.g. unit load device/container (format: an..17) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiCommodityTransportEquipment" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCustomsValuation": { "type": "object", "properties": { "valuationMethod": { "type": "string", "description": "Valuation Method (1, 2, 3, 4, 5, 6) (format: an..3) (cardinality: 1x)", "nullable": true }, "chargeDeductions": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "otherChargeDeductionAmount": { "type": "number", "description": "Additions and deductions amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Additions and deductions Code (format: an..3) (cardinality: 1x)", "nullable": true }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCustomsValuationChargeDeductionCurrencyExchange" }, "otherPercentage": { "type": "number", "description": "Additions and deductions other percentage (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true } }, "xml": { "name": "chargeDeduction" } }, "description": "(format: SAD.GS.Gagi.CustomsValuation.ChargeDeduction) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "(format: SAD.GS.Gagi.CustomsValuation)" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCustomsValuationChargeDeduction": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "otherChargeDeductionAmount": { "type": "number", "description": "Additions and deductions amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Additions and deductions Code (format: an..3) (cardinality: 1x)", "nullable": true }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCustomsValuationChargeDeductionCurrencyExchange" }, "otherPercentage": { "type": "number", "description": "Additions and deductions other percentage (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiCustomsValuationChargeDeduction" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCustomsValuationChargeDeductionCurrencyExchange": { "type": "object", "properties": { "currency": { "type": "string", "description": "Currency (ISO 4217 3-alpha code) (format: a3) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Exchange rate (format: n..12,5) (cardinality: 1x)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiCustomsValuationChargeDeductionCurrencyExchange" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiDestination": { "type": "object", "properties": { "country": { "type": "string", "description": "Destination country (ISO 3166-1 2-alpha code) This data element can only be given once, either on header level or on item level. (format: a2) (cardinality: 1x)", "nullable": true }, "region": { "type": "string", "description": "This data element can only be given once, either on header level or on item level. (format: an..16) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiDestination" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGoodsMeasure": { "type": "object", "properties": { "gmass": { "type": "number", "description": "Gross mass (kg) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "nmass": { "type": "number", "description": "Net mass (kg) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "qty": { "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "supQty": { "type": "number", "description": "Supplementary units (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "supQtyUom": { "type": "string", "description": "Unit of measure for supplementary units (format: an..5) (cardinality: 1x)", "nullable": true }, "uom": { "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records) (format: an..5) (cardinality: 1x)", "nullable": true }, "quantities": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "number", "description": "An additional quantity", "format": "double", "nullable": true }, "uom": { "type": "string", "description": "The UoM of the additional quantity", "nullable": true } }, "xml": { "name": "quantity" } }, "description": "Additional quantities for the goods.", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "SADGSGagiGoodsMeasure" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGoodsMeasureQuantity": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "number", "description": "An additional quantity", "format": "double", "nullable": true }, "uom": { "type": "string", "description": "The UoM of the additional quantity", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGovernmentProcedure": { "type": "object", "properties": { "proc": { "type": "string", "description": "Code specifying a procedure (format: an..7) (cardinality: 1x)", "nullable": true }, "prevProc": { "type": "string", "description": "Code specifying the previous procedure (format: an..7) (cardinality: 1x)", "nullable": true }, "declProcType": { "type": "string", "description": "Declaration procedure code (A,B,C,D,E,F,G,H,I,J,K) that defines the Government Agency data setNote: only needed for BE (format: a1) (cardinality: 1x)", "nullable": true }, "procEU": { "type": "string", "description": "Additional EU government procedure code as defined by Council Regulation (EC) No 1186/2009 (format: an..7) (cardinality: 1x)", "nullable": true }, "procNat1": { "type": "string", "description": "Additional national government procedure code (format: an..7) (cardinality: 1x)", "nullable": true }, "procNat2": { "type": "string", "description": "Additional national government procedure code (format: an..7) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiGovernmentProcedure" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiInnerPackaging": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "description": "Number of inner packages (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of inner package of an item (format: an..2) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiInnerPackaging" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiMaterial": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "equivalent": { "type": "boolean", "description": "Equivalent (format: bool) (cardinality: 1x)", "nullable": true }, "isBonded": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is bonded. Only applicable for special procedures. (format: bool) (cardinality: 1x)", "nullable": true }, "itemId": { "maxLength": 256, "type": "string", "description": "ItemId of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data) (format: an..256) (cardinality: 1x)", "nullable": true }, "itemGroup": { "maxLength": 256, "type": "string", "description": "ItemGroup of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data) (format: an..256) (cardinality: 1x)", "nullable": true }, "origin": { "type": "string", "description": "County of origin (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "qty": { "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "storageLocationReference": { "maxLength": 35, "type": "string", "description": "Storage location code (as known in CAS) from where an the materials which were used in processing. Only applicable for special procedures. (format: an..35) (cardinality: 1x)", "nullable": true }, "uom": { "maxLength": 5, "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records) (format: an..6) (cardinality: 1x)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the (semi-)produced product (format: an..255) (cardinality: 1x).", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiMaterial" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiOrigin": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Country of origin (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "region": { "maxLength": 5, "type": "string", "description": "Origin region (format: an..32) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Origin type (PreferentialOrigin, NonPreferentialOrigin) (format: an..32) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiOrigin" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiPackaging": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item (format: an..2) (cardinality: 1x)", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiPackaging" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiPreviousDocument": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "art": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "billOfLoading": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "category": { "maxLength": 2, "type": "string", "description": "Only needed in BE (format: an..2) (cardinality: 1x)", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "item": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "lineNumber": { "type": "integer", "description": "Item number pertaining to the previous Customs filing (format: n..4) (cardinality: 1x)", "format": "int32", "nullable": true }, "loc": { "maxLength": 35, "type": "string", "description": "Only needed in BE (format: an..35) (cardinality: 1x)", "nullable": true }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Type of document used for declaration previously presented (format: an..3) (cardinality: 1x)", "nullable": true }, "typeOfPackages": { "maxLength": 2, "type": "string", "description": "Type of packages (format: an..2) (cardinality: 1x)", "nullable": true }, "numberOfPackages": { "type": "integer", "description": "Number of packages (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "measurementUnitAndQualifier": { "type": "string", "description": "Measurement unit and qualifier (format: an..4) (cardinality: 1x)", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of packages (format: n..16.6) (cardinality: 1x)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiPreviousDocument" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiTradeTerms": { "type": "object", "properties": { "placeCode": { "type": "string", "description": "Delivery terms code (format: an..17) (cardinality: 1x)", "nullable": true }, "place": { "type": "string", "description": "Name of the point or port of departure, shipment or destination, as required under the applicable terms of delivery, e.g. Incoterm (format: an..256) (cardinality: 1x)", "nullable": true }, "termsCode": { "type": "string", "description": "Delivery Terms (DAF, EXW, FCA, CPT, CIP, DAT, DAP, DDP, DDU, FAS, FOB, CFR, CIF, DES, DEQ, XXX) (format: a3) (cardinality: 1x)", "nullable": true }, "countryRelationshipCode": { "type": "integer", "description": "Indication whether the place specified for the performance of a (contractual) obligation is located in the country where the declaration is made, in another member country of the same economic or Customs union, or in a third country (format: n1) (cardinality: 1x)\r\n///", "format": "int32", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiTradeTerms" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiValuationAdjustment": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "amount": { "type": "number", "description": "Monetary amount by which the valuation was adjusted (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "qualifier": { "maxLength": 4, "type": "string", "description": "This data element is required when using valuation method 1 (transaction of the imported goods)otherwise it should be left blank.Using the relevant codes, enter the combination of indicators required to declare whether the value ofthe goods is affected by specific factors.The code comprises four digits, each of which being either a ‘0’ or a ‘1’.Enter a ‘1’ if the indicator affects the customs value.Enter a ‘0’ if the indicator does not affect the customs value.Each ‘1’ or ‘0’ digit reflects whether or not a valuation indicator has an impact on the Customs Value ofthe goods concerned (for example, they affect the item price).a) First digit: Enter code ‘1’ where there is a price influence as a result of a Party Relationshipbetween the buyer and seller.b) Second digit: Enter code ‘1’ where there are restrictions as to the disposal or use of the goodsby the buyer in accordance with Article 70(3)(a) of the Code.c) Third digit: Enter code ‘1’ where the sale or price is subject to some condition or considerationin accordance with Article 70(3)(b) of the Code.d) Fourth digit: Enter code ‘1’ where the sale is subject to an arrangement under which part of theproceeds of any subsequent resale, disposal or use accrues directly or indirectly to the seller.In all cases, enter code ‘0’ where there is no effect on the customs value or item price of the goods.(0000, 0001, 0010, 0011, 0100, 0101, 0110, 0111, 1000, 1001, 1010, 1011, 1100, 1101, 1110, 1111) (format: an..4) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSGagiValuationAdjustment" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSGovernmentAgencyGoodsItem": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "containerIdentification": { "type": "string", "description": "DEPRECATED - Use the goodsReferences field on the goods shipment level transportEquipment instead, providing the casReference of the goods item.", "nullable": true, "deprecated": true }, "customsValue": { "type": "number", "description": "Customs value (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "statValue": { "type": "number", "description": "Statistical value (format: n..16,2) (cardinality: 1x)", "format": "double", "nullable": true }, "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodity" }, "addDeclType2": { "type": "string", "description": "Transit declaration/Proof of customs status type (format: an..6) (cardinality: 1x)", "nullable": true }, "productReference": { "type": "string", "description": "Unique identifier for a specific product or batch (e.g. serial number, VIN, batch number) (format: an..256) (cardinality: 1x)", "nullable": true }, "seqNum": { "type": "integer", "description": "Goods item number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "trxNatCode": { "type": "integer", "description": "This data element can only be given once, either on header level or on item level. (format: n..2) (cardinality: 1x)", "format": "int32", "nullable": true }, "undgs": { "type": "array", "items": { "type": "string", "xml": { "name": "undg" } }, "description": "UN Dangerous Goods code (format: an..4) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "additionalDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "category": { "maxLength": 1, "type": "string", "description": "Additional document category (format: an1) (cardinality: 1x)", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code (format: an..3) (cardinality: 1x)", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Identifier of a document providing additional information (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type (format: an..3) (cardinality: 1x)", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentSubmitter" }, "name": { "maxLength": 35, "type": "string", "description": "Additional document name (format: an..35) (cardinality: 1x)", "nullable": true }, "writeOff": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentWriteOff" }, "lineNumber": { "type": "integer", "description": "(format: SAD.GS.Gagi.AdditionalDocument.LineNumber) (cardinality: 1x)", "format": "int32", "nullable": true } }, "xml": { "name": "additionalDocument" } }, "description": "(format: SAD.GS.Gagi.AdditionalDocument) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true }, "example": [ { "category": "C", "type": "ABC", "refNum": "DOC-2024-001", "lpcoExemptionCode": "AE", "issueDate": "2024-01-15T09:30:00Z", "name": "Import License" }, { "type": "ABCD", "refNum": "DOC-2024-002", "lpcoExemptionCode": "XX", "issueDate": "2024-01-15T09:30:00Z", "name": "Certificate of Origin" } ] }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 17, "type": "string", "description": "Coded form of an additional statement (format: an..17) (cardinality: 1x)", "nullable": true }, "text": { "maxLength": 512, "type": "string", "description": "Description of an additional statement (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 5, "type": "string", "description": "Additional statement type (format: an..3) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "description": "(format: SAD.GS.Gagi.AdditionalInformation) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "customsValuation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCustomsValuation" }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiDestination" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGoodsMeasure" }, "governmentProcedure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGovernmentProcedure" }, "materials": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "equivalent": { "type": "boolean", "description": "Equivalent (format: bool) (cardinality: 1x)", "nullable": true }, "isBonded": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is bonded. Only applicable for special procedures. (format: bool) (cardinality: 1x)", "nullable": true }, "itemId": { "maxLength": 256, "type": "string", "description": "ItemId of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data) (format: an..256) (cardinality: 1x)", "nullable": true }, "itemGroup": { "maxLength": 256, "type": "string", "description": "ItemGroup of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data) (format: an..256) (cardinality: 1x)", "nullable": true }, "origin": { "type": "string", "description": "County of origin (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "qty": { "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "storageLocationReference": { "maxLength": 35, "type": "string", "description": "Storage location code (as known in CAS) from where an the materials which were used in processing. Only applicable for special procedures. (format: an..35) (cardinality: 1x)", "nullable": true }, "uom": { "maxLength": 5, "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records) (format: an..6) (cardinality: 1x)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the (semi-)produced product (format: an..255) (cardinality: 1x).", "nullable": true } }, "xml": { "name": "material" } }, "description": "Materials used in the goods, used for transactional bill of materials (format: SAD.GS.Gagi.Material) (cardinality: 999x)", "nullable": true, "xml": { "wrapped": true } }, "origins": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Country of origin (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "region": { "maxLength": 5, "type": "string", "description": "Origin region (format: an..32) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Origin type (PreferentialOrigin, NonPreferentialOrigin) (format: an..32) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "origin" } }, "description": "(format: SAD.GS.Gagi.Origin) (cardinality: 2x)", "nullable": true, "xml": { "wrapped": true } }, "packagings": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item (format: an..2) (cardinality: 1x)", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "description": "(format: SAD.GS.Gagi.Packaging) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "innerPackagings": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "description": "Number of inner packages (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of inner package of an item (format: an..2) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "innerPackaging" } }, "description": "(format: SAD.GS.Gagi.InnerPackaging) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "art": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "billOfLoading": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "category": { "maxLength": 2, "type": "string", "description": "Only needed in BE (format: an..2) (cardinality: 1x)", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "item": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "lineNumber": { "type": "integer", "description": "Item number pertaining to the previous Customs filing (format: n..4) (cardinality: 1x)", "format": "int32", "nullable": true }, "loc": { "maxLength": 35, "type": "string", "description": "Only needed in BE (format: an..35) (cardinality: 1x)", "nullable": true }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Type of document used for declaration previously presented (format: an..3) (cardinality: 1x)", "nullable": true }, "typeOfPackages": { "maxLength": 2, "type": "string", "description": "Type of packages (format: an..2) (cardinality: 1x)", "nullable": true }, "numberOfPackages": { "type": "integer", "description": "Number of packages (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "measurementUnitAndQualifier": { "type": "string", "description": "Measurement unit and qualifier (format: an..4) (cardinality: 1x)", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of packages (format: n..16.6) (cardinality: 1x)", "format": "double", "nullable": true } }, "xml": { "name": "previousDocument" } }, "description": "(format: SAD.GS.Gagi.PreviousDocument) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "tradeTerms": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiTradeTerms" }, "ucr": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGAGIUcr" }, "valuationAdjustments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "amount": { "type": "number", "description": "Monetary amount by which the valuation was adjusted (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "qualifier": { "maxLength": 4, "type": "string", "description": "This data element is required when using valuation method 1 (transaction of the imported goods)otherwise it should be left blank.Using the relevant codes, enter the combination of indicators required to declare whether the value ofthe goods is affected by specific factors.The code comprises four digits, each of which being either a ‘0’ or a ‘1’.Enter a ‘1’ if the indicator affects the customs value.Enter a ‘0’ if the indicator does not affect the customs value.Each ‘1’ or ‘0’ digit reflects whether or not a valuation indicator has an impact on the Customs Value ofthe goods concerned (for example, they affect the item price).a) First digit: Enter code ‘1’ where there is a price influence as a result of a Party Relationshipbetween the buyer and seller.b) Second digit: Enter code ‘1’ where there are restrictions as to the disposal or use of the goodsby the buyer in accordance with Article 70(3)(a) of the Code.c) Third digit: Enter code ‘1’ where the sale or price is subject to some condition or considerationin accordance with Article 70(3)(b) of the Code.d) Fourth digit: Enter code ‘1’ where the sale is subject to an arrangement under which part of theproceeds of any subsequent resale, disposal or use accrues directly or indirectly to the seller.In all cases, enter code ‘0’ where there is no effect on the customs value or item price of the goods.(0000, 0001, 0010, 0011, 0100, 0101, 0110, 0111, 1000, 1001, 1010, 1011, 1100, 1101, 1110, 1111) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "valuationAdjustment" } }, "description": "(format: SAD.GS.Gagi.ValuationAdjustment) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "exporter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "id": { "type": "string", "description": "Id (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "type": "string", "description": "TypeCode (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalReference" } }, "description": "(format: AdditionalReference) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseGoodsItem" } }, "additionalProperties": false, "description": "SADGSGovernmentAgencyGoodsItem" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSInvoice": { "type": "object", "properties": { "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "number": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSSurety": { "type": "object", "properties": { "code": { "type": "string", "description": "The identifier of the party who agrees to be responsible for the debt or obligation of another (format: an..17) (cardinality: 1x)", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" } }, "additionalProperties": false, "description": "SADGSSurety" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSTradeTerms": { "type": "object", "properties": { "placeCode": { "type": "string", "description": "Delivery terms code (format: an..17) (cardinality: 1x)", "nullable": true }, "place": { "type": "string", "description": "Name of the point or port of departure, shipment or destination, as required under the applicable terms of delivery, e.g. Incoterm (format: an..256) (cardinality: 1x)", "nullable": true }, "termsCode": { "type": "string", "description": "Delivery Terms (DAF, EXW, FCA, CPT, CIP, DAT, DAP, DDP, DDU, FAS, FOB, CFR, CIF, DES, DEQ, XXX) (format: a3) (cardinality: 1x)", "nullable": true }, "countryRelationshipCode": { "type": "integer", "description": "Indication whether the place specified for the performance of a (contractual) obligation is located in the country where the declaration is made, in another member country of the same economic or Customs union, or in a third country (format: n1) (cardinality: 1x)\r\n///", "format": "int32", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false, "description": "SADGSTradeTerms" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSUcr": { "type": "object", "properties": { "traderReference": { "type": "string", "description": "This data element can only be given once, either on header level or on item level. (format: an..35) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSUcr" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGSWarehouse": { "type": "object", "properties": { "type": { "type": "string", "description": "Identification Of Warehouse (T, B, s, D, E, FS specific; procedure, X, Y, Z) (format: a1) (cardinality: 1x)", "nullable": true }, "externalReference": { "type": "string", "description": "Identification of warehouse (format: an..35) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADGSWarehouse" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGoodsMeasure": { "type": "object", "properties": { "gmass": { "type": "number", "description": "Gross mass (kg) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "nmass": { "type": "number", "description": "Net mass (kg) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true } }, "additionalProperties": false, "description": "SADGoodsMeasure" }, "Cas.Public.Api.Contract.Declarations.Detail.SADGoodsShipment": { "type": "object", "properties": { "governmentAgencyGoodsItems": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "containerIdentification": { "type": "string", "description": "DEPRECATED - Use the goodsReferences field on the goods shipment level transportEquipment instead, providing the casReference of the goods item.", "nullable": true, "deprecated": true }, "customsValue": { "type": "number", "description": "Customs value (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "statValue": { "type": "number", "description": "Statistical value (format: n..16,2) (cardinality: 1x)", "format": "double", "nullable": true }, "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCommodity" }, "addDeclType2": { "type": "string", "description": "Transit declaration/Proof of customs status type (format: an..6) (cardinality: 1x)", "nullable": true }, "productReference": { "type": "string", "description": "Unique identifier for a specific product or batch (e.g. serial number, VIN, batch number) (format: an..256) (cardinality: 1x)", "nullable": true }, "seqNum": { "type": "integer", "description": "Goods item number (format: n..5) (cardinality: 1x)", "format": "int32", "nullable": true }, "trxNatCode": { "type": "integer", "description": "This data element can only be given once, either on header level or on item level. (format: n..2) (cardinality: 1x)", "format": "int32", "nullable": true }, "undgs": { "type": "array", "items": { "type": "string", "xml": { "name": "undg" } }, "description": "UN Dangerous Goods code (format: an..4) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "additionalDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "category": { "maxLength": 1, "type": "string", "description": "Additional document category (format: an1) (cardinality: 1x)", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "maxLength": 3, "type": "string", "description": "Additional document status code (format: an..3) (cardinality: 1x)", "nullable": true }, "refNum": { "maxLength": 70, "type": "string", "description": "Identifier of a document providing additional information (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Additional document type (format: an..3) (cardinality: 1x)", "nullable": true }, "submitter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentSubmitter" }, "name": { "maxLength": 35, "type": "string", "description": "Additional document name (format: an..35) (cardinality: 1x)", "nullable": true }, "writeOff": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiAdditionalDocumentWriteOff" }, "lineNumber": { "type": "integer", "description": "(format: SAD.GS.Gagi.AdditionalDocument.LineNumber) (cardinality: 1x)", "format": "int32", "nullable": true } }, "xml": { "name": "additionalDocument" } }, "description": "(format: SAD.GS.Gagi.AdditionalDocument) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true }, "example": [ { "category": "C", "type": "ABC", "refNum": "DOC-2024-001", "lpcoExemptionCode": "AE", "issueDate": "2024-01-15T09:30:00Z", "name": "Import License" }, { "type": "ABCD", "refNum": "DOC-2024-002", "lpcoExemptionCode": "XX", "issueDate": "2024-01-15T09:30:00Z", "name": "Certificate of Origin" } ] }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 17, "type": "string", "description": "Coded form of an additional statement (format: an..17) (cardinality: 1x)", "nullable": true }, "text": { "maxLength": 512, "type": "string", "description": "Description of an additional statement (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 5, "type": "string", "description": "Additional statement type (format: an..3) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "description": "(format: SAD.GS.Gagi.AdditionalInformation) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "customsValuation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiCustomsValuation" }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiDestination" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGoodsMeasure" }, "governmentProcedure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiGovernmentProcedure" }, "materials": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "equivalent": { "type": "boolean", "description": "Equivalent (format: bool) (cardinality: 1x)", "nullable": true }, "isBonded": { "type": "boolean", "description": "Identifier that determines whether the line item (Gagi) is bonded. Only applicable for special procedures. (format: bool) (cardinality: 1x)", "nullable": true }, "itemId": { "maxLength": 256, "type": "string", "description": "ItemId of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data) (format: an..256) (cardinality: 1x)", "nullable": true }, "itemGroup": { "maxLength": 256, "type": "string", "description": "ItemGroup of the materials used in the goods, used for transactional bill of materials (as known in the CAS article master data) (format: an..256) (cardinality: 1x)", "nullable": true }, "origin": { "type": "string", "description": "County of origin (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "qty": { "type": "number", "description": "Quantity of the goods in the base unit of measure (as defined in CAS article master data - used to manage stock records) (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "storageLocationReference": { "maxLength": 35, "type": "string", "description": "Storage location code (as known in CAS) from where an the materials which were used in processing. Only applicable for special procedures. (format: an..35) (cardinality: 1x)", "nullable": true }, "uom": { "maxLength": 5, "type": "string", "description": "Base unit of measure of the goods (as defined in CAS article master data - used to manage stock records) (format: an..6) (cardinality: 1x)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the (semi-)produced product (format: an..255) (cardinality: 1x).", "nullable": true } }, "xml": { "name": "material" } }, "description": "Materials used in the goods, used for transactional bill of materials (format: SAD.GS.Gagi.Material) (cardinality: 999x)", "nullable": true, "xml": { "wrapped": true } }, "origins": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "country": { "type": "string", "description": "Country of origin (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "region": { "maxLength": 5, "type": "string", "description": "Origin region (format: an..32) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 32, "type": "string", "description": "Origin type (PreferentialOrigin, NonPreferentialOrigin) (format: an..32) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "origin" } }, "description": "(format: SAD.GS.Gagi.Origin) (cardinality: 2x)", "nullable": true, "xml": { "wrapped": true } }, "packagings": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "description": "Number of individual items packaged in such a way that they cannot be divided without first undoing the packing (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "shippingMarks": { "maxLength": 512, "type": "string", "description": "Shipping marks - Free form description of the marks and numbers on a transport unit or package (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of package of an item (format: an..2) (cardinality: 1x)", "nullable": true }, "commercialSealIdentification": { "maxLength": 35, "type": "string", "nullable": true }, "sealInformation": { "maxLength": 350, "type": "string", "nullable": true }, "sealInformationLanguage": { "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "description": "(format: SAD.GS.Gagi.Packaging) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "innerPackagings": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "description": "Number of inner packages (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "type": { "maxLength": 2, "type": "string", "description": "Code specifying the type of inner package of an item (format: an..2) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "innerPackaging" } }, "description": "(format: SAD.GS.Gagi.InnerPackaging) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "art": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "billOfLoading": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "category": { "maxLength": 2, "type": "string", "description": "Only needed in BE (format: an..2) (cardinality: 1x)", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "item": { "maxLength": 70, "type": "string", "description": "Only needed in BE (format: an..70) (cardinality: 1x)", "nullable": true }, "lineNumber": { "type": "integer", "description": "Item number pertaining to the previous Customs filing (format: n..4) (cardinality: 1x)", "format": "int32", "nullable": true }, "loc": { "maxLength": 35, "type": "string", "description": "Only needed in BE (format: an..35) (cardinality: 1x)", "nullable": true }, "number": { "maxLength": 70, "type": "string", "description": "The number of a previous document (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 4, "type": "string", "description": "Type of document used for declaration previously presented (format: an..3) (cardinality: 1x)", "nullable": true }, "typeOfPackages": { "maxLength": 2, "type": "string", "description": "Type of packages (format: an..2) (cardinality: 1x)", "nullable": true }, "numberOfPackages": { "type": "integer", "description": "Number of packages (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true }, "measurementUnitAndQualifier": { "type": "string", "description": "Measurement unit and qualifier (format: an..4) (cardinality: 1x)", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of packages (format: n..16.6) (cardinality: 1x)", "format": "double", "nullable": true } }, "xml": { "name": "previousDocument" } }, "description": "(format: SAD.GS.Gagi.PreviousDocument) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "tradeTerms": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGagiTradeTerms" }, "ucr": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSGAGIUcr" }, "valuationAdjustments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "amount": { "type": "number", "description": "Monetary amount by which the valuation was adjusted (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "qualifier": { "maxLength": 4, "type": "string", "description": "This data element is required when using valuation method 1 (transaction of the imported goods)otherwise it should be left blank.Using the relevant codes, enter the combination of indicators required to declare whether the value ofthe goods is affected by specific factors.The code comprises four digits, each of which being either a ‘0’ or a ‘1’.Enter a ‘1’ if the indicator affects the customs value.Enter a ‘0’ if the indicator does not affect the customs value.Each ‘1’ or ‘0’ digit reflects whether or not a valuation indicator has an impact on the Customs Value ofthe goods concerned (for example, they affect the item price).a) First digit: Enter code ‘1’ where there is a price influence as a result of a Party Relationshipbetween the buyer and seller.b) Second digit: Enter code ‘1’ where there are restrictions as to the disposal or use of the goodsby the buyer in accordance with Article 70(3)(a) of the Code.c) Third digit: Enter code ‘1’ where the sale or price is subject to some condition or considerationin accordance with Article 70(3)(b) of the Code.d) Fourth digit: Enter code ‘1’ where the sale is subject to an arrangement under which part of theproceeds of any subsequent resale, disposal or use accrues directly or indirectly to the seller.In all cases, enter code ‘0’ where there is no effect on the customs value or item price of the goods.(0000, 0001, 0010, 0011, 0100, 0101, 0110, 0111, 1000, 1001, 1010, 1011, 1100, 1101, 1110, 1111) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "valuationAdjustment" } }, "description": "(format: SAD.GS.Gagi.ValuationAdjustment) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "exporter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "id": { "type": "string", "description": "Id (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "type": "string", "description": "TypeCode (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalReference" } }, "description": "(format: AdditionalReference) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsItem": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseGoodsItem" } }, "xml": { "name": "governmentAgencyGoodsItem" } }, "description": "(format: SAD.GS.GovernmentAgencyGoodsItem) (cardinality: 9999x)", "nullable": true, "xml": { "wrapped": true } }, "exportCountry": { "type": "string", "description": "Country Of Dispatch/Export (ISO 3166-1 2-alpha code) (format: a2) (cardinality: 1x)", "nullable": true }, "trxNatCode": { "type": "integer", "description": "This data element can only be given once, either on header level or on item level. (format: n..2) (cardinality: 1X)", "format": "int32", "nullable": true }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "consignment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSConsignment" }, "consignor": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "customsValuation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSCustomsValuation" }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSDestination" }, "domesticDutyTaxParties": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "identification": { "type": "string", "description": "To identify a party responsible for the national VAT or Goods & Services Tax (format: an..17) (cardinality: 1x)", "nullable": true }, "roleCode": { "type": "string", "description": "VAT-related fiscal references: FR1 (importer), FR2 (customer), FR3 (tax representative), FR4 (holder of the deferred payment authorisation) (format: an..3) (cardinality: 1x)", "nullable": true }, "code": { "type": "string", "description": "Business partner unique identifier (format: an..16) (cardinality: 1x)", "nullable": true }, "name": { "type": "string", "description": "Business partner name (format: an..70) (cardinality: 1x)", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerAddress" }, "contact": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartnerContact" }, "businessPartnerReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "maxLength": 35, "type": "string", "description": "Reference identifier (e.g. VAT number) (format: an.17) (cardinality: 1x)", "nullable": true }, "type": { "maxLength": 25, "type": "string", "description": "Type of reference for a specific business partner. International codes (e.g. DUNS, EAN) (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "businessPartnerReference" } }, "description": "(format: BusinessPartner.BusinessPartnerReference) (cardinality: 9x)", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "domesticDutyTaxParty" } }, "description": "(format: SAD.GS.DomesticDutyTaxParty) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "exporter": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "seller": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "surety": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSSurety" }, "tradeTerms": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSTradeTerms" }, "ucr": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSUcr" }, "warehouse": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSWarehouse" }, "elo": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSElo" }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "id": { "type": "string", "description": "Id (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "type": "string", "description": "TypeCode (format: an..4) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalReference" } }, "description": "(format: AdditionalReference) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "exportRegion": { "type": "string", "description": "(format: SAD.GS.ExportRegion) (cardinality: 1x)", "nullable": true }, "exitDateTime": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "invoice": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGSInvoice" } }, "additionalProperties": false, "description": "(cardinality: 1x)" }, "Cas.Public.Api.Contract.Declarations.Detail.SADNationalReference": { "type": "object", "properties": { "id": { "type": "string", "description": "A reference to a technical Id the customs or other system assigns to the declaration (format: an..50) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADNationalRefernece" }, "Cas.Public.Api.Contract.Declarations.Detail.SADNctsEnquiry": { "type": "object", "properties": { "informationAvailable": { "type": "boolean", "description": "Identifier that determines whether the respective information is available (format: bool) (cardinality: 1x)" }, "informationText": { "type": "string", "description": "The information text (format: an...140) (cardinality: 1x)", "nullable": true }, "tc11DeliveredByCustoms": { "type": "boolean", "description": "Identifier that determines whether the respective TC11 is delivered by customs (format: bool) (cardinality: 1x)" }, "tc11DeliveryDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" } }, "additionalProperties": false, "description": "SADNctsEnquiry" }, "Cas.Public.Api.Contract.Declarations.Detail.SADObligationGuarantee": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "access": { "type": "string", "description": "Access (format: an..4) (cardinality: 1x)", "nullable": true }, "reference": { "type": "string", "description": "Reference (format: an..64) (cardinality: 1x)", "nullable": true }, "securityDetails": { "type": "string", "description": "Guarantee type (format: an..16) (cardinality: 1x)", "nullable": true }, "amount": { "type": "number", "description": "amount (format: decimal) (cardinality: 1x)", "format": "double", "nullable": true }, "excludedCountries": { "type": "array", "items": { "type": "string", "xml": { "name": "excludedCountry" } }, "description": "Excluded countries (format: a..2) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "declarationOffice": { "type": "string", "description": "Declaration office (format: an..8) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADObligationGuarantee" }, "Cas.Public.Api.Contract.Declarations.Detail.SADPackaging": { "type": "object", "properties": { "quantity": { "type": "integer", "description": "Number of packages (quantity) (format: n..8) (cardinality: 1x)", "format": "int32", "nullable": true } }, "additionalProperties": false, "description": "SADPackaging" }, "Cas.Public.Api.Contract.Declarations.Detail.SADPreviousDocument": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "billOfLoading": { "type": "string", "description": "Bill of loading (format: an..70) (cardinality: 1x)", "nullable": true }, "category": { "type": "string", "description": "Category of the document (format: an..2) (cardinality: 1x)\r\nThe declaration for temporary storage represented by ‘X’\r\nThe simplified declaration or the entry in the declarant’s records, represented by ‘Y’\r\nThe previous document, represented by ‘Z’", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "number": { "type": "string", "description": "The reference number of a previous document (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Type of document used for declaration previously presented (format: an..3) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "SADPreviousDocument" }, "Cas.Public.Api.Contract.Declarations.Detail.SADReferenceNumber": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "number": { "type": "string", "description": "Reference number (format: an..35) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Reference type (format: an..15) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "" }, "Cas.Public.Api.Contract.Declarations.Detail.SADStatusHistory": { "type": "object", "properties": { "status": { "type": "string", "description": "Historic status of the declaration (only used in return files) (format: an..17) (cardinality: 1x)", "nullable": true }, "statusDateTime": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "isNotAStatusChange": { "type": "boolean", "description": "Identifier that determines whether the respective historic status of the declaration was changed (only used in return files) (format: bool) (cardinality: 1x)" } }, "additionalProperties": false, "description": "List of statuses of the declaration (only used in return files)" }, "Cas.Public.Api.Contract.Declarations.Detail.SingleAdministrativeDocument": { "type": "object", "properties": { "goodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGoodsShipment" }, "casReference": { "type": "string", "nullable": true }, "creationDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "status": { "type": "string", "nullable": true }, "statusHistories": { "type": "array", "items": { "type": "object", "properties": { "status": { "type": "string", "description": "Historic status of the declaration (only used in return files) (format: an..17) (cardinality: 1x)", "nullable": true }, "statusDateTime": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "isNotAStatusChange": { "type": "boolean", "description": "Identifier that determines whether the respective historic status of the declaration was changed (only used in return files) (format: bool) (cardinality: 1x)" } }, "xml": { "name": "statusHistory" } }, "nullable": true, "xml": { "wrapped": true } }, "functionRefNum": { "type": "string", "nullable": true }, "totNumItems": { "type": "integer", "format": "int32", "nullable": true }, "calculationReturns": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "description": "Calculation of taxes – Tax base quantity (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "basisValue": { "type": "number", "description": "Calculation of taxes – Tax base amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "description": "Duty regime (format: an..3) (cardinality: 1x)", "nullable": true }, "quotaId": { "type": "string", "description": "Quota order number (format: an..17) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Calculation of taxes – Tax rate (format: n..11,3) (cardinality: 1x)", "format": "double", "nullable": true }, "reducedAssessed": { "type": "number", "description": "Amount of deduction from a duty or tax - assessed (format: n..11,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Calculation of taxes – Tax type (format: an..3) (cardinality: 1x)", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADCalculationReturnPayment" } }, "xml": { "name": "calculationReturn" } }, "nullable": true, "xml": { "wrapped": true } }, "dutyTaxFees": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "basisQty": { "type": "number", "description": "Calculation of taxes – Tax base quantity (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "basisValue": { "type": "number", "description": "Calculation of taxes – Tax base amount (format: n..16,3) (cardinality: 1x)", "format": "double", "nullable": true }, "dutyRegime": { "type": "string", "description": "Code specifying a type of duty regime (format: an..3) (cardinality: 1x)", "nullable": true }, "quotaId": { "type": "string", "description": "Quota order number (format: an..17) (cardinality: 1x)", "nullable": true }, "rate": { "type": "number", "description": "Calculation of taxes – Tax rate (format: n..17,3) (cardinality: 1x)", "format": "double", "nullable": true }, "type": { "type": "string", "description": "Calculation of taxes – Tax type (format: an..3) (cardinality: 1x)", "nullable": true }, "payment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADDutyTaxFeePayment" }, "rateId": { "type": "string", "description": "The rate Id for the VAT taxes applicable. (format: an..10) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "dutyTaxFee" } }, "nullable": true, "xml": { "wrapped": true } }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADGoodsMeasure" }, "nctsEnquiry": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADNctsEnquiry" }, "nationalReference": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADNationalReference" }, "accDateCode": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "addDeclType1": { "type": "string", "nullable": true }, "addDeclType2": { "type": "string", "nullable": true }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "code": { "type": "string", "description": "Coded form of an additional statement (format: an..17) (cardinality: 1x)", "nullable": true }, "text": { "type": "string", "description": "Description of an additional statement (format: an..512) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Additional statement type (format: an..3) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "description": "CAS internal reference", "nullable": true }, "category": { "type": "string", "description": "Additional document category", "nullable": true }, "issueDate": { "type": "string", "description": "The issue date for XML serialization", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lpcoExemptionCode": { "type": "string", "description": "Additional document status code", "nullable": true }, "refNum": { "type": "string", "description": "Identifier of a document providing additional information", "nullable": true }, "type": { "type": "string", "description": "Additional document type", "nullable": true }, "submitter": { "type": "string", "description": "Document submitter name", "nullable": true } }, "xml": { "name": "additionalDocument" } }, "nullable": true, "xml": { "wrapped": true }, "example": [ { "category": "C", "type": "ABC", "refNum": "DOC-2024-001", "lpcoExemptionCode": "AE", "issueDate": "2024-01-15T09:30:00Z", "name": "Import License" }, { "type": "ABCD", "refNum": "DOC-2024-002", "lpcoExemptionCode": "XX", "issueDate": "2024-01-15T09:30:00Z", "name": "Certificate of Origin" } ] }, "additionalParties": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "partyType": { "type": "string", "description": "Type of the additional party (format: an..3) (cardinality: 1x)", "nullable": true }, "party": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADAdditionalPartyParty" } }, "xml": { "name": "additionalParty" } }, "nullable": true, "xml": { "wrapped": true } }, "agentStatus": { "type": "integer", "format": "int32", "nullable": true }, "declarationOfficeCode": { "type": "string", "nullable": true }, "declType": { "type": "string", "nullable": true }, "destinationOfficeCode": { "type": "string", "nullable": true }, "docRefNum": { "type": "string", "nullable": true }, "crn": { "type": "string", "nullable": true }, "entryOfficeCode": { "type": "string", "nullable": true }, "exitOfficeCode": { "type": "string", "nullable": true }, "invoiceCurrency": { "type": "string", "nullable": true }, "issueDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "loadingDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "presentationDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "issuePlaceCode": { "type": "string", "nullable": true }, "pointOfExit": { "type": "string", "nullable": true }, "pointOfEntry": { "type": "string", "nullable": true }, "presentationOfficeCode": { "type": "string", "nullable": true }, "supervisingOfficeCode": { "type": "string", "nullable": true }, "totalInvoiceAmount": { "type": "number", "format": "double", "nullable": true }, "agent": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "currencyExchange": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADCurrencyExchange" }, "declarant": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "importer": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.BusinessPartner" }, "packaging": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADPackaging" }, "referenceNumbers": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "number": { "type": "string", "description": "Reference number (format: an..35) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Reference type (format: an..15) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "referenceNumber" } }, "nullable": true, "xml": { "wrapped": true } }, "authorizationHolders": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "categoryCode": { "type": "string", "description": "Category code of an authorization holder (format: an..38) (cardinality: 1x)", "nullable": true }, "reference": { "type": "string", "description": "Reference of an authorization holder (format: an..35) (cardinality: 1x)", "nullable": true }, "identifier": { "type": "string", "description": "Identifier of an authorization holder (format: an..35) (cardinality: 1x)", "nullable": true }, "authorizationId": { "type": "string", "description": "Authorization Id of an authorization holder (format: an..17) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "authorizationHolder" } }, "nullable": true, "xml": { "wrapped": true } }, "controlResult": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADControlResult" }, "obligationGuarantee": { "allOf": [ { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.SADObligationGuarantee" } ], "description": "DEPRECATED - Use obligationGuarantees instead.", "deprecated": true }, "obligationGuarantees": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "access": { "type": "string", "description": "Access (format: an..4) (cardinality: 1x)", "nullable": true }, "reference": { "type": "string", "description": "Reference (format: an..64) (cardinality: 1x)", "nullable": true }, "securityDetails": { "type": "string", "description": "Guarantee type (format: an..16) (cardinality: 1x)", "nullable": true }, "amount": { "type": "number", "description": "amount (format: decimal) (cardinality: 1x)", "format": "double", "nullable": true }, "excludedCountries": { "type": "array", "items": { "type": "string", "xml": { "name": "excludedCountry" } }, "description": "Excluded countries (format: a..2) (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } }, "declarationOffice": { "type": "string", "description": "Declaration office (format: an..8) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "obligationGuarantee" } }, "nullable": true, "xml": { "wrapped": true } }, "exportOfficeCode": { "type": "string", "nullable": true }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "billOfLoading": { "type": "string", "description": "Bill of loading (format: an..70) (cardinality: 1x)", "nullable": true }, "category": { "type": "string", "description": "Category of the document (format: an..2) (cardinality: 1x)\r\nThe declaration for temporary storage represented by ‘X’\r\nThe simplified declaration or the entry in the declarant’s records, represented by ‘Y’\r\nThe previous document, represented by ‘Z’", "nullable": true }, "date": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "number": { "type": "string", "description": "The reference number of a previous document (format: an..70) (cardinality: 1x)", "nullable": true }, "type": { "type": "string", "description": "Type of document used for declaration previously presented (format: an..3) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "exciseGoodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.Detail.Excise.ExciseGoodsShipment" }, "transitProcedure": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.TransportContractDocument": { "type": "object", "properties": { "casReference": { "type": "string", "nullable": true }, "id": { "type": "string", "description": "Id (format: an..70) (cardinality: 1x)", "nullable": true }, "typeCode": { "type": "string", "description": "Type Code (format: an..4) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "TransportContractDocument" }, "Cas.Public.Api.Contract.Declarations.Detail.ValidationError": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "message": { "type": "string", "nullable": true }, "description": { "type": "string", "nullable": true }, "fieldReferences": { "type": "array", "items": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true } }, "xml": { "name": "fieldReference" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.Detail.ValidationErrorFieldReference": { "type": "object", "properties": { "fieldName": { "type": "string", "nullable": true }, "path": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.SearchDeclarationRequest": { "type": "object", "properties": { "externalReference": { "type": "string", "description": "External reference number", "nullable": true }, "direction": { "type": "string", "description": "Direction of the shipment, can only be \"IN\" or \"OUT\"", "nullable": true }, "shipFrom": { "type": "string", "description": "Country from where shipment is send (format: ISO 3166-1 2-alpha code)", "nullable": true }, "shipTo": { "type": "string", "description": "Country to which shipment is send (format: ISO 3166-1 2-alpha code)", "nullable": true }, "lrn": { "type": "string", "description": "Local reference number, FunctionRefNum", "nullable": true }, "mrn": { "type": "string", "description": "DocRefNum", "nullable": true }, "arc": { "type": "string", "description": "Administrative reference code", "nullable": true }, "customsFlow": { "type": "string", "description": "Customs flow name", "nullable": true }, "customsFlowStep": { "type": "array", "items": { "type": "string", "xml": { "name": "customsFlowSte" } }, "description": "Customs flow step name", "nullable": true, "xml": { "wrapped": true } }, "currentStatus": { "type": "array", "items": { "type": "string", "xml": { "name": "currentStatu" } }, "description": "Status of declaration", "nullable": true, "xml": { "wrapped": true } }, "jurisdiction": { "type": "array", "items": { "type": "string", "xml": { "name": "jurisdictio" } }, "description": "Customs jurisdiction (format: ISO 3166-1 2-alpha code)", "nullable": true, "xml": { "wrapped": true } }, "storageLocation": { "type": "array", "items": { "type": "string", "xml": { "name": "storageLocatio" } }, "description": "Storage location name", "nullable": true, "xml": { "wrapped": true } }, "ucr": { "type": "string", "description": "Unique Consignment Reference", "nullable": true }, "declarationDateFrom": { "type": "string", "description": "Earliest declaration date (format: Iso8601 datetime string)", "format": "date-time", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "declarationDateTo": { "type": "string", "description": "Latest declaration date (format: Iso8601 datetime string)", "format": "date-time", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "creationDateFrom": { "type": "string", "description": "Earliest date that declaration was created (format: Iso8601 datetime string)", "format": "date-time", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "creationDateTo": { "type": "string", "description": "Latest date that declaration was created (format: Iso8601 datetime string)", "format": "date-time", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "lastUpdatedFrom": { "type": "string", "description": "Earliest that declaration was updated last (format: Iso8601 datetime string)", "format": "date-time", "nullable": true }, "lastUpdatedTo": { "type": "string", "description": "Latest that declaration was updated last (format: Iso8601 datetime string)", "format": "date-time", "nullable": true }, "limit": { "maximum": 100, "minimum": 0, "exclusiveMinimum": true, "type": "integer", "description": "Number of results to retrieve, max 100. Defaults to 100. (format: n..2)", "format": "int32", "default": 100 }, "offset": { "minimum": 0, "type": "integer", "description": "Amount of results to skip, must be at least 0. Should be divisible by the provided Cas.Public.Api.Contract.PagingRequest.Limit. Defaults to 0.", "format": "int32", "default": 0 } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingActionOnSuccess": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingSuccessActionType" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingAdditionalInformation": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "code": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingAdditionalReference": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "typeCode": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingAddress": { "type": "object", "properties": { "line": { "type": "string", "nullable": true }, "zipCode": { "type": "string", "nullable": true }, "city": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingCommodity": { "type": "object", "properties": { "description": { "type": "string", "nullable": true }, "classificationCode": { "type": "string", "nullable": true }, "cusCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingConsignmentEditable": { "type": "object", "properties": { "departureTransportMeans": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "mode": { "type": "string", "nullable": true }, "identification": { "type": "string", "nullable": true }, "identificationType": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "xml": { "name": "departureTransportMean" } }, "nullable": true, "xml": { "wrapped": true } }, "transportEquipments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "identification": { "type": "string", "nullable": true }, "numberOfSeals": { "type": "integer", "format": "int32" }, "seals": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "identification": { "type": "string", "nullable": true } }, "xml": { "name": "seal" } }, "nullable": true, "xml": { "wrapped": true } }, "goodsReferences": { "type": "array", "items": { "type": "integer", "format": "int32", "xml": { "name": "goodsReference" } }, "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "transportEquipment" } }, "nullable": true, "xml": { "wrapped": true } }, "countriesOfRouting": { "type": "array", "items": { "type": "string", "xml": { "name": "countriesOfRoutin" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingDepartureTransportMeans": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "mode": { "type": "string", "nullable": true }, "identification": { "type": "string", "nullable": true }, "identificationType": { "type": "string", "nullable": true }, "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingDestination": { "type": "object", "properties": { "country": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGoodsMeasure": { "type": "object", "properties": { "gmass": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGoodsShipment": { "type": "object", "properties": { "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingDestination" }, "consignor": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingParty" }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingParty" }, "governmentAgencyGoodsItems": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "isMissing": { "type": "boolean" }, "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingCommodity" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingItemGoodsMeasure" }, "packagings": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "shippingMarks": { "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "nullable": true, "xml": { "wrapped": true } }, "addDeclType2": { "type": "string", "nullable": true }, "houseConsignmentSequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "houseConsignmentGoodsItemNumber": { "type": "integer", "format": "int32", "nullable": true }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingDestination" }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingParty" }, "undgs": { "type": "array", "items": { "type": "string", "xml": { "name": "undg" } }, "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "supportingDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true } }, "xml": { "name": "supportingDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "transportDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true } }, "xml": { "name": "transportDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "typeCode": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "code": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "governmentAgencyGoodsItem" } }, "nullable": true, "xml": { "wrapped": true } }, "consignment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingConsignmentEditable" }, "houseConsignments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "grossMass": { "type": "number", "format": "double", "nullable": true } }, "xml": { "name": "houseConsignment" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Read model for goods shipment. Extends the base with read-only fields and the full item model." }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGoodsShipmentEditable": { "type": "object", "properties": { "governmentAgencyGoodsItems": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "isMissing": { "type": "boolean" }, "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingCommodity" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingItemGoodsMeasure" }, "packagings": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "shippingMarks": { "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "nullable": true, "xml": { "wrapped": true } }, "addDeclType2": { "type": "string", "nullable": true }, "houseConsignmentSequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "houseConsignmentGoodsItemNumber": { "type": "integer", "format": "int32", "nullable": true }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingDestination" }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingParty" }, "undgs": { "type": "array", "items": { "type": "string", "xml": { "name": "undg" } }, "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "supportingDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true } }, "xml": { "name": "supportingDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "transportDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true } }, "xml": { "name": "transportDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "typeCode": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "code": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "governmentAgencyGoodsItem" } }, "nullable": true, "xml": { "wrapped": true } }, "consignment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingConsignmentEditable" }, "houseConsignments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "grossMass": { "type": "number", "format": "double", "nullable": true } }, "xml": { "name": "houseConsignment" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGovernmentAgencyGoodsItem": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "isMissing": { "type": "boolean" }, "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingCommodity" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingItemGoodsMeasure" }, "packagings": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "shippingMarks": { "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "nullable": true, "xml": { "wrapped": true } }, "addDeclType2": { "type": "string", "nullable": true }, "houseConsignmentSequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "houseConsignmentGoodsItemNumber": { "type": "integer", "format": "int32", "nullable": true }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingDestination" }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingParty" }, "undgs": { "type": "array", "items": { "type": "string", "xml": { "name": "undg" } }, "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "supportingDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true } }, "xml": { "name": "supportingDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "transportDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true } }, "xml": { "name": "transportDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "typeCode": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "code": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Read model for government agency goods items. All fields are now on the editable base.\r\nThis type is kept for the GET response so the read and edit shapes remain distinct." }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGovernmentAgencyGoodsItemEditable": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "isMissing": { "type": "boolean" }, "commodity": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingCommodity" }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingItemGoodsMeasure" }, "packagings": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "shippingMarks": { "type": "string", "nullable": true } }, "xml": { "name": "packaging" } }, "nullable": true, "xml": { "wrapped": true } }, "addDeclType2": { "type": "string", "nullable": true }, "houseConsignmentSequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "houseConsignmentGoodsItemNumber": { "type": "integer", "format": "int32", "nullable": true }, "destination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingDestination" }, "consignee": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingParty" }, "undgs": { "type": "array", "items": { "type": "string", "xml": { "name": "undg" } }, "nullable": true, "xml": { "wrapped": true } }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "supportingDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true } }, "xml": { "name": "supportingDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "transportDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true } }, "xml": { "name": "transportDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "typeCode": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "code": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingHouseConsignment": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "grossMass": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformation": { "type": "object", "properties": { "docRefNum": { "type": "string", "nullable": true }, "accDateCode": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "addDeclType2": { "type": "string", "nullable": true }, "declarant": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingParty" }, "goodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGoodsShipment" }, "previousDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "xml": { "name": "previousDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalInformations": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "code": { "type": "string", "nullable": true }, "text": { "type": "string", "nullable": true } }, "xml": { "name": "additionalInformation" } }, "nullable": true, "xml": { "wrapped": true } }, "unloadingRemarks": { "type": "string", "nullable": true }, "otherThingsToReport": { "type": "string", "nullable": true }, "unloadingDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "isConform": { "type": "boolean", "nullable": true }, "continueUnloading": { "type": "boolean", "nullable": true }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGoodsMeasure" }, "supportingDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true } }, "xml": { "name": "supportingDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "transportDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true } }, "xml": { "name": "transportDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "typeCode": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Full read model for GET responses. Extends the base with read-only fields and the full goods shipment model." }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationEditable": { "type": "object", "properties": { "goodsShipment": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGoodsShipmentEditable" }, "unloadingRemarks": { "type": "string", "nullable": true }, "otherThingsToReport": { "type": "string", "nullable": true }, "unloadingDate": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "isConform": { "type": "boolean", "nullable": true }, "continueUnloading": { "type": "boolean", "nullable": true }, "goodsMeasure": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingGoodsMeasure" }, "supportingDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true } }, "xml": { "name": "supportingDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "transportDocuments": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true } }, "xml": { "name": "transportDocument" } }, "nullable": true, "xml": { "wrapped": true } }, "additionalReferences": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "typeCode": { "type": "string", "nullable": true }, "id": { "type": "string", "nullable": true } }, "xml": { "name": "additionalReference" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Editable model for PATCH requests. Only contains fields that can be updated." }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationPatchRequest": { "required": [ "unloadingInformation" ], "type": "object", "properties": { "options": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingOptions" }, "unloadingInformation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationEditable" } }, "additionalProperties": false, "description": "Request body for PATCH /v1/declarations/{declarationId}/unloadingInformation" }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformationResponse": { "type": "object", "properties": { "isEditable": { "type": "boolean" }, "unloadingInformation": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingInformation" } }, "additionalProperties": false, "description": "Response wrapper for GET /v1/declarations/{declarationId}/unloadingInformation" }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingItemGoodsMeasure": { "type": "object", "properties": { "gmass": { "type": "number", "format": "double", "nullable": true }, "nmass": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingOptions": { "type": "object", "properties": { "actionsOnSuccess": { "type": "array", "items": { "type": "object", "properties": { "action": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingSuccessActionType" } }, "xml": { "name": "actionsOnSucces" } }, "description": "The actions to perform on success", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingPackaging": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "quantity": { "type": "integer", "format": "int32", "nullable": true }, "shippingMarks": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingParty": { "type": "object", "properties": { "code": { "type": "string", "nullable": true }, "name": { "type": "string", "nullable": true }, "address": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingAddress" } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingPreviousDocument": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "number": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true }, "lineNumber": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingSeal": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "identification": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingSuccessActionType": { "enum": [ "submit" ], "type": "string", "description": "The type of action to perform on success

Possible values:

", "example": "submit" }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingSupportingDocument": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true }, "complementaryInformation": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingTransportDocument": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "type": { "type": "string", "nullable": true }, "refNum": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Declarations.UnloadingInformation.UnloadingTransportEquipment": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "identification": { "type": "string", "nullable": true }, "numberOfSeals": { "type": "integer", "format": "int32" }, "seals": { "type": "array", "items": { "type": "object", "properties": { "seqNum": { "type": "integer", "format": "int32", "nullable": true }, "identification": { "type": "string", "nullable": true } }, "xml": { "name": "seal" } }, "nullable": true, "xml": { "wrapped": true } }, "goodsReferences": { "type": "array", "items": { "type": "integer", "format": "int32", "xml": { "name": "goodsReference" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false }, "Cas.Public.Api.Contract.Documents.AttachmentUrl": { "type": "object", "properties": { "url": { "type": "string", "description": "A temporary url that can be used to retrieve the attachment content through a GET request.", "nullable": true } }, "additionalProperties": false, "description": "Wrapper for a temporary url to download the attachment." }, "Cas.Public.Api.Contract.Ingestions.ReturnOnAcceptMessage": { "type": "object", "properties": { "referenceId": { "type": "string", "description": "The unique identifier referring to the ingested message.", "nullable": true } }, "additionalProperties": false, "description": "Accept response for an ingested message" }, "Cas.Public.Api.Contract.Ingestions.ReturnOnCreateMessage": { "type": "object", "properties": { "referenceId": { "type": "string", "description": "The unique identifier referring to the ingested message", "nullable": true } }, "additionalProperties": false, "description": "Response message for an ingested message" }, "Cas.Public.Api.Contract.InvalidParameter": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "additionalProperties": false }, "Cas.Public.Api.Contract.MovementOrders.MovementCategory": { "enum": [ "Unknown", "DepartureUnderSuspension", "Export", "ArrivalUnderSuspension", "Production", "OtherArrival" ], "type": "string", "description": "The category defines in which column on the excise register the quantity will be shown.

Possible values:

", "example": "Unknown" }, "Cas.Public.Api.Contract.MovementOrders.MovementOrder": { "type": "object", "properties": { "timestamp": { "type": "string", "nullable": true, "example": "2024-01-15T09:30:00Z" }, "documentReference": { "type": "string", "description": "Reference to the document that triggered the creation of movement order (format: an..255) (cardinality: 1x)", "nullable": true }, "externalReference": { "type": "string", "description": "Unique external reference of the movement order (format: an..255) (cardinality: 1x)", "nullable": true }, "type": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.MovementOrders.MovementType" }, "externalMovementType": { "type": "string", "description": "Type of movement as known by inventory or warehouse management system (format: an..255) (cardinality: 1x)", "nullable": true }, "status": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.MovementOrders.MovementOrderStatus" }, "category": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.MovementOrders.MovementCategory" }, "remark": { "type": "string", "description": "Used for a tax warehouse stock correction, as shown in column '7. Remarks' of the excise register (format: an..255) (cardinality: 1x)", "nullable": true }, "adjustmentData": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.MovementOrders.MovementOrderAdjustmentData" }, "lines": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Unique identifier of the item/material as defined in master data (format: an..255) (cardinality: 1x)", "nullable": true }, "itemDescription": { "type": "string", "description": "Description for the item (format: an..255) (cardinality: 1x)", "nullable": true }, "direction": { "type": "string", "description": "Direction of the movement order line (format: an..10) (cardinality: 1x)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the item (format: an..255) (cardinality: 1x)", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of the item in the base unit of measure as defined in master data (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "uom": { "type": "string", "description": "Unit of measure in which the quantity is defined. The base unit of measure as defined in master data (format: an..10) (cardinality: 1x)", "nullable": true }, "exciseProductCode": { "type": "string", "description": "Excise Product code (format: an..10) (cardinality: 1x)", "nullable": true }, "asv": { "type": "number", "description": "Alcohol % by volume (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "storageLocationReference": { "type": "string", "description": "Storage location reference as known in CAS (format: an..255) (cardinality: 1x)", "nullable": true }, "authorizationId": { "type": "string", "description": "The special procedure or tax warehouse authorisation the movement order is executed against (format: an..255) (cardinality: 1x)", "nullable": true }, "receivingStorageLocationReference": { "type": "string", "description": "The receiving storage location, in case of transfer movement orders (TRFA or TRFR) (format: an..255) (cardinality: 1x)", "nullable": true }, "receivingAuthorizationId": { "type": "string", "description": "The receiving authorization, in case of transfer movement orders (TRFA or TRFR) (format: an..255) (cardinality: 1x)", "nullable": true }, "preferentialOriginCountry": { "type": "string", "description": "The preferential origin country of a good being produced (format: an2) (cardinality: 1x)", "nullable": true }, "nonPreferentialOriginCountry": { "type": "string", "description": "The non-preferential origin country of a good being produced (format: an2) (cardinality: 1x)", "nullable": true }, "blendResult": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.MovementOrders.MovementOrderLineBlendResult" }, "quantities": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "type": "number", "description": "Quantity of the item in a given UoM (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "uom": { "type": "string", "description": "Unit of measure in which the quantity is defined (format: an..10) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "quantity" } }, "description": "A list of additional quantities (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } } }, "xml": { "name": "line" } }, "description": "The item level data of the movement order (cardinality: 9999x)", "nullable": true, "xml": { "wrapped": true } }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "Error code (format: an..100) (cardinality: 1x)", "nullable": true }, "errorMessage": { "type": "string", "description": "Error message (format: an..500) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "validationError" } }, "description": "List of current validation errors (cardinality: 999x)", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "MovementOrder" }, "Cas.Public.Api.Contract.MovementOrders.MovementOrderAdjustmentData": { "type": "object", "properties": { "administrativeReferenceCode": { "type": "string", "description": "ARC of an e-AD, for a positive or negative correction movement order related to an e-AD (format: an..21) (cardinality: 1x)", "nullable": true }, "arcSequenceNumber": { "type": "string", "description": "Sequence number of an e-AD, for a positive or negative correction movement order related to an e-AD (format: n..5) (cardinality: 1x)", "nullable": true }, "docRefNum": { "type": "string", "description": "MRN of a related export, for a positive or negative correction movement order related to an e-AD for export (format: an..21) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "MovementOrderAdjustmentData" }, "Cas.Public.Api.Contract.MovementOrders.MovementOrderLine": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Unique identifier of the item/material as defined in master data (format: an..255) (cardinality: 1x)", "nullable": true }, "itemDescription": { "type": "string", "description": "Description for the item (format: an..255) (cardinality: 1x)", "nullable": true }, "direction": { "type": "string", "description": "Direction of the movement order line (format: an..10) (cardinality: 1x)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the item (format: an..255) (cardinality: 1x)", "nullable": true }, "quantity": { "type": "number", "description": "Quantity of the item in the base unit of measure as defined in master data (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "uom": { "type": "string", "description": "Unit of measure in which the quantity is defined. The base unit of measure as defined in master data (format: an..10) (cardinality: 1x)", "nullable": true }, "exciseProductCode": { "type": "string", "description": "Excise Product code (format: an..10) (cardinality: 1x)", "nullable": true }, "asv": { "type": "number", "description": "Alcohol % by volume (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "storageLocationReference": { "type": "string", "description": "Storage location reference as known in CAS (format: an..255) (cardinality: 1x)", "nullable": true }, "authorizationId": { "type": "string", "description": "The special procedure or tax warehouse authorisation the movement order is executed against (format: an..255) (cardinality: 1x)", "nullable": true }, "receivingStorageLocationReference": { "type": "string", "description": "The receiving storage location, in case of transfer movement orders (TRFA or TRFR) (format: an..255) (cardinality: 1x)", "nullable": true }, "receivingAuthorizationId": { "type": "string", "description": "The receiving authorization, in case of transfer movement orders (TRFA or TRFR) (format: an..255) (cardinality: 1x)", "nullable": true }, "preferentialOriginCountry": { "type": "string", "description": "The preferential origin country of a good being produced (format: an2) (cardinality: 1x)", "nullable": true }, "nonPreferentialOriginCountry": { "type": "string", "description": "The non-preferential origin country of a good being produced (format: an2) (cardinality: 1x)", "nullable": true }, "blendResult": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.MovementOrders.MovementOrderLineBlendResult" }, "quantities": { "type": "array", "items": { "type": "object", "properties": { "quantity": { "type": "number", "description": "Quantity of the item in a given UoM (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "uom": { "type": "string", "description": "Unit of measure in which the quantity is defined (format: an..10) (cardinality: 1x)", "nullable": true } }, "xml": { "name": "quantity" } }, "description": "A list of additional quantities (cardinality: 99x)", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "MovementOrderLine" }, "Cas.Public.Api.Contract.MovementOrders.MovementOrderLineBlendResult": { "type": "object", "properties": { "itemId": { "type": "string", "description": "Unique identifier of the item/material as defined in master data that will be the result of a TRFB (Transfer + Blend) movement order (format: an..255) (cardinality: 1x)", "nullable": true }, "exciseProductCode": { "type": "string", "description": "Excise Product code of the result of a TRFB (Transfer + Blend) movement order (format: an..10) (cardinality: 1x)", "nullable": true }, "serialBatchReference": { "type": "string", "description": "Unique serial or batch number of the result of a TRFB (Transfer + Blend) movement order (format: an..255) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "MovementOrderLineBlendResult" }, "Cas.Public.Api.Contract.MovementOrders.MovementOrderLineQuantity": { "type": "object", "properties": { "quantity": { "type": "number", "description": "Quantity of the item in a given UoM (format: n..16,6) (cardinality: 1x)", "format": "double", "nullable": true }, "uom": { "type": "string", "description": "Unit of measure in which the quantity is defined (format: an..10) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "MovementOrderLineQuantity" }, "Cas.Public.Api.Contract.MovementOrders.MovementOrderStatus": { "enum": [ "Unknown", "Valid", "Invalid", "Submitted", "Processed", "ProcessingError", "Invalidating", "Invalidated", "InvalidationRejected", "MissingDensity" ], "type": "string", "description": "Current status of the movement order.

Possible values:

", "example": "Unknown" }, "Cas.Public.Api.Contract.MovementOrders.MovementOrderValidationError": { "type": "object", "properties": { "errorCode": { "type": "string", "description": "Error code (format: an..100) (cardinality: 1x)", "nullable": true }, "errorMessage": { "type": "string", "description": "Error message (format: an..500) (cardinality: 1x)", "nullable": true } }, "additionalProperties": false, "description": "MovementOrderValidationError" }, "Cas.Public.Api.Contract.MovementOrders.MovementType": { "enum": [ "Unknown", "PROC", "UFOH", "ADJP", "ADJN", "TRFA", "TRFR", "TRFB", "RFFC", "DCSV" ], "type": "string", "description": "CAS movement order type.

Possible values:

", "example": "Unknown" }, "Cas.Public.Api.Contract.Notifications.AdditionalHeader": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the HTTP header to add.", "nullable": true }, "value": { "type": "string", "description": "The value of the HTTP header to add.", "nullable": true } }, "additionalProperties": false, "description": "An additional HTTP header to include in the notification POST requests." }, "Cas.Public.Api.Contract.Notifications.DestinationDescription": { "required": [ "destinationUrl" ], "type": "object", "properties": { "destinationUrl": { "minLength": 1, "type": "string", "description": "The URL of the endpoint on the receiver's end to POST notifications to." }, "accessTokenUrl": { "type": "string", "description": "Optional: The URL CAS should use to retrieve an access token for the receiver's system through the OAuth 2.0 client-credentials flow.\r\nWhen used, the ClientId, ClientSecret, Scope (optional) & Audience (optional) should be provided to use on the token request.\r\nThis access token will then be provided in the ```Authorization``` header of the POST request, using the ```Bearer``` scheme.\r\nWhen this URL is left empty, no token will be retrieved and POST requests will be made to the ```DestinationUrl``` without Authorization header.", "nullable": true }, "clientId": { "type": "string", "description": "The Client Identifier to use when authenticating with ```AccessTokenUrl```. Only to be provided when ```AccessTokenUrl``` is used.", "nullable": true }, "clientSecret": { "type": "string", "description": "The Client Secret to use when authenticating with ```AccessTokenUrl```. Only to be provided when ```AccessTokenUrl``` is used.", "nullable": true }, "scope": { "type": "string", "description": "The scope of the access request, which may have multiple space delimited values. Only to be provided when ```AccessTokenUrl``` is used.", "nullable": true }, "audience": { "type": "string", "description": "Audience of the access request if needed. Only to be provided when ```AccessTokenUrl``` is used.", "nullable": true }, "additionalHeaders": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the HTTP header to add.", "nullable": true }, "value": { "type": "string", "description": "The value of the HTTP header to add.", "nullable": true } }, "xml": { "name": "additionalHeader" } }, "description": "Optional list of additional HTTP headers to include in the notification POST requests.", "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "The description of the endpoint to send notifications to." }, "Cas.Public.Api.Contract.Notifications.SubscriptionCreation": { "required": [ "eventType", "subscriptionDestination" ], "type": "object", "properties": { "eventType": { "minLength": 1, "type": "string", "description": "The Type of events the subscription is interested in" }, "eventSubType": { "type": "string", "description": "If provided, we filter down the events of the provided Cas.Public.Api.Contract.Notifications.SubscriptionCreation.EventType to only this subType. If left empty, all subTypes for the provided Cas.Public.Api.Contract.Notifications.SubscriptionCreation.EventType are included.", "nullable": true }, "plantId": { "type": "string", "description": "Optionally you can filter on the events that are related with a certain plant. To receive the events of the entire tenant, leave this field empty. Use is discouraged at this point, but not prohibited.", "nullable": true }, "subscriptionDestination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.SubscriptionDestination" } }, "additionalProperties": false, "description": "The subscription model describes the details of a subscription." }, "Cas.Public.Api.Contract.Notifications.SubscriptionDestination": { "required": [ "destinationDescription" ], "type": "object", "properties": { "destinationType": { "type": "string", "description": "Specifies the destination type. Only 'OAuthApiDestination' is supported (even when no OAuth is used).", "nullable": true }, "destinationDescription": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.DestinationDescription" } }, "additionalProperties": false, "description": "This model describes the destination of a notification." }, "Cas.Public.Api.Contract.Notifications.SubscriptionDetails": { "required": [ "eventType", "subscriptionDestination" ], "type": "object", "properties": { "id": { "type": "string", "description": "Id of the subscription. Only relevant for retrieval of existing subscriptions, ignored for new subscriptions.", "nullable": true }, "eventType": { "minLength": 1, "type": "string", "description": "The Type of events the subscription is interested in" }, "eventSubType": { "type": "string", "description": "If provided, we filter down the events of the provided Cas.Public.Api.Contract.Notifications.SubscriptionCreation.EventType to only this subType. If left empty, all subTypes for the provided Cas.Public.Api.Contract.Notifications.SubscriptionCreation.EventType are included.", "nullable": true }, "plantId": { "type": "string", "description": "Optionally you can filter on the events that are related with a certain plant. To receive the events of the entire tenant, leave this field empty. Use is discouraged at this point, but not prohibited.", "nullable": true }, "subscriptionDestination": { "$ref": "#/components/schemas/Cas.Public.Api.Contract.Notifications.SubscriptionDestination" } }, "additionalProperties": false, "description": "The subscription model describes the details of a subscription." }, "Cas.Public.Api.Contract.Rffc7807BadRequest": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32" }, "detail": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true }, "invalid-parameters": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "reason": { "type": "string", "nullable": true } }, "xml": { "name": "invalid-parameter" } }, "nullable": true, "xml": { "wrapped": true } } }, "additionalProperties": false, "description": "Contains details of an error that occurred while invoking the API." }, "Cas.Public.Api.Infrastructure.Auth.AuthorizationDetails": { "type": "object", "properties": { "sourceSysRef": { "type": "string", "description": "Source system reference found for the provided token", "nullable": true }, "tenantIds": { "type": "string", "description": "Allowed tenants for the provided token", "nullable": true }, "scopes": { "type": "string", "description": "Scopes available in the provided token", "nullable": true } }, "additionalProperties": false, "description": "Public API Authorized Status response model" } }, "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }