From cff152ed0c928378f85e28052937cd80f2eb1386 Mon Sep 17 00:00:00 2001 From: Nico Koprowski Date: Mon, 8 Jan 2024 16:22:13 +0800 Subject: [PATCH] docs(Api): add updated API documentation for BPDM version 5.0.0 --- docs/api/gate.json | 874 ++++++++++++++++++-------- docs/api/gate.yaml | 1457 ++++++++++++++++++-------------------------- docs/api/pool.json | 638 ++++++++++--------- docs/api/pool.yaml | 1410 ++++++++++++------------------------------ 4 files changed, 1917 insertions(+), 2462 deletions(-) diff --git a/docs/api/gate.json b/docs/api/gate.json index 01f554cce..fd4870749 100644 --- a/docs/api/gate.json +++ b/docs/api/gate.json @@ -3,7 +3,7 @@ "info": { "title": "Business Partner Data Management Gate", "description": "A gate for a member to share business partner data with CatenaX", - "version": "4.1.0" + "version": "5.0.0-SNAPSHOT" }, "servers": [ { @@ -107,6 +107,33 @@ "400": { "description": "Invalid data (e.g. external ID)" } + }, + "deprecated": true + }, + "post": { + "tags": [ + "sharing-state-controller" + ], + "summary": "Sets the given business partners into ready to be shared state", + "description": "The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach).", + "operationId": "postSharingStateReady", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/PostSharingStateReadyRequest" + } + } + }, + "required": true + }, + "responses": { + "204": { + "description": "All business partners put in ready to be shared state" + }, + "404": { + "description": "Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state)" + } } } }, @@ -145,7 +172,8 @@ "400": { "description": "On malformed site request" } - } + }, + "deprecated": true } }, "/api/catena/output/legal-entities": { @@ -183,7 +211,8 @@ "400": { "description": "On malformed legal entity request" } - } + }, + "deprecated": true } }, "/api/catena/output/addresses": { @@ -221,7 +250,8 @@ "400": { "description": "On malformed address request" } - } + }, + "deprecated": true } }, "/api/catena/input/sites": { @@ -271,7 +301,8 @@ "400": { "description": "On malformed pagination request" } - } + }, + "deprecated": true }, "put": { "tags": [ @@ -307,7 +338,8 @@ "400": { "description": "On malformed site request" } - } + }, + "deprecated": true } }, "/api/catena/input/legal-entities": { @@ -357,7 +389,8 @@ "400": { "description": "On malformed pagination request" } - } + }, + "deprecated": true }, "put": { "tags": [ @@ -393,7 +426,8 @@ "400": { "description": "On malformed legal entity request" } - } + }, + "deprecated": true } }, "/api/catena/input/business-partners": { @@ -484,7 +518,8 @@ "400": { "description": "On malformed pagination request" } - } + }, + "deprecated": true }, "put": { "tags": [ @@ -520,7 +555,8 @@ "400": { "description": "On malformed address request" } - } + }, + "deprecated": true } }, "/api/catena/output/sites/search": { @@ -582,7 +618,8 @@ "400": { "description": "On malformed pagination request" } - } + }, + "deprecated": true } }, "/api/catena/output/legal-entities/search": { @@ -644,7 +681,8 @@ "400": { "description": "On malformed pagination request" } - } + }, + "deprecated": true } }, "/api/catena/output/changelog/search": { @@ -828,7 +866,8 @@ "400": { "description": "On malformed pagination request" } - } + }, + "deprecated": true } }, "/api/catena/input/sites/search": { @@ -891,7 +930,8 @@ "400": { "description": "On malformed pagination request" } - } + }, + "deprecated": true } }, "/api/catena/input/legal-entities/search": { @@ -954,7 +994,8 @@ "400": { "description": "On malformed pagination request" } - } + }, + "deprecated": true } }, "/api/catena/input/changelog/search": { @@ -1139,6 +1180,101 @@ "400": { "description": "On malformed pagination request" } + }, + "deprecated": true + } + }, + "/api/catena/stats/{stage}/address-types": { + "get": { + "tags": [ + "stats-controller" + ], + "operationId": "countAddressTypes", + "parameters": [ + { + "name": "stage", + "in": "path", + "required": true, + "schema": { + "type": "string", + "enum": [ + "Input", + "Output" + ] + } + } + ], + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatsAddressTypesResponse" + } + } + } + } + } + } + }, + "/api/catena/stats/stages": { + "get": { + "tags": [ + "stats-controller" + ], + "operationId": "countPartnersPerStage", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatsStagesResponse" + } + } + } + } + } + } + }, + "/api/catena/stats/sharing-states": { + "get": { + "tags": [ + "stats-controller" + ], + "operationId": "countPartnersBySharingState", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatsSharingStatesResponse" + } + } + } + } + } + } + }, + "/api/catena/stats/confidence-criteria": { + "get": { + "tags": [ + "stats-controller" + ], + "operationId": "getConfidenceCriteriaStats", + "responses": { + "200": { + "description": "OK", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/StatsConfidenceCriteriaResponse" + } + } + } + } } } }, @@ -1196,7 +1332,8 @@ "404": { "description": "No site found under specified external ID" } - } + }, + "deprecated": true } }, "/api/catena/input/legal-entities/{externalId}": { @@ -1232,7 +1369,8 @@ "404": { "description": "No legal entity found under specified external ID" } - } + }, + "deprecated": true } }, "/api/catena/input/addresses/{externalId}": { @@ -1268,12 +1406,49 @@ "404": { "description": "No address found under specified external ID" } - } + }, + "deprecated": true } } }, "components": { "schemas": { + "AddressComponentOutputDto": { + "required": [ + "bpnA" + ], + "type": "object", + "properties": { + "addressBpn": { + "type": "string", + "description": "The BPNA of the address, on which the business partner provides a view." + }, + "name": { + "type": "string", + "description": "The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance." + }, + "addressType": { + "type": "string", + "description": "One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ", + "enum": [ + "LegalAndSiteMainAddress", + "LegalAddress", + "SiteMainAddress", + "AdditionalAddress" + ] + }, + "physicalPostalAddress": { + "$ref": "#/components/schemas/PhysicalPostalAddressDto" + }, + "alternativePostalAddress": { + "$ref": "#/components/schemas/AlternativePostalAddressDto" + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + } + }, + "description": "Address properties of business partner output data" + }, "AddressGateInputDto": { "type": "object", "properties": { @@ -1299,10 +1474,10 @@ } }, "physicalPostalAddress": { - "$ref": "#/components/schemas/PhysicalPostalAddressGateDto" + "$ref": "#/components/schemas/PhysicalPostalAddressDto" }, "alternativePostalAddress": { - "$ref": "#/components/schemas/AlternativePostalAddressGateDto" + "$ref": "#/components/schemas/AlternativePostalAddressDto" }, "roles": { "type": "array", @@ -1311,10 +1486,15 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "externalId": { "type": "string", "description": "The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner." @@ -1355,10 +1535,10 @@ } }, "physicalPostalAddress": { - "$ref": "#/components/schemas/PhysicalPostalAddressGateDto" + "$ref": "#/components/schemas/PhysicalPostalAddressDto" }, "alternativePostalAddress": { - "$ref": "#/components/schemas/AlternativePostalAddressGateDto" + "$ref": "#/components/schemas/AlternativePostalAddressDto" }, "roles": { "type": "array", @@ -1367,10 +1547,15 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "externalId": { "type": "string", "description": "The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner." @@ -1411,10 +1596,10 @@ } }, "physicalPostalAddress": { - "$ref": "#/components/schemas/PhysicalPostalAddressGateDto" + "$ref": "#/components/schemas/PhysicalPostalAddressDto" }, "alternativePostalAddress": { - "$ref": "#/components/schemas/AlternativePostalAddressGateDto" + "$ref": "#/components/schemas/AlternativePostalAddressDto" }, "roles": { "type": "array", @@ -1423,10 +1608,15 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "bpn": { "type": "string", "description": "A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity." @@ -1459,10 +1649,10 @@ } }, "physicalPostalAddress": { - "$ref": "#/components/schemas/PhysicalPostalAddressGateDto" + "$ref": "#/components/schemas/PhysicalPostalAddressDto" }, "alternativePostalAddress": { - "$ref": "#/components/schemas/AlternativePostalAddressGateDto" + "$ref": "#/components/schemas/AlternativePostalAddressDto" }, "roles": { "type": "array", @@ -1471,10 +1661,15 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "externalId": { "type": "string", "description": "The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner." @@ -1519,10 +1714,10 @@ } }, "physicalPostalAddress": { - "$ref": "#/components/schemas/PhysicalPostalAddressGateDto" + "$ref": "#/components/schemas/PhysicalPostalAddressDto" }, "alternativePostalAddress": { - "$ref": "#/components/schemas/AlternativePostalAddressGateDto" + "$ref": "#/components/schemas/AlternativePostalAddressDto" }, "roles": { "type": "array", @@ -1531,10 +1726,15 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "externalId": { "type": "string", "description": "The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner." @@ -1568,12 +1768,41 @@ }, "description": "An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN)." }, + "AddressRepresentationInputDto": { + "type": "object", + "properties": { + "addressBpn": { + "type": "string", + "description": "The BPNA of the address, on which the business partner provides a view." + }, + "name": { + "type": "string", + "description": "The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance." + }, + "addressType": { + "type": "string", + "description": "One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ", + "enum": [ + "LegalAndSiteMainAddress", + "LegalAddress", + "SiteMainAddress", + "AdditionalAddress" + ] + }, + "physicalPostalAddress": { + "$ref": "#/components/schemas/PhysicalPostalAddressDto" + }, + "alternativePostalAddress": { + "$ref": "#/components/schemas/AlternativePostalAddressDto" + } + }, + "description": "The address, on which the business partner provides a view. " + }, "AddressStateDto": { "type": "object", "properties": { "description": { - "type": "string", - "description": "The description from the original source indicating the state of the address." + "type": "string" }, "validFrom": { "type": "string", @@ -1596,7 +1825,7 @@ }, "description": "An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address." }, - "AlternativePostalAddressGateDto": { + "AlternativePostalAddressDto": { "type": "object", "properties": { "geographicCoordinates": { @@ -1912,30 +2141,50 @@ }, "description": "An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else." }, + "BusinessPartnerClassificationDto": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of classification.", + "enum": [ + "NACE", + "NAF", + "NAICS", + "SIC" + ] + }, + "code": { + "type": "string", + "description": "The identifier of the class belonging to the classification." + }, + "value": { + "type": "string", + "description": "The name of the class belonging to the classification." + } + } + }, "BusinessPartnerIdentifierDto": { - "required": [ - "type", - "value" - ], "type": "object", "properties": { "type": { "type": "string", - "description": "Technical key of the type to which this identifier belongs to" + "description": "The type of the identifier." }, "value": { "type": "string", - "description": "Value of the identifier" + "description": "The value of the identifier like “DE123465789." }, "issuingBody": { "type": "string", - "description": "Body which issued the identifier" + "description": "The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart." } - }, - "description": "Identifier record for a business partner" + } }, "BusinessPartnerInputDto": { "required": [ + "bpnA", + "bpnL", "externalId", "postalAddress" ], @@ -1952,10 +2201,6 @@ "type": "string" } }, - "shortName": { - "type": "string", - "description": "Abbreviated name or shorthand." - }, "identifiers": { "type": "array", "description": "The list of identifiers of the business partner. Sorted and duplicates removed by the service.", @@ -1963,13 +2208,6 @@ "$ref": "#/components/schemas/BusinessPartnerIdentifierDto" } }, - "legalName": { - "type": "string" - }, - "legalForm": { - "type": "string", - "description": "Technical key of the legal form." - }, "states": { "type": "array", "description": "The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.", @@ -1977,38 +2215,27 @@ "$ref": "#/components/schemas/BusinessPartnerStateDto" } }, - "classifications": { - "type": "array", - "description": "The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.", - "items": { - "$ref": "#/components/schemas/ClassificationBusinessPartnerDto" - } - }, "roles": { "type": "array", - "description": "Roles this business partner takes in relation to the sharing member. Sorted and duplicates removed by the service.", + "description": "One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.", "items": { "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, - "postalAddress": { - "$ref": "#/components/schemas/BusinessPartnerPostalAddressDto" - }, - "legalEntityBpn": { - "type": "string", - "description": "BPNL of the golden record legal entity this business partner refers to" + "legalEntity": { + "$ref": "#/components/schemas/LegalEntityRepresentationInputDto" }, - "siteBpn": { - "type": "string", - "description": "BPNS of the golden record site this business partner refers to" + "site": { + "$ref": "#/components/schemas/SiteRepresentationInputDto" }, - "addressBpn": { - "type": "string", - "description": "BPNA of the golden record address this business partner refers to" + "address": { + "$ref": "#/components/schemas/AddressRepresentationInputDto" }, "createdAt": { "type": "string", @@ -2022,7 +2249,7 @@ }, "ownCompanyData": { "type": "boolean", - "description": "True if the sharing member declares itself as the owner of the business partner." + "description": "Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member." } }, "description": "Generic business partner with external id" @@ -2044,10 +2271,6 @@ "type": "string" } }, - "shortName": { - "type": "string", - "description": "Abbreviated name or shorthand." - }, "identifiers": { "type": "array", "description": "The list of identifiers of the business partner. Sorted and duplicates removed by the service.", @@ -2055,13 +2278,6 @@ "$ref": "#/components/schemas/BusinessPartnerIdentifierDto" } }, - "legalName": { - "type": "string" - }, - "legalForm": { - "type": "string", - "description": "Technical key of the legal form." - }, "states": { "type": "array", "description": "The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.", @@ -2069,52 +2285,38 @@ "$ref": "#/components/schemas/BusinessPartnerStateDto" } }, - "classifications": { - "type": "array", - "description": "The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.", - "items": { - "$ref": "#/components/schemas/ClassificationBusinessPartnerDto" - } - }, "roles": { "type": "array", - "description": "Roles this business partner takes in relation to the sharing member. Sorted and duplicates removed by the service.", + "description": "One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.", "items": { "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, - "postalAddress": { - "$ref": "#/components/schemas/BusinessPartnerPostalAddressDto" - }, - "legalEntityBpn": { - "type": "string", - "description": "BPNL of the golden record legal entity this business partner refers to" + "legalEntity": { + "$ref": "#/components/schemas/LegalEntityRepresentationInputDto" }, - "siteBpn": { - "type": "string", - "description": "BPNS of the golden record site this business partner refers to" + "site": { + "$ref": "#/components/schemas/SiteRepresentationInputDto" }, - "addressBpn": { - "type": "string", - "description": "BPNA of the golden record address this business partner refers to" + "address": { + "$ref": "#/components/schemas/AddressRepresentationInputDto" }, "ownCompanyData": { "type": "boolean", - "description": "True if the sharing member declares itself as the owner of the business partner." + "description": "Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member." } }, "description": "Generic business partner with external id" }, "BusinessPartnerOutputDto": { "required": [ - "bpnA", - "bpnL", - "externalId", - "postalAddress" + "externalId" ], "type": "object", "properties": { @@ -2129,10 +2331,6 @@ "type": "string" } }, - "shortName": { - "type": "string", - "description": "Abbreviated name or shorthand." - }, "identifiers": { "type": "array", "description": "The list of identifiers of the business partner. Sorted and duplicates removed by the service.", @@ -2140,13 +2338,6 @@ "$ref": "#/components/schemas/BusinessPartnerIdentifierDto" } }, - "legalName": { - "type": "string" - }, - "legalForm": { - "type": "string", - "description": "Technical key of the legal form." - }, "states": { "type": "array", "description": "The list of (temporary) states of the business partner. Sorted and duplicates removed by the service.", @@ -2154,38 +2345,27 @@ "$ref": "#/components/schemas/BusinessPartnerStateDto" } }, - "classifications": { - "type": "array", - "description": "The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.", - "items": { - "$ref": "#/components/schemas/ClassificationDto" - } - }, "roles": { "type": "array", - "description": "Roles this business partner takes in relation to the sharing member. Sorted and duplicates removed by the service.", + "description": "One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.", "items": { "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, - "postalAddress": { - "$ref": "#/components/schemas/BusinessPartnerPostalAddressDto" + "legalEntity": { + "$ref": "#/components/schemas/LegalEntityRepresentationOutputDto" }, - "legalEntityBpn": { - "type": "string", - "description": "BPNL of the golden record legal entity this business partner refers to" + "site": { + "$ref": "#/components/schemas/SiteRepresentationOutputDto" }, - "siteBpn": { - "type": "string", - "description": "BPNS of the golden record site this business partner refers to" - }, - "addressBpn": { - "type": "string", - "description": "BPNA of the golden record address this business partner refers to" + "address": { + "$ref": "#/components/schemas/AddressComponentOutputDto" }, "createdAt": { "type": "string", @@ -2199,37 +2379,12 @@ }, "ownCompanyData": { "type": "boolean", - "description": "True if the sharing member declares itself as the owner of the business partner." + "description": "Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member." } }, "description": "Generic business partner output with external id" }, - "BusinessPartnerPostalAddressDto": { - "type": "object", - "properties": { - "addressType": { - "type": "string", - "description": "Type of the address", - "enum": [ - "LegalAndSiteMainAddress", - "LegalAddress", - "SiteMainAddress", - "AdditionalAddress" - ] - }, - "physicalPostalAddress": { - "$ref": "#/components/schemas/PhysicalPostalAddressGateDto" - }, - "alternativePostalAddress": { - "$ref": "#/components/schemas/AlternativePostalAddressGateDto" - } - }, - "description": "Postal address of a business partner" - }, "BusinessPartnerStateDto": { - "required": [ - "type" - ], "type": "object", "properties": { "validFrom": { @@ -2249,13 +2404,8 @@ "ACTIVE", "INACTIVE" ] - }, - "description": { - "type": "string", - "description": "Denotation of the status." } - }, - "description": "A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating." + } }, "ChangelogGateDto": { "type": "object", @@ -2323,53 +2473,32 @@ } } }, - "ClassificationBusinessPartnerDto": { + "ConfidenceCriteriaDto": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Type of classification.", - "enum": [ - "NACE", - "NAF", - "NAICS", - "SIC" - ] + "sharedByOwner": { + "type": "boolean" }, - "code": { - "type": "string", - "description": "The identifier of the class belonging to the classification." + "checkedByExternalDataSource": { + "type": "boolean" }, - "value": { - "type": "string", - "description": "The name of the class belonging to the classification." - } - }, - "description": "A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type." - }, - "ClassificationDto": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of classification.", - "enum": [ - "NACE", - "NAF", - "NAICS", - "SIC" - ] + "numberOfBusinessPartners": { + "type": "integer", + "format": "int32" }, - "code": { + "lastConfidenceCheckAt": { "type": "string", - "description": "The identifier of the class belonging to the classification." + "format": "date-time" }, - "value": { + "nextConfidenceCheckAt": { "type": "string", - "description": "The name of the class belonging to the classification." + "format": "date-time" + }, + "confidenceLevel": { + "type": "integer", + "format": "int32" } - }, - "description": "A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type." + } }, "ErrorInfoChangeLogOutputError": { "title": "ErrorInfo", @@ -2414,6 +2543,33 @@ }, "description": "The exact location of the physical postal address in latitude, longitude, and altitude." }, + "LegalEntityClassificationDto": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of classification.", + "enum": [ + "NACE", + "NAF", + "NAICS", + "SIC" + ] + }, + "code": { + "type": "string", + "description": "The identifier of the class belonging to the classification." + }, + "value": { + "type": "string", + "description": "The name of the class belonging to the classification." + } + }, + "description": "A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type." + }, "LegalEntityGateInputDto": { "required": [ "externalId" @@ -2453,7 +2609,7 @@ "type": "array", "description": "The list of classifications of the legal entity, such as a specific industry.", "items": { - "$ref": "#/components/schemas/ClassificationDto" + "$ref": "#/components/schemas/LegalEntityClassificationDto" } }, "roles": { @@ -2463,10 +2619,15 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "legalAddress": { "$ref": "#/components/schemas/AddressGateInputDto" }, @@ -2516,7 +2677,7 @@ "type": "array", "description": "The list of classifications of the legal entity, such as a specific industry.", "items": { - "$ref": "#/components/schemas/ClassificationDto" + "$ref": "#/components/schemas/LegalEntityClassificationDto" } }, "roles": { @@ -2526,12 +2687,17 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "legalAddress": { - "$ref": "#/components/schemas/LogisticAddressGateDto" + "$ref": "#/components/schemas/LogisticAddressDto" }, "externalId": { "type": "string", @@ -2579,7 +2745,7 @@ "type": "array", "description": "The list of classifications of the legal entity, such as a specific industry.", "items": { - "$ref": "#/components/schemas/ClassificationDto" + "$ref": "#/components/schemas/LegalEntityClassificationDto" } }, "roles": { @@ -2589,10 +2755,15 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "legalAddress": { "$ref": "#/components/schemas/AddressGateOutputChildRequest" }, @@ -2646,7 +2817,7 @@ "type": "array", "description": "The list of classifications of the legal entity, such as a specific industry.", "items": { - "$ref": "#/components/schemas/ClassificationDto" + "$ref": "#/components/schemas/LegalEntityClassificationDto" } }, "roles": { @@ -2656,10 +2827,15 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "legalAddress": { "$ref": "#/components/schemas/AddressGateOutputDto" }, @@ -2689,14 +2865,78 @@ "type": "string", "description": "The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister." } - } + }, + "description": "A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc." + }, + "LegalEntityRepresentationInputDto": { + "type": "object", + "properties": { + "legalEntityBpn": { + "type": "string", + "description": "The BPNL of the legal entity, on which the business partner provides a view." + }, + "legalName": { + "type": "string", + "description": "The name of the legal entity, on which the business partner provides a view, according to official registers." + }, + "shortName": { + "type": "string", + "description": "The abbreviated name of the legal entity, on which the business partner provides a view." + }, + "legalForm": { + "type": "string", + "description": "The legal form of the legal entity, on which the business partner provides a view." + }, + "classifications": { + "type": "array", + "description": "The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.", + "items": { + "$ref": "#/components/schemas/BusinessPartnerClassificationDto" + } + } + }, + "description": "The legal entity, on which the business partner provides a view." + }, + "LegalEntityRepresentationOutputDto": { + "required": [ + "bpnL" + ], + "type": "object", + "properties": { + "legalEntityBpn": { + "type": "string", + "description": "The BPNL of the legal entity, on which the business partner provides a view." + }, + "legalName": { + "type": "string", + "description": "The name of the legal entity, on which the business partner provides a view, according to official registers." + }, + "shortName": { + "type": "string", + "description": "The abbreviated name of the legal entity, on which the business partner provides a view." + }, + "legalForm": { + "type": "string", + "description": "The legal form of the legal entity, on which the business partner provides a view." + }, + "classifications": { + "type": "array", + "description": "The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service.", + "items": { + "$ref": "#/components/schemas/BusinessPartnerClassificationDto" + } + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + } + }, + "description": "Legal Entity properties of business partner output data" }, "LegalEntityStateDto": { "type": "object", "properties": { "description": { - "type": "string", - "description": "The description from the original source indicating the state of the legal entity, such as from the German Handelsregister." + "type": "string" }, "validFrom": { "type": "string", @@ -2719,7 +2959,7 @@ }, "description": "A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating." }, - "LogisticAddressGateDto": { + "LogisticAddressDto": { "type": "object", "properties": { "nameParts": { @@ -2744,10 +2984,10 @@ } }, "physicalPostalAddress": { - "$ref": "#/components/schemas/PhysicalPostalAddressGateDto" + "$ref": "#/components/schemas/PhysicalPostalAddressDto" }, "alternativePostalAddress": { - "$ref": "#/components/schemas/AlternativePostalAddressGateDto" + "$ref": "#/components/schemas/AlternativePostalAddressDto" }, "roles": { "type": "array", @@ -2756,9 +2996,14 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" } }, "description": "In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA." @@ -3105,7 +3350,7 @@ }, "description": "Paginated collection of results" }, - "PhysicalPostalAddressGateDto": { + "PhysicalPostalAddressDto": { "type": "object", "properties": { "geographicCoordinates": { @@ -3414,7 +3659,7 @@ "description": "The name of the district of the physical postal address which divides the city in several smaller areas." }, "street": { - "$ref": "#/components/schemas/StreetGateDto" + "$ref": "#/components/schemas/StreetDto" }, "companyPostalCode": { "type": "string", @@ -3439,6 +3684,18 @@ }, "description": "A physical postal address describes the physical location of an office, warehouse, gate, etc." }, + "PostSharingStateReadyRequest": { + "type": "object", + "properties": { + "externalIds": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "description": "Request for setting business partners into ready to be shared to golden record state" + }, "SharingStateDto": { "type": "object", "properties": { @@ -3463,7 +3720,8 @@ "Pending", "Success", "Error", - "Initial" + "Initial", + "Ready" ] }, "sharingErrorCode": { @@ -3472,7 +3730,8 @@ "enum": [ "SharingProcessError", "SharingTimeout", - "BpnNotInPool" + "BpnNotInPool", + "MissingTaskID" ] }, "sharingErrorMessage": { @@ -3519,7 +3778,9 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, @@ -3561,12 +3822,14 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, "mainAddress": { - "$ref": "#/components/schemas/LogisticAddressGateDto" + "$ref": "#/components/schemas/LogisticAddressDto" }, "externalId": { "type": "string", @@ -3603,7 +3866,9 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, @@ -3649,7 +3914,9 @@ "type": "string", "enum": [ "SUPPLIER", - "CUSTOMER" + "CUSTOMER", + "ONE_TIME_SUPPLIER", + "ONE_TIME_CUSTOMER" ] } }, @@ -3671,12 +3938,42 @@ }, "description": "In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS." }, + "SiteRepresentationInputDto": { + "type": "object", + "properties": { + "siteBpn": { + "type": "string", + "description": "The BPNS of the site, on which the business partner provides a view." + }, + "name": { + "type": "string", + "description": "The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses." + } + }, + "description": "The site, on which the business partner provides a view." + }, + "SiteRepresentationOutputDto": { + "type": "object", + "properties": { + "siteBpn": { + "type": "string", + "description": "The BPNS of the site, on which the business partner provides a view." + }, + "name": { + "type": "string", + "description": "The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses." + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + } + }, + "description": "Site properties of business partner output data" + }, "SiteStateDto": { "type": "object", "properties": { "description": { - "type": "string", - "description": "The description from the original source indicating the state of the site." + "type": "string" }, "validFrom": { "type": "string", @@ -3699,7 +3996,91 @@ }, "description": "A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating." }, - "StreetGateDto": { + "StatsAddressTypesResponse": { + "type": "object", + "properties": { + "legalAndSiteTotal": { + "type": "integer", + "format": "int32" + }, + "legalTotal": { + "type": "integer", + "format": "int32" + }, + "siteTotal": { + "type": "integer", + "format": "int32" + }, + "additionalTotal": { + "type": "integer", + "format": "int32" + } + } + }, + "StatsConfidenceCriteriaResponse": { + "type": "object", + "properties": { + "numberOfBusinessPartnersAverage": { + "type": "number", + "format": "float" + }, + "uniqueTotal": { + "type": "integer", + "format": "int64" + }, + "sharedByOwnerTotal": { + "type": "integer", + "format": "int64" + }, + "checkedByExternalDataSourceTotal": { + "type": "integer", + "format": "int64" + }, + "confidenceLevelAverage": { + "type": "number", + "format": "float" + } + } + }, + "StatsSharingStatesResponse": { + "type": "object", + "properties": { + "initialTotal": { + "type": "integer", + "format": "int32" + }, + "readyTotal": { + "type": "integer", + "format": "int32" + }, + "pendingTotal": { + "type": "integer", + "format": "int32" + }, + "successTotal": { + "type": "integer", + "format": "int32" + }, + "errorTotal": { + "type": "integer", + "format": "int32" + } + } + }, + "StatsStagesResponse": { + "type": "object", + "properties": { + "inputTotal": { + "type": "integer", + "format": "int32" + }, + "outputTotal": { + "type": "integer", + "format": "int32" + } + } + }, + "StreetDto": { "type": "object", "properties": { "namePrefix": { @@ -3726,6 +4107,9 @@ "type": "string", "description": "The number representing the exact location of a building within the street." }, + "houseNumberSupplement": { + "type": "string" + }, "milestone": { "type": "string", "description": "The number representing the exact location of an addressed object within a street without house numbers, such as within long roads." diff --git a/docs/api/gate.yaml b/docs/api/gate.yaml index 7166967cc..cfef4a08b 100644 --- a/docs/api/gate.yaml +++ b/docs/api/gate.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: Business Partner Data Management Gate description: A gate for a member to share business partner data with CatenaX - version: 4.1.0 + version: 5.0.0-SNAPSHOT servers: - url: http://localhost:8081 description: Generated server url @@ -11,9 +11,7 @@ paths: get: tags: - sharing-state-controller - summary: >- - Returns sharing states of business partners, optionally filtered by a - business partner type and an array of external IDs + summary: Returns sharing states of business partners, optionally filtered by a business partner type and an array of external IDs operationId: getSharingStates parameters: - name: page @@ -75,16 +73,30 @@ paths: description: Operation completed successfully '400': description: Invalid data (e.g. external ID) + deprecated: true + post: + tags: + - sharing-state-controller + summary: Sets the given business partners into ready to be shared state + description: The business partners to set the ready state for are identified by their external-id. Only business partners in an initial or error state can be set to ready. If any given business partner could not be set into ready state for any reason (for example, it has not been found or it is in the wrong state) the whole request fails (all or nothing approach). + operationId: postSharingStateReady + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PostSharingStateReadyRequest' + required: true + responses: + '204': + description: All business partners put in ready to be shared state + '404': + description: Business partners can't be put into ready state (e.g. external-ID not found, wrong sharing state) /api/catena/output/sites: put: tags: - site-controller summary: Creates or updates an existing site in the output stage - description: >- - Create or update sites (Output). Updates instead of creating a new site - if an already existing external ID is used. The same external ID may not - occur more than once in a single request. For a single request, the - maximum number of sites in the request is limited to 100 entries. + description: Create or update sites (Output). Updates instead of creating a new site if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries. operationId: upsertSitesOutput requestBody: content: @@ -103,17 +115,13 @@ paths: $ref: '#/components/schemas/Unit' '400': description: On malformed site request + deprecated: true /api/catena/output/legal-entities: put: tags: - legal-entity-controller summary: Creates or updates an existing legal entity in the output stage - description: >- - Create or update legal entities (Output). Updates instead of creating a - new legal entity if an already existing external ID is used. The same - external ID may not occur more than once in a single request. For a - single request, the maximum number of legal entities in the request is - limited to 100 entries. + description: Create or update legal entities (Output). Updates instead of creating a new legal entity if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries. operationId: upsertLegalEntitiesOutput requestBody: content: @@ -132,17 +140,13 @@ paths: $ref: '#/components/schemas/Unit' '400': description: On malformed legal entity request + deprecated: true /api/catena/output/addresses: put: tags: - address-controller summary: Creates or updates an existing address in the output stage - description: >- - Create or update addresses (Output). Updates instead of creating a new - address if an already existing external ID is used. The same external ID - may not occur more than once in a single request. For a single request, - the maximum number of addresses in the request is limited to 100 - entries. + description: Create or update addresses (Output). Updates instead of creating a new address if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries. operationId: upsertAddressesOutput requestBody: content: @@ -161,6 +165,7 @@ paths: $ref: '#/components/schemas/Unit' '400': description: On malformed address request + deprecated: true /api/catena/input/sites: get: tags: @@ -195,15 +200,12 @@ paths: $ref: '#/components/schemas/PageDtoSiteGateInputDto' '400': description: On malformed pagination request + deprecated: true put: tags: - site-controller summary: Creates or updates an existing site in the input stage - description: >- - Create or update sites. Updates instead of creating a new site if an - already existing external ID is used. The same external ID may not occur - more than once in a single request. For a single request, the maximum - number of sites in the request is limited to 100 entries. + description: Create or update sites. Updates instead of creating a new site if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of sites in the request is limited to 100 entries. operationId: upsertSites requestBody: content: @@ -222,6 +224,7 @@ paths: $ref: '#/components/schemas/Unit' '400': description: On malformed site request + deprecated: true /api/catena/input/legal-entities: get: tags: @@ -256,16 +259,12 @@ paths: $ref: '#/components/schemas/PageDtoLegalEntityGateInputDto' '400': description: On malformed pagination request + deprecated: true put: tags: - legal-entity-controller summary: Creates or updates an existing legal entity in the input stage - description: >- - Create or update legal entities. Updates instead of creating a new legal - entity if an already existing external ID is used. The same external ID - may not occur more than once in a single request. For a single request, - the maximum number of legal entities in the request is limited to 100 - entries. + description: Create or update legal entities. Updates instead of creating a new legal entity if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of legal entities in the request is limited to 100 entries. operationId: upsertLegalEntities requestBody: content: @@ -284,17 +283,13 @@ paths: $ref: '#/components/schemas/Unit' '400': description: On malformed legal entity request + deprecated: true /api/catena/input/business-partners: put: tags: - business-partner-controller summary: Create or update business partner with given external ID - description: >- - Create or update generic business partner. Updates instead of creating a - new business partner if an already existing external ID is used. The - same external ID may not occur more than once in a single request. For a - single request, the maximum number of business partners in the request - is limited to 100 entries. + description: Create or update generic business partner. Updates instead of creating a new business partner if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of business partners in the request is limited to 100 entries. operationId: upsertBusinessPartnersInput requestBody: content: @@ -349,15 +344,12 @@ paths: $ref: '#/components/schemas/PageDtoAddressGateInputDto' '400': description: On malformed pagination request + deprecated: true put: tags: - address-controller summary: Creates or updates an existing address in the input stage - description: >- - Create or update addresses. Updates instead of creating a new address if - an already existing external ID is used. The same external ID may not - occur more than once in a single request. For a single request, the - maximum number of addresses in the request is limited to 100 entries. + description: Create or update addresses. Updates instead of creating a new address if an already existing external ID is used. The same external ID may not occur more than once in a single request. For a single request, the maximum number of addresses in the request is limited to 100 entries. operationId: upsertAddresses requestBody: content: @@ -376,14 +368,13 @@ paths: $ref: '#/components/schemas/Unit' '400': description: On malformed address request + deprecated: true /api/catena/output/sites/search: post: tags: - site-controller summary: Returns sites by an array of external IDs from the output stage - description: >- - Get page of sites from the output stage. Can optionally be filtered by - external IDs. + description: Get page of sites from the output stage. Can optionally be filtered by external IDs. operationId: getSitesOutput parameters: - name: page @@ -419,14 +410,13 @@ paths: $ref: '#/components/schemas/PageDtoSiteGateOutputResponse' '400': description: On malformed pagination request + deprecated: true /api/catena/output/legal-entities/search: post: tags: - legal-entity-controller summary: Returns legal entities by an array of external IDs from the output stage - description: >- - Get page of legal entities from the output stage. Can optionally be - filtered by external IDs. + description: Get page of legal entities from the output stage. Can optionally be filtered by external IDs. operationId: getLegalEntitiesOutput parameters: - name: page @@ -462,17 +452,13 @@ paths: $ref: '#/components/schemas/PageDtoLegalEntityGateOutputResponse' '400': description: On malformed pagination request + deprecated: true /api/catena/output/changelog/search: post: tags: - changelog-controller - summary: >- - Returns changelog entries for changes to the business partner output - stage - description: >- - Returns changelog entries as of a specified timestamp from the output - stage, optionally filtered by timestamp, an array of external IDs and a - business partner type. + summary: Returns changelog entries for changes to the business partner output stage + description: Returns changelog entries as of a specified timestamp from the output stage, optionally filtered by timestamp, an array of external IDs and a business partner type. operationId: getOutputChangelog parameters: - name: page @@ -511,13 +497,8 @@ paths: post: tags: - business-partner-controller - summary: >- - Search business partners by an array of external IDs from the output - stage - description: >- - Get page of business partners output data filtered by a collection of - external IDs. An empty external ID list will return a paginated list of - all business partners. + summary: Search business partners by an array of external IDs from the output stage + description: Get page of business partners output data filtered by a collection of external IDs. An empty external ID list will return a paginated list of all business partners. operationId: getBusinessPartnersOutput parameters: - name: page @@ -558,9 +539,7 @@ paths: tags: - address-controller summary: Returns addresses by an array of external IDs from the output stage - description: >- - Get page of addresses from the output stage. Can optionally be filtered - by external IDs. + description: Get page of addresses from the output stage. Can optionally be filtered by external IDs. operationId: getAddressesOutput parameters: - name: page @@ -596,14 +575,13 @@ paths: $ref: '#/components/schemas/PageDtoAddressGateOutputDto' '400': description: On malformed pagination request + deprecated: true /api/catena/input/sites/search: post: tags: - site-controller summary: Returns sites by an array of external IDs from the input stage - description: >- - Returns page of sites from the input stage. Can optionally be filtered - by external IDs. + description: Returns page of sites from the input stage. Can optionally be filtered by external IDs. operationId: getSitesByExternalIds parameters: - name: page @@ -640,14 +618,13 @@ paths: $ref: '#/components/schemas/PageDtoSiteGateInputDto' '400': description: On malformed pagination request + deprecated: true /api/catena/input/legal-entities/search: post: tags: - legal-entity-controller summary: Returns legal entities by an array of external IDs from the input stage - description: >- - Returns page of legal entities from the input stage. Can optionally be - filtered by external IDs. + description: Returns page of legal entities from the input stage. Can optionally be filtered by external IDs. operationId: getLegalEntitiesByExternalIds parameters: - name: page @@ -684,17 +661,13 @@ paths: $ref: '#/components/schemas/PageDtoLegalEntityGateInputDto' '400': description: On malformed pagination request + deprecated: true /api/catena/input/changelog/search: post: tags: - changelog-controller - summary: >- - Returns changelog entries for changes to the business partner input - stage - description: >- - Returns changelog entries as of a specified timestamp from the input - stage, optionally filtered by timestamp, an array of external IDs and a - business partner type. + summary: Returns changelog entries for changes to the business partner input stage + description: Returns changelog entries as of a specified timestamp from the input stage, optionally filtered by timestamp, an array of external IDs and a business partner type. operationId: getInputChangelog parameters: - name: page @@ -733,9 +706,7 @@ paths: post: tags: - business-partner-controller - summary: >- - Search business partner by external ID. An empty external ID list - returns a paginated list of all business partners. + summary: Search business partner by external ID. An empty external ID list returns a paginated list of all business partners. description: Get page of business partners filtered by a collection of external IDs. operationId: getBusinessPartnersInput parameters: @@ -777,9 +748,7 @@ paths: tags: - address-controller summary: Returns addresses by an array of external IDs from the input stage - description: >- - Returns page of addresses from the input stage. Can optionally be - filtered by external IDs. + description: Returns page of addresses from the input stage. Can optionally be filtered by external IDs. operationId: getAddressesByExternalIds parameters: - name: page @@ -816,6 +785,64 @@ paths: $ref: '#/components/schemas/PageDtoAddressGateInputDto' '400': description: On malformed pagination request + deprecated: true + /api/catena/stats/{stage}/address-types: + get: + tags: + - stats-controller + operationId: countAddressTypes + parameters: + - name: stage + in: path + required: true + schema: + type: string + enum: + - Input + - Output + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StatsAddressTypesResponse' + /api/catena/stats/stages: + get: + tags: + - stats-controller + operationId: countPartnersPerStage + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StatsStagesResponse' + /api/catena/stats/sharing-states: + get: + tags: + - stats-controller + operationId: countPartnersBySharingState + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StatsSharingStatesResponse' + /api/catena/stats/confidence-criteria: + get: + tags: + - stats-controller + operationId: getConfidenceCriteriaStats + responses: + '200': + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/StatsConfidenceCriteriaResponse' /api/catena/mermaid/: get: tags: @@ -852,6 +879,7 @@ paths: $ref: '#/components/schemas/SiteGateInputDto' '404': description: No site found under specified external ID + deprecated: true /api/catena/input/legal-entities/{externalId}: get: tags: @@ -875,6 +903,7 @@ paths: $ref: '#/components/schemas/LegalEntityGateInputDto' '404': description: No legal entity found under specified external ID + deprecated: true /api/catena/input/addresses/{externalId}: get: tags: @@ -898,18 +927,41 @@ paths: $ref: '#/components/schemas/AddressGateInputDto' '404': description: No address found under specified external ID + deprecated: true components: schemas: + AddressComponentOutputDto: + required: + - bpnA + type: object + properties: + addressBpn: + type: string + description: The BPNA of the address, on which the business partner provides a view. + name: + type: string + description: The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance. + addressType: + type: string + description: 'One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ' + enum: + - LegalAndSiteMainAddress + - LegalAddress + - SiteMainAddress + - AdditionalAddress + physicalPostalAddress: + $ref: '#/components/schemas/PhysicalPostalAddressDto' + alternativePostalAddress: + $ref: '#/components/schemas/AlternativePostalAddressDto' + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + description: Address properties of business partner output data AddressGateInputDto: type: object properties: nameParts: type: array - description: >- - The list of name parts of the address to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the sharing member - chooses. + description: The list of name parts of the address to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the sharing member chooses. items: type: string states: @@ -923,9 +975,9 @@ components: items: $ref: '#/components/schemas/AddressIdentifierDto' physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressGateDto' + $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressGateDto' + $ref: '#/components/schemas/AlternativePostalAddressDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -934,45 +986,26 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. legalEntityExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner, representing - the legal entity, that owns the address. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the legal entity, that owns the address. siteExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner, representing - the site, that the address belongs to. - description: >- - In general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the site, that the address belongs to. + description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressGateInputRequest: type: object properties: nameParts: type: array - description: >- - The list of name parts of the address to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the sharing member - chooses. + description: The list of name parts of the address to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the sharing member chooses. items: type: string states: @@ -986,9 +1019,9 @@ components: items: $ref: '#/components/schemas/AddressIdentifierDto' physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressGateDto' + $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressGateDto' + $ref: '#/components/schemas/AlternativePostalAddressDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -997,46 +1030,26 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. legalEntityExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner, representing - the legal entity, that owns the address. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the legal entity, that owns the address. siteExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner, representing - the site, that the address belongs to. - description: >- - Request for creating/updating a business partner record of type address. - In general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the site, that the address belongs to. + description: Request for creating/updating a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressGateOutputChildRequest: type: object properties: nameParts: type: array - description: >- - The list of name parts of the address to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the sharing member - chooses. + description: The list of name parts of the address to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the sharing member chooses. items: type: string states: @@ -1050,9 +1063,9 @@ components: items: $ref: '#/components/schemas/AddressIdentifierDto' physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressGateDto' + $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressGateDto' + $ref: '#/components/schemas/AlternativePostalAddressDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -1061,38 +1074,20 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' bpn: type: string - description: >- - A BPNA represents and uniquely identifies an address, which can be - the legal address of a legal entity, and/or the main address of a - site, or any additional address of a legal entity or site (such as - different gates). It is important to note that only the BPNL must be - used to uniquely identify a legal entity. Even in the case that the - BPNA represents the legal address of the legal entity, it shall not - be used to uniquely identify the legal entity. - description: >- - In general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + description: A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity. + description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressGateOutputDto: type: object properties: nameParts: type: array - description: >- - The list of name parts of the address to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the sharing member - chooses. + description: The list of name parts of the address to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the sharing member chooses. items: type: string states: @@ -1106,9 +1101,9 @@ components: items: $ref: '#/components/schemas/AddressIdentifierDto' physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressGateDto' + $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressGateDto' + $ref: '#/components/schemas/AlternativePostalAddressDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -1117,55 +1112,29 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. legalEntityExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner, representing - the legal entity, that owns the address. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the legal entity, that owns the address. siteExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner, representing - the site, that the address belongs to. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the site, that the address belongs to. bpna: type: string - description: >- - A BPNA represents and uniquely identifies an address, which can be - the legal address of a legal entity, and/or the main address of a - site, or any additional address of a legal entity or site (such as - different gates). It is important to note that only the BPNL must be - used to uniquely identify a legal entity. Even in the case that the - BPNA represents the legal address of the legal entity, it shall not - be used to uniquely identify the legal entity. - description: >- - In general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + description: A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity. + description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressGateOutputRequest: type: object properties: nameParts: type: array - description: >- - The list of name parts of the address to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the sharing member - chooses. + description: The list of name parts of the address to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the sharing member chooses. items: type: string states: @@ -1179,9 +1148,9 @@ components: items: $ref: '#/components/schemas/AddressIdentifierDto' physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressGateDto' + $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressGateDto' + $ref: '#/components/schemas/AlternativePostalAddressDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -1190,46 +1159,23 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. legalEntityExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner, representing - the legal entity, that owns the address. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the legal entity, that owns the address. siteExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner, representing - the site, that the address belongs to. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner, representing the site, that the address belongs to. bpn: type: string - description: >- - A BPNA represents and uniquely identifies an address, which can be - the legal address of a legal entity, and/or the main address of a - site, or any additional address of a legal entity or site (such as - different gates). It is important to note that only the BPNL must be - used to uniquely identify a legal entity. Even in the case that the - BPNA represents the legal address of the legal entity, it shall not - be used to uniquely identify the legal entity. - description: >- - Request for creating/updating a business partner record of type address. - In general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + description: A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity. + description: Request for creating/updating a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressIdentifierDto: type: object properties: @@ -1239,17 +1185,34 @@ components: type: type: string description: The type of the identifier. - description: >- - An address identifier (uniquely) identifies the address, such as the - Global Location Number (GLN). + description: An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN). + AddressRepresentationInputDto: + type: object + properties: + addressBpn: + type: string + description: The BPNA of the address, on which the business partner provides a view. + name: + type: string + description: The name of the address, on which the business partner provides a view. This is not according to official registers but according to the name the sharing members agree on, such as the name of a gate or any other additional names that designate the address in common parlance. + addressType: + type: string + description: 'One of the address types: Legal Address, Site Main Address, Legal and Site Main Address, Additional Address. ' + enum: + - LegalAndSiteMainAddress + - LegalAddress + - SiteMainAddress + - AdditionalAddress + physicalPostalAddress: + $ref: '#/components/schemas/PhysicalPostalAddressDto' + alternativePostalAddress: + $ref: '#/components/schemas/AlternativePostalAddressDto' + description: 'The address, on which the business partner provides a view. ' AddressStateDto: type: object properties: description: type: string - description: >- - The description from the original source indicating the state of the - address. validFrom: type: string description: The date from which the state is valid. @@ -1264,21 +1227,15 @@ components: enum: - ACTIVE - INACTIVE - description: >- - An address state indicates if the address is active or inactive. This - does not describe the relation between a sharing member and a business - partner and whether they have active business, but it describes whether - the business partner is still operating at that address. - AlternativePostalAddressGateDto: + description: An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address. + AlternativePostalAddressDto: type: object properties: geographicCoordinates: $ref: '#/components/schemas/GeoCoordinateDto' country: type: string - description: >- - The 2-digit country code of the physical postal address according to - ISO 3166-1. + description: The 2-digit country code of the physical postal address according to ISO 3166-1. enum: - UNDEFINED - AC @@ -1554,133 +1511,98 @@ components: - ZW administrativeAreaLevel1: type: string - description: >- - The 2-digit country subdivision code according to ISO 3166-2, such - as a region within a country. + description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country. postalCode: type: string - description: >- - The alphanumeric identifier (sometimes including spaces or - punctuation) of the physical postal address for the purpose of - sorting mail, synonyms:postcode, post code, PIN or ZIP code. + description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. city: type: string - description: >- - The name of the city of the physical postal address, synonyms: town, - village, municipality. + description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' deliveryServiceType: type: string - description: >- - One of the alternative postal address types: P.O. box, private bag, - boite postale. + description: 'One of the alternative postal address types: P.O. box, private bag, boite postale.' enum: - PO_BOX - PRIVATE_BAG - BOITE_POSTALE deliveryServiceQualifier: type: string - description: >- - The qualifier uniquely identifying the delivery service endpoint of - the alternative postal address in conjunction with the delivery - service number. In some countries for example, entering a P.O. box - number, postal code and city is not sufficient to uniquely identify - a P.O. box, because the same P.O. box number is assigned multiple - times in some cities. + description: The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities. deliveryServiceNumber: type: string - description: >- - The number indicating the delivery service endpoint of the - alternative postal address to which the delivery is to be delivered, - such as a P.O. box number or a private bag number. - description: >- - An alternative postal address describes an alternative way of delivery - for example if the goods are to be picked up somewhere else. + description: The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number. + description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. + BusinessPartnerClassificationDto: + type: object + properties: + type: + type: string + description: Type of classification. + enum: + - NACE + - NAF + - NAICS + - SIC + code: + type: string + description: The identifier of the class belonging to the classification. + value: + type: string + description: The name of the class belonging to the classification. BusinessPartnerIdentifierDto: - required: - - type - - value type: object properties: type: type: string - description: Technical key of the type to which this identifier belongs to + description: The type of the identifier. value: type: string - description: Value of the identifier + description: The value of the identifier like “DE123465789. issuingBody: type: string - description: Body which issued the identifier - description: Identifier record for a business partner + description: The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Registergericht and Registerart. BusinessPartnerInputDto: required: + - bpnA + - bpnL - externalId - postalAddress type: object properties: externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. nameParts: type: array - description: >- - The list of name parts to accommodate the different number of name - fields in different systems. + description: The list of name parts to accommodate the different number of name fields in different systems. items: type: string - shortName: - type: string - description: Abbreviated name or shorthand. identifiers: type: array - description: >- - The list of identifiers of the business partner. Sorted and - duplicates removed by the service. + description: The list of identifiers of the business partner. Sorted and duplicates removed by the service. items: $ref: '#/components/schemas/BusinessPartnerIdentifierDto' - legalName: - type: string - legalForm: - type: string - description: Technical key of the legal form. states: type: array - description: >- - The list of (temporary) states of the business partner. Sorted and - duplicates removed by the service. + description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. items: $ref: '#/components/schemas/BusinessPartnerStateDto' - classifications: - type: array - description: >- - The list of classifications of the business partner, such as a - specific industry. Sorted and duplicates removed by the service. - items: - $ref: '#/components/schemas/ClassificationBusinessPartnerDto' roles: type: array - description: >- - Roles this business partner takes in relation to the sharing member. - Sorted and duplicates removed by the service. + description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.' items: type: string enum: - SUPPLIER - CUSTOMER - postalAddress: - $ref: '#/components/schemas/BusinessPartnerPostalAddressDto' - legalEntityBpn: - type: string - description: >- - BPNL of the golden record legal entity this business partner refers - to - siteBpn: - type: string - description: BPNS of the golden record site this business partner refers to - addressBpn: - type: string - description: BPNA of the golden record address this business partner refers to + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + legalEntity: + $ref: '#/components/schemas/LegalEntityRepresentationInputDto' + site: + $ref: '#/components/schemas/SiteRepresentationInputDto' + address: + $ref: '#/components/schemas/AddressRepresentationInputDto' createdAt: type: string description: The date when the data record has been created. @@ -1691,9 +1613,7 @@ components: format: date-time ownCompanyData: type: boolean - description: >- - True if the sharing member declares itself as the owner of the - business partner. + description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member. description: Generic business partner with external id BusinessPartnerInputRequest: required: @@ -1702,146 +1622,81 @@ components: properties: externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. nameParts: type: array - description: >- - The list of name parts to accommodate the different number of name - fields in different systems. + description: The list of name parts to accommodate the different number of name fields in different systems. items: type: string - shortName: - type: string - description: Abbreviated name or shorthand. identifiers: type: array - description: >- - The list of identifiers of the business partner. Sorted and - duplicates removed by the service. + description: The list of identifiers of the business partner. Sorted and duplicates removed by the service. items: $ref: '#/components/schemas/BusinessPartnerIdentifierDto' - legalName: - type: string - legalForm: - type: string - description: Technical key of the legal form. states: type: array - description: >- - The list of (temporary) states of the business partner. Sorted and - duplicates removed by the service. + description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. items: $ref: '#/components/schemas/BusinessPartnerStateDto' - classifications: - type: array - description: >- - The list of classifications of the business partner, such as a - specific industry. Sorted and duplicates removed by the service. - items: - $ref: '#/components/schemas/ClassificationBusinessPartnerDto' roles: type: array - description: >- - Roles this business partner takes in relation to the sharing member. - Sorted and duplicates removed by the service. + description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.' items: type: string enum: - SUPPLIER - CUSTOMER - postalAddress: - $ref: '#/components/schemas/BusinessPartnerPostalAddressDto' - legalEntityBpn: - type: string - description: >- - BPNL of the golden record legal entity this business partner refers - to - siteBpn: - type: string - description: BPNS of the golden record site this business partner refers to - addressBpn: - type: string - description: BPNA of the golden record address this business partner refers to + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + legalEntity: + $ref: '#/components/schemas/LegalEntityRepresentationInputDto' + site: + $ref: '#/components/schemas/SiteRepresentationInputDto' + address: + $ref: '#/components/schemas/AddressRepresentationInputDto' ownCompanyData: type: boolean - description: >- - True if the sharing member declares itself as the owner of the - business partner. + description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member. description: Generic business partner with external id BusinessPartnerOutputDto: required: - - bpnA - - bpnL - externalId - - postalAddress type: object properties: externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. nameParts: type: array - description: >- - The list of name parts to accommodate the different number of name - fields in different systems. + description: The list of name parts to accommodate the different number of name fields in different systems. items: type: string - shortName: - type: string - description: Abbreviated name or shorthand. identifiers: type: array - description: >- - The list of identifiers of the business partner. Sorted and - duplicates removed by the service. + description: The list of identifiers of the business partner. Sorted and duplicates removed by the service. items: $ref: '#/components/schemas/BusinessPartnerIdentifierDto' - legalName: - type: string - legalForm: - type: string - description: Technical key of the legal form. states: type: array - description: >- - The list of (temporary) states of the business partner. Sorted and - duplicates removed by the service. + description: The list of (temporary) states of the business partner. Sorted and duplicates removed by the service. items: $ref: '#/components/schemas/BusinessPartnerStateDto' - classifications: - type: array - description: >- - The list of classifications of the business partner, such as a - specific industry. Sorted and duplicates removed by the service. - items: - $ref: '#/components/schemas/ClassificationDto' roles: type: array - description: >- - Roles this business partner takes in relation to the sharing member. - Sorted and duplicates removed by the service. + description: 'One or more of the roles, the business partner assumes with respect to the sharing member: Supplier, Customer. Sorted and duplicates removed by the service.' items: type: string enum: - SUPPLIER - CUSTOMER - postalAddress: - $ref: '#/components/schemas/BusinessPartnerPostalAddressDto' - legalEntityBpn: - type: string - description: >- - BPNL of the golden record legal entity this business partner refers - to - siteBpn: - type: string - description: BPNS of the golden record site this business partner refers to - addressBpn: - type: string - description: BPNA of the golden record address this business partner refers to + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + legalEntity: + $ref: '#/components/schemas/LegalEntityRepresentationOutputDto' + site: + $ref: '#/components/schemas/SiteRepresentationOutputDto' + address: + $ref: '#/components/schemas/AddressComponentOutputDto' createdAt: type: string description: The date when the data record has been created. @@ -1852,29 +1707,9 @@ components: format: date-time ownCompanyData: type: boolean - description: >- - True if the sharing member declares itself as the owner of the - business partner. + description: Indicates whether the sharing member claims (in the initial upload) the business partner to belong to the company data of the sharing member. description: Generic business partner output with external id - BusinessPartnerPostalAddressDto: - type: object - properties: - addressType: - type: string - description: Type of the address - enum: - - LegalAndSiteMainAddress - - LegalAddress - - SiteMainAddress - - AdditionalAddress - physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressGateDto' - alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressGateDto' - description: Postal address of a business partner BusinessPartnerStateDto: - required: - - type type: object properties: validFrom: @@ -1891,27 +1726,15 @@ components: enum: - ACTIVE - INACTIVE - description: - type: string - description: Denotation of the status. - description: >- - A legal entity state indicates if the legal entity is active or - inactive. This does not describe the relation between a sharing member - and a business partner and whether they have active business, but it - describes whether the legal entity is still operating. ChangelogGateDto: type: object properties: externalId: type: string - description: >- - The external identifier of the business partner for which the - changelog entry was created. + description: The external identifier of the business partner for which the changelog entry was created. businessPartnerType: type: string - description: >- - One of the types of business partners for which the changelog entry - was created: legal entity, site, address. + description: 'One of the types of business partners for which the changelog entry was created: legal entity, site, address.' enum: - LEGAL_ENTITY - SITE @@ -1923,16 +1746,11 @@ components: format: date-time changelogType: type: string - description: >- - One of the actions for which the changelog entry was created: - create, update. + description: 'One of the actions for which the changelog entry was created: create, update.' enum: - CREATE - UPDATE - description: >- - An entry of the changelog, which is created each time a business partner - is modified and contains data about the change. The actual new state of - the business partner is not included. + description: An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included. ChangelogSearchRequest: type: object properties: @@ -1944,17 +1762,13 @@ components: externalIds: uniqueItems: true type: array - description: >- - Only for business partners with the given array of external IDs. - Ignored if empty. + description: Only for business partners with the given array of external IDs. Ignored if empty. items: type: string businessPartnerTypes: uniqueItems: true type: array - description: >- - Only for business partners with the given array of business partner - types. Ignored if empty. + description: Only for business partners with the given array of business partner types. Ignored if empty. items: type: string enum: @@ -1962,52 +1776,25 @@ components: - SITE - ADDRESS - GENERIC - ClassificationBusinessPartnerDto: - type: object - properties: - type: - type: string - description: Type of classification. - enum: - - NACE - - NAF - - NAICS - - SIC - code: - type: string - description: The identifier of the class belonging to the classification. - value: - type: string - description: The name of the class belonging to the classification. - description: >- - A legal entity classification is an assignment of the legal entity to an - industry. It does not necessarily have to be the only industry the - company is active in (see large companies operating in different - industries). Multiple assignments to several industries are possible per - classification type. - ClassificationDto: + ConfidenceCriteriaDto: type: object properties: - type: - type: string - description: Type of classification. - enum: - - NACE - - NAF - - NAICS - - SIC - code: + sharedByOwner: + type: boolean + checkedByExternalDataSource: + type: boolean + numberOfBusinessPartners: + type: integer + format: int32 + lastConfidenceCheckAt: type: string - description: The identifier of the class belonging to the classification. - value: + format: date-time + nextConfidenceCheckAt: type: string - description: The name of the class belonging to the classification. - description: >- - A legal entity classification is an assignment of the legal entity to an - industry. It does not necessarily have to be the only industry the - company is active in (see large companies operating in different - industries). Multiple assignments to several industries are possible per - classification type. + format: date-time + confidenceLevel: + type: integer + format: int32 ErrorInfoChangeLogOutputError: title: ErrorInfo type: object @@ -2039,9 +1826,27 @@ components: type: number description: Altitude, if applicable format: float - description: >- - The exact location of the physical postal address in latitude, - longitude, and altitude. + description: The exact location of the physical postal address in latitude, longitude, and altitude. + LegalEntityClassificationDto: + required: + - type + type: object + properties: + type: + type: string + description: Type of classification. + enum: + - NACE + - NAF + - NAICS + - SIC + code: + type: string + description: The identifier of the class belonging to the classification. + value: + type: string + description: The name of the class belonging to the classification. + description: A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type. LegalEntityGateInputDto: required: - externalId @@ -2049,9 +1854,7 @@ components: properties: legalNameParts: type: array - description: >- - The list of name parts of the legal entity to accommodate the - different number of name fields in different systems. + description: The list of name parts of the legal entity to accommodate the different number of name fields in different systems. items: type: string identifiers: @@ -2072,11 +1875,9 @@ components: $ref: '#/components/schemas/LegalEntityStateDto' classifications: type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. + description: The list of classifications of the legal entity, such as a specific industry. items: - $ref: '#/components/schemas/ClassificationDto' + $ref: '#/components/schemas/LegalEntityClassificationDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -2085,27 +1886,16 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' legalAddress: $ref: '#/components/schemas/AddressGateInputDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. - description: >- - In general, a legal entity is a juridical person that has legal rights - and duties related to contracts, agreements, and obligations. The term - especially applies to any kind of organization (such as an enterprise or - company, university, association, etc.) established under the law - applicable to a country.In Catena-X, a legal entity is a type of - business partner representing a legally registered organization with its - official registration information, such as legal name (including legal - form, if registered), legal address and tax number.A legal entity has - exactly one legal address, but it is possible to specify additional - addresses that a legal entity owns. Thus, at least one address is - assigned to a legal entity. A legal entity can own sites. Thus, many or - no sites are assigned to a legal entity. A legal entity is uniquely - identified by the BPNL. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. + description: In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityGateInputRequest: required: - externalId @@ -2113,9 +1903,7 @@ components: properties: legalNameParts: type: array - description: >- - The list of name parts of the legal entity to accommodate the - different number of name fields in different systems. + description: The list of name parts of the legal entity to accommodate the different number of name fields in different systems. items: type: string identifiers: @@ -2136,11 +1924,9 @@ components: $ref: '#/components/schemas/LegalEntityStateDto' classifications: type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. + description: The list of classifications of the legal entity, such as a specific industry. items: - $ref: '#/components/schemas/ClassificationDto' + $ref: '#/components/schemas/LegalEntityClassificationDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -2149,28 +1935,16 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' legalAddress: - $ref: '#/components/schemas/LogisticAddressGateDto' + $ref: '#/components/schemas/LogisticAddressDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. - description: >- - Request for creating/updating a business partner record of type legal - entity. In general, a legal entity is a juridical person that has legal - rights and duties related to contracts, agreements, and obligations. The - term especially applies to any kind of organization (such as an - enterprise or company, university, association, etc.) established under - the law applicable to a country.In Catena-X, a legal entity is a type of - business partner representing a legally registered organization with its - official registration information, such as legal name (including legal - form, if registered), legal address and tax number.A legal entity has - exactly one legal address, but it is possible to specify additional - addresses that a legal entity owns. Thus, at least one address is - assigned to a legal entity. A legal entity can own sites. Thus, many or - no sites are assigned to a legal entity. A legal entity is uniquely - identified by the BPNL. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. + description: Request for creating/updating a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityGateOutputRequest: required: - externalId @@ -2178,9 +1952,7 @@ components: properties: legalNameParts: type: array - description: >- - The list of name parts of the legal entity to accommodate the - different number of name fields in different systems. + description: The list of name parts of the legal entity to accommodate the different number of name fields in different systems. items: type: string identifiers: @@ -2201,11 +1973,9 @@ components: $ref: '#/components/schemas/LegalEntityStateDto' classifications: type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. + description: The list of classifications of the legal entity, such as a specific industry. items: - $ref: '#/components/schemas/ClassificationDto' + $ref: '#/components/schemas/LegalEntityClassificationDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -2214,34 +1984,19 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' legalAddress: $ref: '#/components/schemas/AddressGateOutputChildRequest' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. bpn: type: string - description: >- - A BPNL represents and uniquely identifies a legal entity, which is - defined by its legal name (including legal form, if registered), - legal address and tax number. - description: >- - Request for creating/updating a business partner record of type legal - entity. In general, a legal entity is a juridical person that has legal - rights and duties related to contracts, agreements, and obligations. The - term especially applies to any kind of organization (such as an - enterprise or company, university, association, etc.) established under - the law applicable to a country.In Catena-X, a legal entity is a type of - business partner representing a legally registered organization with its - official registration information, such as legal name (including legal - form, if registered), legal address and tax number.A legal entity has - exactly one legal address, but it is possible to specify additional - addresses that a legal entity owns. Thus, at least one address is - assigned to a legal entity. A legal entity can own sites. Thus, many or - no sites are assigned to a legal entity. A legal entity is uniquely - identified by the BPNL. + description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. + description: Request for creating/updating a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityGateOutputResponse: required: - externalId @@ -2249,9 +2004,7 @@ components: properties: legalNameParts: type: array - description: >- - The list of name parts of the legal entity to accommodate the - different number of name fields in different systems. + description: The list of name parts of the legal entity to accommodate the different number of name fields in different systems. items: type: string identifiers: @@ -2272,11 +2025,9 @@ components: $ref: '#/components/schemas/LegalEntityStateDto' classifications: type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. + description: The list of classifications of the legal entity, such as a specific industry. items: - $ref: '#/components/schemas/ClassificationDto' + $ref: '#/components/schemas/LegalEntityClassificationDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -2285,33 +2036,19 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' legalAddress: $ref: '#/components/schemas/AddressGateOutputDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. bpnl: type: string - description: >- - A BPNL represents and uniquely identifies a legal entity, which is - defined by its legal name (including legal form, if registered), - legal address and tax number. - description: >- - In general, a legal entity is a juridical person that has legal rights - and duties related to contracts, agreements, and obligations. The term - especially applies to any kind of organization (such as an enterprise or - company, university, association, etc.) established under the law - applicable to a country.In Catena-X, a legal entity is a type of - business partner representing a legally registered organization with its - official registration information, such as legal name (including legal - form, if registered), legal address and tax number.A legal entity has - exactly one legal address, but it is possible to specify additional - addresses that a legal entity owns. Thus, at least one address is - assigned to a legal entity. A legal entity can own sites. Thus, many or - no sites are assigned to a legal entity. A legal entity is uniquely - identified by the BPNL. + description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. + description: In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityIdentifierDto: type: object properties: @@ -2323,18 +2060,59 @@ components: description: The type of the identifier. issuingBody: type: string - description: >- - The name of the official register, where the identifier is - registered. For example, a Handelsregisternummer in Germany is only - valid with its corresponding Handelsregister. + description: The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister. + description: A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc. + LegalEntityRepresentationInputDto: + type: object + properties: + legalEntityBpn: + type: string + description: The BPNL of the legal entity, on which the business partner provides a view. + legalName: + type: string + description: The name of the legal entity, on which the business partner provides a view, according to official registers. + shortName: + type: string + description: The abbreviated name of the legal entity, on which the business partner provides a view. + legalForm: + type: string + description: The legal form of the legal entity, on which the business partner provides a view. + classifications: + type: array + description: The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service. + items: + $ref: '#/components/schemas/BusinessPartnerClassificationDto' + description: The legal entity, on which the business partner provides a view. + LegalEntityRepresentationOutputDto: + required: + - bpnL + type: object + properties: + legalEntityBpn: + type: string + description: The BPNL of the legal entity, on which the business partner provides a view. + legalName: + type: string + description: The name of the legal entity, on which the business partner provides a view, according to official registers. + shortName: + type: string + description: The abbreviated name of the legal entity, on which the business partner provides a view. + legalForm: + type: string + description: The legal form of the legal entity, on which the business partner provides a view. + classifications: + type: array + description: The list of classifications of the business partner, such as a specific industry. Sorted and duplicates removed by the service. + items: + $ref: '#/components/schemas/BusinessPartnerClassificationDto' + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + description: Legal Entity properties of business partner output data LegalEntityStateDto: type: object properties: description: type: string - description: >- - The description from the original source indicating the state of the - legal entity, such as from the German Handelsregister. validFrom: type: string description: The date from which the state is valid. @@ -2349,21 +2127,13 @@ components: enum: - ACTIVE - INACTIVE - description: >- - A legal entity state indicates if the legal entity is active or - inactive. This does not describe the relation between a sharing member - and a business partner and whether they have active business, but it - describes whether the legal entity is still operating. - LogisticAddressGateDto: + description: A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating. + LogisticAddressDto: type: object properties: nameParts: type: array - description: >- - The list of name parts of the address to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the sharing member - chooses. + description: The list of name parts of the address to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the sharing member chooses. items: type: string states: @@ -2377,9 +2147,9 @@ components: items: $ref: '#/components/schemas/AddressIdentifierDto' physicalPostalAddress: - $ref: '#/components/schemas/PhysicalPostalAddressGateDto' + $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: - $ref: '#/components/schemas/AlternativePostalAddressGateDto' + $ref: '#/components/schemas/AlternativePostalAddressDto' roles: type: array description: Roles this business partner takes in relation to the sharing member. @@ -2388,18 +2158,11 @@ components: enum: - SUPPLIER - CUSTOMER - description: >- - In general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. PageChangeLogDtoChangelogGateDto: type: object properties: @@ -2426,9 +2189,7 @@ components: $ref: '#/components/schemas/ChangelogGateDto' invalidEntries: type: integer - description: >- - Number of entries in the page that have been omitted due to being - invalid (error) + description: Number of entries in the page that have been omitted due to being invalid (error) format: int32 errors: type: array @@ -2661,16 +2422,14 @@ components: items: $ref: '#/components/schemas/SiteGateOutputResponse' description: Paginated collection of results - PhysicalPostalAddressGateDto: + PhysicalPostalAddressDto: type: object properties: geographicCoordinates: $ref: '#/components/schemas/GeoCoordinateDto' country: type: string - description: >- - The 2-digit country code of the physical postal address according to - ISO 3166-1. + description: The 2-digit country code of the physical postal address according to ISO 3166-1. enum: - UNDEFINED - AC @@ -2946,73 +2705,54 @@ components: - ZW administrativeAreaLevel1: type: string - description: >- - The 2-digit country subdivision code according to ISO 3166-2, such - as a region within a country. + description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country. administrativeAreaLevel2: type: string - description: >- - The name of the locally regulated secondary country subdivision of - the physical postal address, such as county within a country. + description: The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country. administrativeAreaLevel3: type: string - description: >- - The name of the locally regulated tertiary country subdivision of - the physical address, such as townships within a country. + description: The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country. postalCode: type: string - description: >- - The alphanumeric identifier (sometimes including spaces or - punctuation) of the physical postal address for the purpose of - sorting mail, synonyms:postcode, post code, PIN or ZIP code. + description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. city: type: string - description: >- - The name of the city of the physical postal address, synonyms: town, - village, municipality. + description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' district: type: string - description: >- - The name of the district of the physical postal address which - divides the city in several smaller areas. + description: The name of the district of the physical postal address which divides the city in several smaller areas. street: - $ref: '#/components/schemas/StreetGateDto' + $ref: '#/components/schemas/StreetDto' companyPostalCode: type: string - description: >- - The company postal code of the physical postal address, which is - sometimes required for large companies. + description: The company postal code of the physical postal address, which is sometimes required for large companies. industrialZone: type: string - description: >- - The industrial zone of the physical postal address, designating an - area for industrial development, synonym: industrial area. + description: 'The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.' building: type: string - description: >- - The alphanumeric identifier of the building addressed by the - physical postal address. + description: The alphanumeric identifier of the building addressed by the physical postal address. floor: type: string - description: >- - The number of a floor in the building addressed by the physical - postal address, synonym: level. + description: 'The number of a floor in the building addressed by the physical postal address, synonym: level.' door: type: string - description: >- - The number of a door in the building on the respective floor - addressed by the physical postal address, synonyms: room, suite. - description: >- - A physical postal address describes the physical location of an office, - warehouse, gate, etc. + description: 'The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.' + description: A physical postal address describes the physical location of an office, warehouse, gate, etc. + PostSharingStateReadyRequest: + type: object + properties: + externalIds: + type: array + items: + type: string + description: Request for setting business partners into ready to be shared to golden record state SharingStateDto: type: object properties: businessPartnerType: type: string - description: >- - One of the types of business partners for which the sharing state - entry was created. + description: One of the types of business partners for which the sharing state entry was created. enum: - LEGAL_ENTITY - SITE @@ -3020,9 +2760,7 @@ components: - GENERIC externalId: type: string - description: >- - The external identifier of the business partner for which the - sharing state entry was created. + description: The external identifier of the business partner for which the sharing state entry was created. sharingStateType: type: string description: One of the sharing state types of the current sharing state. @@ -3031,24 +2769,21 @@ components: - Success - Error - Initial + - Ready sharingErrorCode: type: string - description: >- - One of the sharing error codes in case the current sharing state - type is "error". + description: One of the sharing error codes in case the current sharing state type is "error". enum: - SharingProcessError - SharingTimeout - BpnNotInPool + - MissingTaskID sharingErrorMessage: type: string description: The error message in case the current sharing state type is "error". bpn: type: string - description: >- - The business partner number associated to the combination of - external identifier and business partner type in case the sharing - state type is “success”. Can be either a BPNL, BPNS or BPNA. + description: The business partner number associated to the combination of external identifier and business partner type in case the sharing state type is “success”. Can be either a BPNL, BPNS or BPNA. sharingProcessStarted: type: string description: The date and time when the sharing process was started. @@ -3056,20 +2791,13 @@ components: taskId: type: string description: The orchestrator task identifier that was created - description: >- - A sharing state entry shows the progress in the sharing process and is - updated each time the progress for a business partner changes. The - business partner is identified by a combination of external ID and - business partner type. + description: A sharing state entry shows the progress in the sharing process and is updated each time the progress for a business partner changes. The business partner is identified by a combination of external ID and business partner type. SiteGateInputDto: type: object properties: nameParts: type: array - description: >- - The list of name parts of the site to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the owner chooses. + description: The list of name parts of the site to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the owner chooses. items: type: string states: @@ -3085,41 +2813,23 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER mainAddress: $ref: '#/components/schemas/AddressGateInputDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. legalEntityExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner owning the - site. - description: >- - In general, a site is a delimited geographical area in which an - organization (such as an enterprise or company, university, association, - etc.) conducts business. In Catena-X, a site is a type of business - partner representing a physical location or area owned by a legal - entity, where a production plant, a warehouse, or an office building is - located. A site is owned by a legal entity. Thus, exactly one legal - entity is assigned to a site. A site has exactly one main address, but - it is possible to specify additional addresses (such as different - gates), that belong to a site. Thus, at least one address is assigned to - a site. A site can only be uploaded and modified by the owner (the legal - entity), because only the owner knows which addresses belong to which - site. A site is uniquely identified by the BPNS. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner owning the site. + description: In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SiteGateInputRequest: type: object properties: nameParts: type: array - description: >- - The list of name parts of the site to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the owner chooses. + description: The list of name parts of the site to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the owner chooses. items: type: string states: @@ -3135,42 +2845,23 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER mainAddress: - $ref: '#/components/schemas/LogisticAddressGateDto' + $ref: '#/components/schemas/LogisticAddressDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. legalEntityExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner owning the - site. - description: >- - Request for creating/updating a business partner record of type site. In - general, a site is a delimited geographical area in which an - organization (such as an enterprise or company, university, association, - etc.) conducts business. In Catena-X, a site is a type of business - partner representing a physical location or area owned by a legal - entity, where a production plant, a warehouse, or an office building is - located. A site is owned by a legal entity. Thus, exactly one legal - entity is assigned to a site. A site has exactly one main address, but - it is possible to specify additional addresses (such as different - gates), that belong to a site. Thus, at least one address is assigned to - a site. A site can only be uploaded and modified by the owner (the legal - entity), because only the owner knows which addresses belong to which - site. A site is uniquely identified by the BPNS. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner owning the site. + description: Request for creating/updating a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SiteGateOutputRequest: type: object properties: nameParts: type: array - description: >- - The list of name parts of the site to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the owner chooses. + description: The list of name parts of the site to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the owner chooses. items: type: string states: @@ -3186,48 +2877,26 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER mainAddress: $ref: '#/components/schemas/AddressGateOutputChildRequest' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. legalEntityExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner owning the - site. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner owning the site. bpn: type: string - description: >- - A BPNS represents and uniquely identifies a site, which is where for - example a production plant, a warehouse, or an office building is - located. - description: >- - Request for creating/updating a business partner record of type site. In - general, a site is a delimited geographical area in which an - organization (such as an enterprise or company, university, association, - etc.) conducts business. In Catena-X, a site is a type of business - partner representing a physical location or area owned by a legal - entity, where a production plant, a warehouse, or an office building is - located. A site is owned by a legal entity. Thus, exactly one legal - entity is assigned to a site. A site has exactly one main address, but - it is possible to specify additional addresses (such as different - gates), that belong to a site. Thus, at least one address is assigned to - a site. A site can only be uploaded and modified by the owner (the legal - entity), because only the owner knows which addresses belong to which - site. A site is uniquely identified by the BPNS. + description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. + description: Request for creating/updating a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SiteGateOutputResponse: type: object properties: nameParts: type: array - description: >- - The list of name parts of the site to accommodate the different - number of name fields in different systems. This is not according to - official registers but according to the name the owner chooses. + description: The list of name parts of the site to accommodate the different number of name fields in different systems. This is not according to official registers but according to the name the owner chooses. items: type: string states: @@ -3243,46 +2912,47 @@ components: enum: - SUPPLIER - CUSTOMER + - ONE_TIME_SUPPLIER + - ONE_TIME_CUSTOMER mainAddress: $ref: '#/components/schemas/AddressGateOutputDto' externalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner. legalEntityExternalId: type: string - description: >- - The identifier which uniquely identifies (in the internal system - landscape of the sharing member) the business partner owning the - site. + description: The identifier which uniquely identifies (in the internal system landscape of the sharing member) the business partner owning the site. bpns: type: string - description: >- - A BPNS represents and uniquely identifies a site, which is where for - example a production plant, a warehouse, or an office building is - located. - description: >- - In general, a site is a delimited geographical area in which an - organization (such as an enterprise or company, university, association, - etc.) conducts business. In Catena-X, a site is a type of business - partner representing a physical location or area owned by a legal - entity, where a production plant, a warehouse, or an office building is - located. A site is owned by a legal entity. Thus, exactly one legal - entity is assigned to a site. A site has exactly one main address, but - it is possible to specify additional addresses (such as different - gates), that belong to a site. Thus, at least one address is assigned to - a site. A site can only be uploaded and modified by the owner (the legal - entity), because only the owner knows which addresses belong to which - site. A site is uniquely identified by the BPNS. + description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. + description: In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. + SiteRepresentationInputDto: + type: object + properties: + siteBpn: + type: string + description: The BPNS of the site, on which the business partner provides a view. + name: + type: string + description: The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses. + description: The site, on which the business partner provides a view. + SiteRepresentationOutputDto: + type: object + properties: + siteBpn: + type: string + description: The BPNS of the site, on which the business partner provides a view. + name: + type: string + description: The name of the site, on which the business partner provides a view. This is not according to official registers but according to the name the owner chooses. + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + description: Site properties of business partner output data SiteStateDto: type: object properties: description: type: string - description: >- - The description from the original source indicating the state of the - site. validFrom: type: string description: The date from which the state is valid. @@ -3297,55 +2967,96 @@ components: enum: - ACTIVE - INACTIVE - description: >- - A site state indicates if the site is active or inactive. This does not - describe the relation between a sharing member and a business partner - and whether they have active business, but it describes whether the site - is still operating. - StreetGateDto: + description: A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating. + StatsAddressTypesResponse: + type: object + properties: + legalAndSiteTotal: + type: integer + format: int32 + legalTotal: + type: integer + format: int32 + siteTotal: + type: integer + format: int32 + additionalTotal: + type: integer + format: int32 + StatsConfidenceCriteriaResponse: + type: object + properties: + numberOfBusinessPartnersAverage: + type: number + format: float + uniqueTotal: + type: integer + format: int64 + sharedByOwnerTotal: + type: integer + format: int64 + checkedByExternalDataSourceTotal: + type: integer + format: int64 + confidenceLevelAverage: + type: number + format: float + StatsSharingStatesResponse: + type: object + properties: + initialTotal: + type: integer + format: int32 + readyTotal: + type: integer + format: int32 + pendingTotal: + type: integer + format: int32 + successTotal: + type: integer + format: int32 + errorTotal: + type: integer + format: int32 + StatsStagesResponse: + type: object + properties: + inputTotal: + type: integer + format: int32 + outputTotal: + type: integer + format: int32 + StreetDto: type: object properties: namePrefix: type: string - description: >- - The street related information, which is usually printed before the - official street name on an address label. + description: The street related information, which is usually printed before the official street name on an address label. additionalNamePrefix: type: string - description: >- - The additional street related information, which is usually printed - before the official street name on an address label. + description: The additional street related information, which is usually printed before the official street name on an address label. name: type: string description: The name of the street. nameSuffix: type: string - description: >- - The street related information, which is usually printed after the - official street name on an address label. + description: The street related information, which is usually printed after the official street name on an address label. additionalNameSuffix: type: string - description: >- - The additional street related information, which is usually printed - after the official street name on an address label. + description: The additional street related information, which is usually printed after the official street name on an address label. houseNumber: type: string - description: >- - The number representing the exact location of a building within the - street. + description: The number representing the exact location of a building within the street. + houseNumberSupplement: + type: string milestone: type: string - description: >- - The number representing the exact location of an addressed object - within a street without house numbers, such as within long roads. + description: The number representing the exact location of an addressed object within a street without house numbers, such as within long roads. direction: type: string - description: >- - The cardinal direction describing where the exit to the location of - the addressed object on large highways / motorways is located, such - as Highway 101 South. - description: >- - The street of the physical postal address, synonyms: road, avenue, lane, - boulevard, highway + description: The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South. + description: 'The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway' Unit: type: object diff --git a/docs/api/pool.json b/docs/api/pool.json index 7db33c9d7..430da83a3 100644 --- a/docs/api/pool.json +++ b/docs/api/pool.json @@ -3,7 +3,7 @@ "info": { "title": "Business Partner Data Management Pool", "description": "Service that manages and shares business partner data with other CatenaX services", - "version": "4.1.0" + "version": "5.0.0-SNAPSHOT" }, "servers": [ { @@ -18,7 +18,7 @@ "site-controller" ], "summary": "Get page of sites matching the pagination search criteria", - "description": "This endpoint retrieves all existing business partners of type sites.Note that when using search parameters the max page is 20.", + "description": "This endpoint retrieves all existing business partners of type sites.", "operationId": "getSitesPaginated", "parameters": [ { @@ -140,7 +140,7 @@ "legal-entity-controller" ], "summary": "Returns legal entities by different search parameters", - "description": "This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20.", + "description": "This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. ", "operationId": "getLegalEntities", "parameters": [ { @@ -271,7 +271,7 @@ "address-controller" ], "summary": "Returns addresses by different search parameters", - "description": "This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. Note that when using search parameters the max page is 20.", + "description": "This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. ", "operationId": "getAddresses_1", "parameters": [ { @@ -396,70 +396,6 @@ } } }, - "/api/opensearch/business-partner": { - "get": { - "tags": [ - "open-search-controller" - ], - "summary": "Fetch information about the latest OpenSearch export", - "description": "Fetch information about the latest export (either ongoing or already finished)", - "operationId": "getBusinessPartners", - "responses": { - "200": { - "description": "Export information found", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SyncDto" - } - } - } - }, - "500": { - "description": "Fetching failed (no connection to database)" - } - } - }, - "post": { - "tags": [ - "open-search-controller" - ], - "summary": "Index new business partner records on OpenSearch", - "description": "Triggers an asynchronous export of business partner records from BPDM to OpenSearch. Only exports records which have been updated since the last export. ", - "operationId": "export", - "responses": { - "200": { - "description": "Export of records successfully", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/SyncDto" - } - } - } - }, - "500": { - "description": "Export failed (no connection to OpenSearch or database)" - } - } - }, - "delete": { - "tags": [ - "open-search-controller" - ], - "summary": "Clear business partner index on OpenSearch", - "description": "Deletes all business partner records in the OpenSearch index. Also resets the timestamp from the last export.", - "operationId": "clear", - "responses": { - "200": { - "description": "Index successfully cleared" - }, - "500": { - "description": "Clearing failed (no connection to OpenSearch or database)" - } - } - } - }, "/api/catena/sites/search": { "post": { "tags": [ @@ -509,7 +445,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PageDtoSitePoolVerboseDto" + "$ref": "#/components/schemas/PageDtoSiteWithMainAddressVerboseDto" } } } @@ -771,7 +707,7 @@ ], "summary": "Returns legal entities by an array of BPNL", "description": "Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries.", - "operationId": "searchSites_1", + "operationId": "searchLegalEntitys", "requestBody": { "content": { "application/json": { @@ -793,7 +729,7 @@ "schema": { "type": "array", "items": { - "$ref": "#/components/schemas/PoolLegalEntityVerboseDto" + "$ref": "#/components/schemas/LegalEntityWithLegalAddressVerboseDto" } } } @@ -1416,7 +1352,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/SitePoolVerboseDto" + "$ref": "#/components/schemas/SiteWithMainAddressVerboseDto" } } } @@ -1486,7 +1422,7 @@ "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/PoolLegalEntityVerboseDto" + "$ref": "#/components/schemas/LegalEntityWithLegalAddressVerboseDto" } } } @@ -2121,11 +2057,17 @@ "alternativePostalAddress": { "$ref": "#/components/schemas/AlternativePostalAddressDto" }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "bpnParent": { "type": "string" }, "index": { "type": "string" + }, + "requestKey": { + "type": "string" } }, "description": "Request for creating new business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA." @@ -2169,12 +2111,14 @@ }, "states": { "type": "array", + "description": "The list of (temporary) states of the address.", "items": { "$ref": "#/components/schemas/AddressStateVerboseDto" } }, "identifiers": { "type": "array", + "description": "The list of identifiers of the address.", "items": { "$ref": "#/components/schemas/AddressIdentifierVerboseDto" } @@ -2203,6 +2147,9 @@ "description": "The date when the data record has been last updated.", "format": "date-time" }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "isLegalAddress": { "type": "boolean", "description": "Indicates if the address is the legal address to a legal entity." @@ -2246,6 +2193,12 @@ }, "alternativePostalAddress": { "$ref": "#/components/schemas/AlternativePostalAddressDto" + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, + "requestKey": { + "type": "string" } }, "description": "Request for updating a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA." @@ -2279,10 +2232,6 @@ "AddressStateDto": { "type": "object", "properties": { - "description": { - "type": "string", - "description": "The description from the original source indicating the state of the address." - }, "validFrom": { "type": "string", "description": "The date from which the state is valid.", @@ -2307,10 +2256,6 @@ "AddressStateVerboseDto": { "type": "object", "properties": { - "description": { - "type": "string", - "description": "The description from the original source indicating the state of the address." - }, "validFrom": { "type": "string", "description": "The date from which the state is valid.", @@ -2655,12 +2600,6 @@ "geographicCoordinates": { "$ref": "#/components/schemas/GeoCoordinateDto" }, - "country": { - "$ref": "#/components/schemas/TypeKeyNameVerboseDtoCountryCode" - }, - "administrativeAreaLevel1": { - "$ref": "#/components/schemas/RegionDto" - }, "postalCode": { "type": "string", "description": "The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code." @@ -2685,6 +2624,12 @@ "deliveryServiceNumber": { "type": "string", "description": "The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number." + }, + "country": { + "$ref": "#/components/schemas/TypeKeyNameVerboseDtoCountryCode" + }, + "administrativeAreaLevel1": { + "$ref": "#/components/schemas/RegionDto" } }, "description": "An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else." @@ -2768,46 +2713,32 @@ }, "description": "Request for searching and filtering the business partner changelog" }, - "ClassificationDto": { + "ConfidenceCriteriaDto": { "type": "object", "properties": { - "type": { - "type": "string", - "description": "Type of classification.", - "enum": [ - "NACE", - "NAF", - "NAICS", - "SIC" - ] + "sharedByOwner": { + "type": "boolean" }, - "code": { - "type": "string", - "description": "The identifier of the class belonging to the classification." + "checkedByExternalDataSource": { + "type": "boolean" }, - "value": { - "type": "string", - "description": "The name of the class belonging to the classification." - } - }, - "description": "A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type." - }, - "ClassificationVerboseDto": { - "type": "object", - "properties": { - "value": { + "numberOfBusinessPartners": { + "type": "integer", + "format": "int32" + }, + "lastConfidenceCheckAt": { "type": "string", - "description": "The name of the class belonging to the classification." + "format": "date-time" }, - "code": { + "nextConfidenceCheckAt": { "type": "string", - "description": "The identifier of the class belonging to the classification." + "format": "date-time" }, - "type": { - "$ref": "#/components/schemas/TypeKeyNameVerboseDtoClassificationType" + "confidenceLevel": { + "type": "integer", + "format": "int32" } - }, - "description": "A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type." + } }, "CountrySubdivisionDto": { "type": "object", @@ -3931,6 +3862,50 @@ }, "description": "Legal address for legal entity" }, + "LegalEntityClassificationDto": { + "required": [ + "type" + ], + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of classification.", + "enum": [ + "NACE", + "NAF", + "NAICS", + "SIC" + ] + }, + "code": { + "type": "string", + "description": "The identifier of the class belonging to the classification." + }, + "value": { + "type": "string", + "description": "The name of the class belonging to the classification." + } + }, + "description": "A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type." + }, + "LegalEntityClassificationVerboseDto": { + "type": "object", + "properties": { + "value": { + "type": "string", + "description": "The name of the class belonging to the classification." + }, + "code": { + "type": "string", + "description": "The identifier of the class belonging to the classification." + }, + "type": { + "$ref": "#/components/schemas/TypeKeyNameVerboseDtoClassificationType" + } + }, + "description": "A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type." + }, "LegalEntityIdentifierDto": { "type": "object", "properties": { @@ -3946,7 +3921,8 @@ "type": "string", "description": "The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister." } - } + }, + "description": "A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc." }, "LegalEntityIdentifierVerboseDto": { "type": "object", @@ -3955,12 +3931,12 @@ "type": "string", "description": "The value of the identifier like \"DE123465789\"." }, - "type": { - "$ref": "#/components/schemas/TypeKeyNameVerboseDtoString" - }, "issuingBody": { "type": "string", "description": "The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister." + }, + "type": { + "$ref": "#/components/schemas/TypeKeyNameVerboseDtoString" } }, "description": "A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc." @@ -3973,13 +3949,17 @@ "description": "Relative quality score of the match. The higher the better.", "format": "float" }, + "bpnl": { + "type": "string", + "description": "A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number." + }, "legalName": { "type": "string", "description": "The name of the legal entity according to official registers." }, - "bpnl": { + "legalShortName": { "type": "string", - "description": "A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number." + "description": "The abbreviated name of the legal entity." }, "identifiers": { "type": "array", @@ -3988,13 +3968,6 @@ "$ref": "#/components/schemas/LegalEntityIdentifierVerboseDto" } }, - "legalShortName": { - "type": "string", - "description": "The abbreviated name of the legal entity." - }, - "legalForm": { - "$ref": "#/components/schemas/LegalFormDto" - }, "states": { "type": "array", "description": "The list of (temporary) states of the legal entity.", @@ -4006,7 +3979,7 @@ "type": "array", "description": "The list of classifications of the legal entity, such as a specific industry.", "items": { - "$ref": "#/components/schemas/ClassificationVerboseDto" + "$ref": "#/components/schemas/LegalEntityClassificationVerboseDto" } }, "relations": { @@ -4021,6 +3994,9 @@ "description": "The date the business partner data was last indicated to be still current.", "format": "date-time" }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "createdAt": { "type": "string", "description": "The date when the data record has been created.", @@ -4031,6 +4007,9 @@ "description": "The date when the data record has been last updated.", "format": "date-time" }, + "legalForm": { + "$ref": "#/components/schemas/LegalFormDto" + }, "legalAddress": { "$ref": "#/components/schemas/LogisticAddressVerboseDto" } @@ -4044,13 +4023,6 @@ "type": "string", "description": "The name of the legal entity according to official registers." }, - "identifiers": { - "type": "array", - "description": "The list of identifiers of the legal entity.", - "items": { - "$ref": "#/components/schemas/LegalEntityIdentifierDto" - } - }, "legalShortName": { "type": "string", "description": "The abbreviated name of the legal entity." @@ -4059,6 +4031,13 @@ "type": "string", "description": "The legal form of the legal entity." }, + "identifiers": { + "type": "array", + "description": "The list of identifiers of the legal entity.", + "items": { + "$ref": "#/components/schemas/LegalEntityIdentifierDto" + } + }, "states": { "type": "array", "description": "The list of (temporary) states of the legal entity.", @@ -4070,15 +4049,21 @@ "type": "array", "description": "The list of classifications of the legal entity, such as a specific industry.", "items": { - "$ref": "#/components/schemas/ClassificationDto" + "$ref": "#/components/schemas/LegalEntityClassificationDto" } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "legalAddress": { "$ref": "#/components/schemas/LogisticAddressDto" }, "index": { "type": "string", "description": "User defined index to conveniently match this entry to the corresponding entry in the response." + }, + "requestKey": { + "type": "string" } }, "description": "Request for creating new business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL." @@ -4112,13 +4097,17 @@ "LegalEntityPartnerCreateVerboseDto": { "type": "object", "properties": { + "bpnl": { + "type": "string", + "description": "A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number." + }, "legalName": { "type": "string", "description": "The name of the legal entity according to official registers." }, - "bpnl": { + "legalShortName": { "type": "string", - "description": "A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number." + "description": "The abbreviated name of the legal entity." }, "identifiers": { "type": "array", @@ -4127,13 +4116,6 @@ "$ref": "#/components/schemas/LegalEntityIdentifierVerboseDto" } }, - "legalShortName": { - "type": "string", - "description": "The abbreviated name of the legal entity." - }, - "legalForm": { - "$ref": "#/components/schemas/LegalFormDto" - }, "states": { "type": "array", "description": "The list of (temporary) states of the legal entity.", @@ -4145,7 +4127,7 @@ "type": "array", "description": "The list of classifications of the legal entity, such as a specific industry.", "items": { - "$ref": "#/components/schemas/ClassificationVerboseDto" + "$ref": "#/components/schemas/LegalEntityClassificationVerboseDto" } }, "relations": { @@ -4160,6 +4142,9 @@ "description": "The date the business partner data was last indicated to be still current.", "format": "date-time" }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "createdAt": { "type": "string", "description": "The date when the data record has been created.", @@ -4170,6 +4155,9 @@ "description": "The date when the data record has been last updated.", "format": "date-time" }, + "legalForm": { + "$ref": "#/components/schemas/LegalFormDto" + }, "legalAddress": { "$ref": "#/components/schemas/LogisticAddressVerboseDto" }, @@ -4191,13 +4179,6 @@ "type": "string", "description": "The name of the legal entity according to official registers." }, - "identifiers": { - "type": "array", - "description": "The list of identifiers of the legal entity.", - "items": { - "$ref": "#/components/schemas/LegalEntityIdentifierDto" - } - }, "legalShortName": { "type": "string", "description": "The abbreviated name of the legal entity." @@ -4206,6 +4187,13 @@ "type": "string", "description": "The legal form of the legal entity." }, + "identifiers": { + "type": "array", + "description": "The list of identifiers of the legal entity.", + "items": { + "$ref": "#/components/schemas/LegalEntityIdentifierDto" + } + }, "states": { "type": "array", "description": "The list of (temporary) states of the legal entity.", @@ -4217,11 +4205,17 @@ "type": "array", "description": "The list of classifications of the legal entity, such as a specific industry.", "items": { - "$ref": "#/components/schemas/ClassificationDto" + "$ref": "#/components/schemas/LegalEntityClassificationDto" } }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "legalAddress": { "$ref": "#/components/schemas/LogisticAddressDto" + }, + "requestKey": { + "type": "string" } }, "description": "Request for updating a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL." @@ -4255,10 +4249,6 @@ "LegalEntityStateDto": { "type": "object", "properties": { - "description": { - "type": "string", - "description": "The description from the original source indicating the state of the legal entity, such as from the German Handelsregister." - }, "validFrom": { "type": "string", "description": "The date from which the state is valid.", @@ -4283,10 +4273,6 @@ "LegalEntityStateVerboseDto": { "type": "object", "properties": { - "description": { - "type": "string", - "description": "The description from the original source indicating the state of the legal entity, such as from the German Handelsregister." - }, "validFrom": { "type": "string", "description": "The date from which the state is valid.", @@ -4303,6 +4289,76 @@ }, "description": "A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating." }, + "LegalEntityWithLegalAddressVerboseDto": { + "type": "object", + "properties": { + "bpnl": { + "type": "string", + "description": "A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number." + }, + "legalName": { + "type": "string", + "description": "The name of the legal entity according to official registers." + }, + "legalShortName": { + "type": "string", + "description": "The abbreviated name of the legal entity." + }, + "identifiers": { + "type": "array", + "description": "The list of identifiers of the legal entity.", + "items": { + "$ref": "#/components/schemas/LegalEntityIdentifierVerboseDto" + } + }, + "states": { + "type": "array", + "description": "The list of (temporary) states of the legal entity.", + "items": { + "$ref": "#/components/schemas/LegalEntityStateVerboseDto" + } + }, + "classifications": { + "type": "array", + "description": "The list of classifications of the legal entity, such as a specific industry.", + "items": { + "$ref": "#/components/schemas/LegalEntityClassificationVerboseDto" + } + }, + "relations": { + "type": "array", + "description": "Relations to other business partners.", + "items": { + "$ref": "#/components/schemas/RelationVerboseDto" + } + }, + "currentness": { + "type": "string", + "description": "The date the business partner data was last indicated to be still current.", + "format": "date-time" + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, + "createdAt": { + "type": "string", + "description": "The date when the data record has been created.", + "format": "date-time" + }, + "updatedAt": { + "type": "string", + "description": "The date when the data record has been last updated.", + "format": "date-time" + }, + "legalForm": { + "$ref": "#/components/schemas/LegalFormDto" + }, + "legalAddress": { + "$ref": "#/components/schemas/LogisticAddressVerboseDto" + } + }, + "description": "In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL." + }, "LegalFormDto": { "type": "object", "properties": { @@ -4362,6 +4418,9 @@ }, "alternativePostalAddress": { "$ref": "#/components/schemas/AlternativePostalAddressDto" + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" } }, "description": "In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA." @@ -4379,12 +4438,14 @@ }, "states": { "type": "array", + "description": "The list of (temporary) states of the address.", "items": { "$ref": "#/components/schemas/AddressStateVerboseDto" } }, "identifiers": { "type": "array", + "description": "The list of identifiers of the address.", "items": { "$ref": "#/components/schemas/AddressIdentifierVerboseDto" } @@ -4413,6 +4474,9 @@ "description": "The date when the data record has been last updated.", "format": "date-time" }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "isLegalAddress": { "type": "boolean", "description": "Indicates if the address is the legal address to a legal entity." @@ -4744,7 +4808,7 @@ }, "description": "Paginated collection of results" }, - "PageDtoSitePoolVerboseDto": { + "PageDtoSiteVerboseDto": { "type": "object", "properties": { "totalElements": { @@ -4771,13 +4835,13 @@ "type": "array", "description": "Collection of results in the page", "items": { - "$ref": "#/components/schemas/SitePoolVerboseDto" + "$ref": "#/components/schemas/SiteVerboseDto" } } }, "description": "Paginated collection of results" }, - "PageDtoSiteVerboseDto": { + "PageDtoSiteWithMainAddressVerboseDto": { "type": "object", "properties": { "totalElements": { @@ -4804,7 +4868,7 @@ "type": "array", "description": "Collection of results in the page", "items": { - "$ref": "#/components/schemas/SiteVerboseDto" + "$ref": "#/components/schemas/SiteWithMainAddressVerboseDto" } } }, @@ -5150,12 +5214,6 @@ "geographicCoordinates": { "$ref": "#/components/schemas/GeoCoordinateDto" }, - "country": { - "$ref": "#/components/schemas/TypeKeyNameVerboseDtoCountryCode" - }, - "administrativeAreaLevel1": { - "$ref": "#/components/schemas/RegionDto" - }, "administrativeAreaLevel2": { "type": "string", "description": "The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country." @@ -5198,76 +5256,15 @@ "door": { "type": "string", "description": "The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite." - } - }, - "description": "A physical postal address describes the physical location of an office, warehouse, gate, etc." - }, - "PoolLegalEntityVerboseDto": { - "type": "object", - "properties": { - "legalName": { - "type": "string", - "description": "The name of the legal entity according to official registers." - }, - "bpnl": { - "type": "string", - "description": "A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number." }, - "identifiers": { - "type": "array", - "description": "The list of identifiers of the legal entity.", - "items": { - "$ref": "#/components/schemas/LegalEntityIdentifierVerboseDto" - } - }, - "legalShortName": { - "type": "string", - "description": "The abbreviated name of the legal entity." - }, - "legalForm": { - "$ref": "#/components/schemas/LegalFormDto" - }, - "states": { - "type": "array", - "description": "The list of (temporary) states of the legal entity.", - "items": { - "$ref": "#/components/schemas/LegalEntityStateVerboseDto" - } - }, - "classifications": { - "type": "array", - "description": "The list of classifications of the legal entity, such as a specific industry.", - "items": { - "$ref": "#/components/schemas/ClassificationVerboseDto" - } - }, - "relations": { - "type": "array", - "description": "Relations to other business partners.", - "items": { - "$ref": "#/components/schemas/RelationVerboseDto" - } - }, - "currentness": { - "type": "string", - "description": "The date the business partner data was last indicated to be still current.", - "format": "date-time" - }, - "createdAt": { - "type": "string", - "description": "The date when the data record has been created.", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "description": "The date when the data record has been last updated.", - "format": "date-time" + "country": { + "$ref": "#/components/schemas/TypeKeyNameVerboseDtoCountryCode" }, - "legalAddress": { - "$ref": "#/components/schemas/LogisticAddressVerboseDto" + "administrativeAreaLevel1": { + "$ref": "#/components/schemas/RegionDto" } }, - "description": "In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL." + "description": "A physical postal address describes the physical location of an office, warehouse, gate, etc." }, "RegionDto": { "type": "object", @@ -5626,6 +5623,7 @@ }, "states": { "type": "array", + "description": "The list of the (temporary) states of the site.", "items": { "$ref": "#/components/schemas/SiteStateDto" } @@ -5633,11 +5631,17 @@ "mainAddress": { "$ref": "#/components/schemas/LogisticAddressDto" }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "bpnlParent": { "type": "string" }, "index": { "type": "string" + }, + "requestKey": { + "type": "string" } }, "description": "Request for creating new business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS." @@ -5681,6 +5685,7 @@ }, "states": { "type": "array", + "description": "The list of the (temporary) states of the site.", "items": { "$ref": "#/components/schemas/SiteStateVerboseDto" } @@ -5699,6 +5704,9 @@ "description": "The date when the data record has been last updated.", "format": "date-time" }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, "mainAddress": { "$ref": "#/components/schemas/LogisticAddressVerboseDto" }, @@ -5721,12 +5729,19 @@ }, "states": { "type": "array", + "description": "The list of the (temporary) states of the site.", "items": { "$ref": "#/components/schemas/SiteStateDto" } }, "mainAddress": { "$ref": "#/components/schemas/LogisticAddressDto" + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, + "requestKey": { + "type": "string" } }, "description": "Request for updating a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS." @@ -5757,50 +5772,9 @@ }, "description": "Holds information about successfully and failed entities after the creating/updating of several objects" }, - "SitePoolVerboseDto": { - "type": "object", - "properties": { - "bpns": { - "type": "string", - "description": "A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located." - }, - "name": { - "type": "string", - "description": "The name of the site. This is not according to official registers but according to the name the owner chooses." - }, - "states": { - "type": "array", - "items": { - "$ref": "#/components/schemas/SiteStateVerboseDto" - } - }, - "bpnLegalEntity": { - "type": "string", - "description": "The BPNL of the legal entity owning the site." - }, - "createdAt": { - "type": "string", - "description": "The date when the data record has been created.", - "format": "date-time" - }, - "updatedAt": { - "type": "string", - "description": "The date when the data record has been last updated.", - "format": "date-time" - }, - "mainAddress": { - "$ref": "#/components/schemas/LogisticAddressVerboseDto" - } - }, - "description": "In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS." - }, "SiteStateDto": { "type": "object", "properties": { - "description": { - "type": "string", - "description": "The description from the original source indicating the state of the site." - }, "validFrom": { "type": "string", "description": "The date from which the state is valid.", @@ -5825,10 +5799,6 @@ "SiteStateVerboseDto": { "type": "object", "properties": { - "description": { - "type": "string", - "description": "The description from the original source indicating the state of the site." - }, "validFrom": { "type": "string", "description": "The date from which the state is valid.", @@ -5858,6 +5828,7 @@ }, "states": { "type": "array", + "description": "The list of the (temporary) states of the site.", "items": { "$ref": "#/components/schemas/SiteStateVerboseDto" } @@ -5875,71 +5846,94 @@ "type": "string", "description": "The date when the data record has been last updated.", "format": "date-time" + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" } }, "description": "In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS." }, - "StreetDto": { + "SiteWithMainAddressVerboseDto": { "type": "object", "properties": { + "bpns": { + "type": "string", + "description": "A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located." + }, "name": { "type": "string", - "description": "The name of the street." + "description": "The name of the site. This is not according to official registers but according to the name the owner chooses." }, - "houseNumber": { + "states": { + "type": "array", + "description": "The list of the (temporary) states of the site.", + "items": { + "$ref": "#/components/schemas/SiteStateVerboseDto" + } + }, + "bpnLegalEntity": { "type": "string", - "description": "The number representing the exact location of a building within the street." + "description": "The BPNL of the legal entity owning the site." }, - "milestone": { + "createdAt": { "type": "string", - "description": "The number representing the exact location of an addressed object within a street without house numbers, such as within long roads." + "description": "The date when the data record has been created.", + "format": "date-time" }, - "direction": { + "updatedAt": { "type": "string", - "description": "The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South." + "description": "The date when the data record has been last updated.", + "format": "date-time" + }, + "confidenceCriteria": { + "$ref": "#/components/schemas/ConfidenceCriteriaDto" + }, + "mainAddress": { + "$ref": "#/components/schemas/LogisticAddressVerboseDto" } }, - "description": "The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway" + "description": "In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS." }, - "SyncDto": { + "StreetDto": { "type": "object", "properties": { - "type": { + "name": { "type": "string", - "enum": [ - "OPENSEARCH", - "SAAS_IMPORT" - ] + "description": "The name of the street." }, - "status": { + "houseNumber": { "type": "string", - "enum": [ - "NOT_SYNCED", - "RUNNING", - "SUCCESS", - "ERROR" - ] + "description": "The number representing the exact location of a building within the street." }, - "count": { - "type": "integer", - "format": "int32" + "houseNumberSupplement": { + "type": "string" }, - "progress": { - "type": "number", - "format": "float" + "milestone": { + "type": "string", + "description": "The number representing the exact location of an addressed object within a street without house numbers, such as within long roads." }, - "errorDetails": { - "type": "string" + "direction": { + "type": "string", + "description": "The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South." }, - "startedAt": { + "namePrefix": { "type": "string", - "format": "date-time" + "description": "The street related information, which is usually printed before the official street name on an address label." }, - "finishedAt": { + "additionalNamePrefix": { "type": "string", - "format": "date-time" + "description": "The additional street related information, which is usually printed before the official street name on an address label." + }, + "nameSuffix": { + "type": "string", + "description": "The street related information, which is usually printed after the official street name on an address label." + }, + "additionalNameSuffix": { + "type": "string", + "description": "The additional street related information, which is usually printed after the official street name on an address label." } - } + }, + "description": "The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway" }, "TypeKeyNameVerboseDtoBusinessStateType": { "type": "object", diff --git a/docs/api/pool.yaml b/docs/api/pool.yaml index 10493e0ac..03dc482d3 100644 --- a/docs/api/pool.yaml +++ b/docs/api/pool.yaml @@ -1,10 +1,8 @@ openapi: 3.0.1 info: title: Business Partner Data Management Pool - description: >- - Service that manages and shares business partner data with other CatenaX - services - version: 4.1.0 + description: Service that manages and shares business partner data with other CatenaX services + version: 5.0.0-SNAPSHOT servers: - url: http://localhost:8080 description: Generated server url @@ -14,9 +12,7 @@ paths: tags: - site-controller summary: Get page of sites matching the pagination search criteria - description: >- - This endpoint retrieves all existing business partners of type - sites.Note that when using search parameters the max page is 20. + description: This endpoint retrieves all existing business partners of type sites. operationId: getSitesPaginated parameters: - name: page @@ -49,10 +45,7 @@ paths: tags: - site-controller summary: Updates an existing site - description: >- - Update existing business partner records of type site referenced via - BPNS. The endpoint expects to receive the full updated record, including - values that didn't change. + description: Update existing business partner records of type site referenced via BPNS. The endpoint expects to receive the full updated record, including values that didn't change. operationId: updateSite requestBody: content: @@ -64,9 +57,7 @@ paths: required: true responses: '200': - description: >- - Update sites request was processed successfully, possible errors are - returned + description: Update sites request was processed successfully, possible errors are returned content: application/json: schema: @@ -77,12 +68,7 @@ paths: tags: - site-controller summary: Creates a new site - description: >- - Create new business partners of type site by specifying the BPNL of the - legal entity each site belongs to. If the legal entitiy cannot be found, - the record is ignored.For matching purposes, on each record you can - specify your own index value which will reappear in the corresponding - record of the response. + description: Create new business partners of type site by specifying the BPNL of the legal entity each site belongs to. If the legal entitiy cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. operationId: createSite requestBody: content: @@ -94,9 +80,7 @@ paths: required: true responses: '200': - description: >- - New sites request was processed successfully, possible errors are - returned + description: New sites request was processed successfully, possible errors are returned content: application/json: schema: @@ -108,12 +92,7 @@ paths: tags: - legal-entity-controller summary: Returns legal entities by different search parameters - description: >- - This endpoint tries to find matches among all existing business partners - of type legal entity, filtering out partners which entirely do not match - and ranking the remaining partners according to the accuracy of the - match. The match of a partner is better the higher its relevancy score. - Note that when using search parameters the max page is 20. + description: 'This endpoint tries to find matches among all existing business partners of type legal entity, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. ' operationId: getLegalEntities parameters: - name: legalName @@ -152,10 +131,7 @@ paths: tags: - legal-entity-controller summary: Updates an existing legal entity - description: >- - Update existing business partner records of type legal entity referenced - via BPNL. The endpoint expects to receive the full updated record, - including values that didn't change. + description: Update existing business partner records of type legal entity referenced via BPNL. The endpoint expects to receive the full updated record, including values that didn't change. operationId: updateBusinessPartners requestBody: content: @@ -167,9 +143,7 @@ paths: required: true responses: '200': - description: >- - Update legal entities request was processed successfully, possible - errors are returned + description: Update legal entities request was processed successfully, possible errors are returned content: application/json: schema: @@ -180,11 +154,7 @@ paths: tags: - legal-entity-controller summary: Creates a new legal entity - description: >- - Create new business partners of type legal entity. The given additional - identifiers of a record need to be unique, otherwise they are ignored. - For matching purposes, on each record you can specify your own index - value which will reappear in the corresponding record of the response. + description: Create new business partners of type legal entity. The given additional identifiers of a record need to be unique, otherwise they are ignored. For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. operationId: createBusinessPartners requestBody: content: @@ -196,9 +166,7 @@ paths: required: true responses: '200': - description: >- - New legal entities request was processed successfully, possible - errors are returned + description: New legal entities request was processed successfully, possible errors are returned content: application/json: schema: @@ -210,12 +178,7 @@ paths: tags: - address-controller summary: Returns addresses by different search parameters - description: >- - This endpoint tries to find matches among all existing business partners - of type address, filtering out partners which entirely do not match and - ranking the remaining partners according to the accuracy of the match. - The match of a partner is better the higher its relevancy score. Note - that when using search parameters the max page is 20. + description: 'This endpoint tries to find matches among all existing business partners of type address, filtering out partners which entirely do not match and ranking the remaining partners according to the accuracy of the match. The match of a partner is better the higher its relevancy score. ' operationId: getAddresses_1 parameters: - name: name @@ -254,10 +217,7 @@ paths: tags: - address-controller summary: Updates an existing address - description: >- - Update existing business partner records of type address referenced via - BPNA. The endpoint expects to receive the full updated record, including - values that didn't change. + description: Update existing business partner records of type address referenced via BPNA. The endpoint expects to receive the full updated record, including values that didn't change. operationId: updateAddresses requestBody: content: @@ -280,13 +240,7 @@ paths: tags: - address-controller summary: Creates a new address - description: >- - Create new business partners of type address by specifying the BPN of - the parent each address belongs to. A parent can be either a site or - legal entity business partner. If the parent cannot be found, the record - is ignored.For matching purposes, on each record you can specify your - own index value which will reappear in the corresponding record of the - response. + description: Create new business partners of type address by specifying the BPN of the parent each address belongs to. A parent can be either a site or legal entity business partner. If the parent cannot be found, the record is ignored.For matching purposes, on each record you can specify your own index value which will reappear in the corresponding record of the response. operationId: createAddresses requestBody: content: @@ -298,72 +252,19 @@ paths: required: true responses: '200': - description: >- - New business partner record successfully created, possible errors - are returned + description: New business partner record successfully created, possible errors are returned content: application/json: schema: $ref: '#/components/schemas/AddressPartnerCreateResponseWrapper' '400': description: On malformed requests - /api/opensearch/business-partner: - get: - tags: - - open-search-controller - summary: Fetch information about the latest OpenSearch export - description: >- - Fetch information about the latest export (either ongoing or already - finished) - operationId: getBusinessPartners - responses: - '200': - description: Export information found - content: - application/json: - schema: - $ref: '#/components/schemas/SyncDto' - '500': - description: Fetching failed (no connection to database) - post: - tags: - - open-search-controller - summary: Index new business partner records on OpenSearch - description: >- - Triggers an asynchronous export of business partner records from BPDM to - OpenSearch. Only exports records which have been updated since the last - export. - operationId: export - responses: - '200': - description: Export of records successfully - content: - application/json: - schema: - $ref: '#/components/schemas/SyncDto' - '500': - description: Export failed (no connection to OpenSearch or database) - delete: - tags: - - open-search-controller - summary: Clear business partner index on OpenSearch - description: >- - Deletes all business partner records in the OpenSearch index. Also - resets the timestamp from the last export. - operationId: clear - responses: - '200': - description: Index successfully cleared - '500': - description: Clearing failed (no connection to OpenSearch or database) /api/catena/sites/search: post: tags: - site-controller summary: Returns sites by an array of BPNS and/or an array of corresponding BPNL - description: >- - Search business partners of type site by their BPNSs or by the BPNLs of - their parent legal entities + description: Search business partners of type site by their BPNSs or by the BPNLs of their parent legal entities operationId: searchSites parameters: - name: page @@ -395,7 +296,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PageDtoSitePoolVerboseDto' + $ref: '#/components/schemas/PageDtoSiteWithMainAddressVerboseDto' '400': description: On malformed request parameters /api/catena/sites/main-addresses/search: @@ -519,14 +420,7 @@ paths: tags: - metadata-controller summary: Creates a new legal form - description: >- - Create a new legal form which can be referenced by business partner - records. The actual name of the legal form is free to choose and doesn't - need to be unique. The technical key can be freely chosen but needs to - be unique for the businessPartnerType as it is used as reference by the - business partner records. A recommendation for technical keys: They - should be short, descriptive and use a restricted common character set - in order to ensure compatibility with older systems. + description: 'Create a new legal form which can be referenced by business partner records. The actual name of the legal form is free to choose and doesn''t need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.' operationId: createLegalForm requestBody: content: @@ -549,13 +443,8 @@ paths: post: tags: - legal-entity-controller - summary: >- - Confirms that the data of a legal entity business partner is still up to - date. - description: >- - Confirms that the data of a business partner is still up to date by - saving the current timestamp at the time this POST-request is made as - this business partner's "currentness". Ignores case of bpnl. + summary: Confirms that the data of a legal entity business partner is still up to date. + description: Confirms that the data of a business partner is still up to date by saving the current timestamp at the time this POST-request is made as this business partner's "currentness". Ignores case of bpnl. operationId: setLegalEntityCurrentness parameters: - name: bpnl @@ -576,13 +465,8 @@ paths: tags: - legal-entity-controller summary: Returns legal entities by an array of BPNL - description: >- - Search legal entity partners by their BPNLs. The response can contain - less results than the number of BPNLs that were requested, if some of - the BPNLs did not exist. For a single request, the maximum number of - BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} - entries. - operationId: searchSites_1 + description: Search legal entity partners by their BPNLs. The response can contain less results than the number of BPNLs that were requested, if some of the BPNLs did not exist. For a single request, the maximum number of BPNLs to search for is limited to ${bpdm.bpn.search-request-limit} entries. + operationId: searchLegalEntitys requestBody: content: application/json: @@ -599,11 +483,9 @@ paths: schema: type: array items: - $ref: '#/components/schemas/PoolLegalEntityVerboseDto' + $ref: '#/components/schemas/LegalEntityWithLegalAddressVerboseDto' '400': - description: >- - On malformed request parameters or if number of requested bpns - exceeds limit + description: On malformed request parameters or if number of requested bpns exceeds limit /api/catena/legal-entities/legal-addresses/search: post: tags: @@ -634,12 +516,8 @@ paths: get: tags: - metadata-controller - summary: >- - Returns all identifier types filtered by business partner type and - country. - description: >- - Lists all matching identifier types including validity details in a - paginated result + summary: Returns all identifier types filtered by business partner type and country. + description: Lists all matching identifier types including validity details in a paginated result operationId: getIdentifierTypes parameters: - name: page @@ -664,9 +542,7 @@ paths: required: true schema: type: string - description: >- - Specifies if an identifier type is valid for legal entities (L) or - addresses (A). Sites (S) are not supported. + description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. enum: - LEGAL_ENTITY - ADDRESS @@ -961,17 +837,7 @@ paths: tags: - metadata-controller summary: Creates a new identifier type - description: >- - Create a new identifier type (including validity details) which can be - referenced by business partner records. Identifier types such as BPN or - VAT determine with which kind of values a business partner can be - identified with. The actual name of the identifier type is free to - choose and doesn't need to be unique. The technical key can be freely - chosen but needs to be unique for the businessPartnerType as it is used - as reference by the business partner records. A recommendation for - technical keys: They should be short, descriptive and use a restricted - common character set in order to ensure compatibility with older - systems. + description: 'Create a new identifier type (including validity details) which can be referenced by business partner records. Identifier types such as BPN or VAT determine with which kind of values a business partner can be identified with. The actual name of the identifier type is free to choose and doesn''t need to be unique. The technical key can be freely chosen but needs to be unique for the businessPartnerType as it is used as reference by the business partner records. A recommendation for technical keys: They should be short, descriptive and use a restricted common character set in order to ensure compatibility with older systems.' operationId: createIdentifierType requestBody: content: @@ -994,9 +860,7 @@ paths: post: tags: - changelog-controller - summary: >- - Returns changelog entries as of a specified timestamp, optionally - filtered by a list of BPNL/S/A, or business partner types + summary: Returns changelog entries as of a specified timestamp, optionally filtered by a list of BPNL/S/A, or business partner types operationId: getChangelogEntries parameters: - name: page @@ -1037,16 +901,8 @@ paths: post: tags: - bpn-controller - summary: >- - Returns a list of identifier mappings of an identifier to a BPNL/A/S, - specified by a business partner type, identifier type and identifier - values - description: >- - Find business partner numbers by identifiers. The response can contain - less results than the number of identifier values that were requested, - if some of the identifiers did not exist. For a single request, the - maximum number of identifier values to search for is limited to - ${bpdm.bpn.search-request-limit} entries. + summary: Returns a list of identifier mappings of an identifier to a BPNL/A/S, specified by a business partner type, identifier type and identifier values + description: Find business partner numbers by identifiers. The response can contain less results than the number of identifier values that were requested, if some of the identifiers did not exist. For a single request, the maximum number of identifier values to search for is limited to ${bpdm.bpn.search-request-limit} entries. operationId: findBpnsByIdentifiers requestBody: content: @@ -1065,21 +921,15 @@ paths: items: $ref: '#/components/schemas/BpnIdentifierMappingDto' '400': - description: >- - On malformed request parameters or if number of requested bpns - exceeds limit + description: On malformed request parameters or if number of requested bpns exceeds limit '404': description: Specified identifier type not found /api/catena/addresses/search: post: tags: - address-controller - summary: >- - Returns addresses by an array of BPNA and/or an array of corresponding - BPNS and/or an array of corresponding BPNL. - description: >- - Search business partners of type address by their BPNA or their parents' - BPNL or BPNS. + summary: Returns addresses by an array of BPNA and/or an array of corresponding BPNS and/or an array of corresponding BPNL. + description: Search business partners of type address by their BPNA or their parents' BPNL or BPNS. operationId: searchAddresses parameters: - name: page @@ -1134,7 +984,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/SitePoolVerboseDto' + $ref: '#/components/schemas/SiteWithMainAddressVerboseDto' '400': description: On malformed request parameters '404': @@ -1156,15 +1006,8 @@ paths: get: tags: - legal-entity-controller - summary: >- - Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, - specified by the identifier type - description: >- - This endpoint tries to find a business partner by the specified - identifier. The identifier value is case insensitively compared but - needs to be given exactly. By default the value given is interpreted as - a BPN. By specifying the technical key of another identifier typethe - value is matched against the identifiers of that given type. + summary: Returns a legal entity by identifier, like BPN, DUNS or EU VAT ID, specified by the identifier type + description: This endpoint tries to find a business partner by the specified identifier. The identifier value is case insensitively compared but needs to be given exactly. By default the value given is interpreted as a BPN. By specifying the technical key of another identifier typethe value is matched against the identifiers of that given type. operationId: getLegalEntity parameters: - name: idValue @@ -1186,22 +1029,17 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/PoolLegalEntityVerboseDto' + $ref: '#/components/schemas/LegalEntityWithLegalAddressVerboseDto' '400': description: On malformed request parameters '404': - description: >- - No business partner found under specified identifier or specified - identifier type not found + description: No business partner found under specified identifier or specified identifier type not found /api/catena/legal-entities/{bpnl}/sites: get: tags: - legal-entity-controller summary: Returns all sites of a legal entity with a specific BPNL - description: >- - Get business partners of type site belonging to a business partner of - type legal entity, identified by the business partner's bpnl ignoring - case. + description: Get business partners of type site belonging to a business partner of type legal entity, identified by the business partner's bpnl ignoring case. operationId: getSites parameters: - name: bpnl @@ -1243,10 +1081,7 @@ paths: tags: - legal-entity-controller summary: Returns all addresses of a legal entity with a specific BPNL - description: >- - Get business partners of type address belonging to a business partner of - type legal entity, identified by the business partner's BPNL ignoring - case. + description: Get business partners of type address belonging to a business partner of type legal entity, identified by the business partner's BPNL ignoring case. operationId: getAddresses parameters: - name: bpnl @@ -1287,12 +1122,8 @@ paths: get: tags: - metadata-controller - summary: >- - Get all field quality rules filtered by country (specified by its ISO - 3166-1 alpha-2 country code) - description: >- - List the country specific data rules for entity fields.All fields that - are not in this list are considered to be forbidden. + summary: Get all field quality rules filtered by country (specified by its ISO 3166-1 alpha-2 country code) + description: List the country specific data rules for entity fields.All fields that are not in this list are considered to be forbidden. operationId: getFieldQualityRules parameters: - name: country @@ -1589,12 +1420,8 @@ paths: get: tags: - metadata-controller - summary: >- - Get page of country subdivisions suitable for the - administrativeAreaLevel1 address property - description: >- - Lists all currently known country subdivisions according to ISO 3166-2 - in a paginated result + summary: Get page of country subdivisions suitable for the administrativeAreaLevel1 address property + description: Lists all currently known country subdivisions according to ISO 3166-2 in a paginated result operationId: getAdminAreasLevel1 parameters: - name: page @@ -1659,9 +1486,7 @@ components: type: type: string description: The type of the identifier. - description: >- - An address identifier (uniquely) identifies the address, such as the - Global Location Number (GLN). + description: An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN). AddressIdentifierVerboseDto: type: object properties: @@ -1670,9 +1495,7 @@ components: description: The value of the identifier like "0847976000005". type: $ref: '#/components/schemas/TypeKeyNameVerboseDtoString' - description: >- - An address identifier (uniquely) identifies the address, such as the - Global Location Number (GLN). + description: An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN). AddressMatchVerboseDto: type: object properties: @@ -1682,19 +1505,7 @@ components: format: float address: $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: >- - Match for a business partner record of type address. In general, an - address is a collection of information to describe a physical location, - using a street name with a house number and/or a post office box as - reference. In addition, an address consists of several postal - attributes, such as country, region (state), county, township, city, - district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + description: Match for a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressPartnerBpnSearchRequest: type: object properties: @@ -1716,9 +1527,7 @@ components: properties: name: type: string - description: >- - The name of the address. This is not according to official registers - but according to the name the sharing member chooses. + description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. states: type: array description: The list of (temporary) states of the address. @@ -1733,23 +1542,15 @@ components: $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: $ref: '#/components/schemas/AlternativePostalAddressDto' + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' bpnParent: type: string index: type: string - description: >- - Request for creating new business partner record of type address. In - general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + requestKey: + type: string + description: Request for creating new business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressPartnerCreateResponseWrapper: type: object properties: @@ -1767,33 +1568,24 @@ components: entityCount: type: integer format: int32 - description: >- - Holds information about successfully and failed entities after the - creating/updating of several objects + description: Holds information about successfully and failed entities after the creating/updating of several objects AddressPartnerCreateVerboseDto: type: object properties: bpna: type: string - description: >- - A BPNA represents and uniquely identifies an address, which can be - the legal address of a legal entity, and/or the main address of a - site, or any additional address of a legal entity or site (such as - different gates). It is important to note that only the BPNL must be - used to uniquely identify a legal entity. Even in the case that the - BPNA represents the legal address of the legal entity, it shall not - be used to uniquely identify the legal entity. + description: A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity. name: type: string - description: >- - The name of the address. This is not according to official registers - but according to the name the sharing member chooses. + description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. states: type: array + description: The list of (temporary) states of the address. items: $ref: '#/components/schemas/AddressStateVerboseDto' identifiers: type: array + description: The list of identifiers of the address. items: $ref: '#/components/schemas/AddressIdentifierVerboseDto' physicalPostalAddress: @@ -1814,30 +1606,17 @@ components: type: string description: The date when the data record has been last updated. format: date-time + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' isLegalAddress: type: boolean description: Indicates if the address is the legal address to a legal entity. isMainAddress: type: boolean - description: >- - Indicates if the address is the main address to a site. This is - where typically the main entrance or the reception is located, or - where the mail is delivered to. + description: Indicates if the address is the main address to a site. This is where typically the main entrance or the reception is located, or where the mail is delivered to. index: type: string - description: >- - Created business partner of type address. In general, an address is a - collection of information to describe a physical location, using a - street name with a house number and/or a post office box as reference. - In addition, an address consists of several postal attributes, such as - country, region (state), county, township, city, district, or postal - code, which help deliver mail.In Catena-X, an address is a type of - business partner representing the legal address of a legal entity, - and/or the main address of a site, or any additional address of a legal - entity or site (such as different gates).An address is owned by a legal - entity. Thus, exactly one legal entity is assigned to an address. An - address can belong to a site. Thus, one or no site is assigned to an - address. An address is uniquely identified by the BPNA. + description: Created business partner of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressPartnerUpdateRequest: type: object properties: @@ -1845,9 +1624,7 @@ components: type: string name: type: string - description: >- - The name of the address. This is not according to official registers - but according to the name the sharing member chooses. + description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. states: type: array description: The list of (temporary) states of the address. @@ -1862,19 +1639,11 @@ components: $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: $ref: '#/components/schemas/AlternativePostalAddressDto' - description: >- - Request for updating a business partner record of type address. In - general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + requestKey: + type: string + description: Request for updating a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressPartnerUpdateResponseWrapper: type: object properties: @@ -1892,17 +1661,10 @@ components: entityCount: type: integer format: int32 - description: >- - Holds information about successfully and failed entities after the - creating/updating of several objects + description: Holds information about successfully and failed entities after the creating/updating of several objects AddressStateDto: type: object properties: - description: - type: string - description: >- - The description from the original source indicating the state of the - address. validFrom: type: string description: The date from which the state is valid. @@ -1917,19 +1679,10 @@ components: enum: - ACTIVE - INACTIVE - description: >- - An address state indicates if the address is active or inactive. This - does not describe the relation between a sharing member and a business - partner and whether they have active business, but it describes whether - the business partner is still operating at that address. + description: An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address. AddressStateVerboseDto: type: object properties: - description: - type: string - description: >- - The description from the original source indicating the state of the - address. validFrom: type: string description: The date from which the state is valid. @@ -1940,11 +1693,7 @@ components: format: date-time type: $ref: '#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType' - description: >- - An address state indicates if the address is active or inactive. This - does not describe the relation between a sharing member and a business - partner and whether they have active business, but it describes whether - the business partner is still operating at that address. + description: An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address. AlternativePostalAddressDto: required: - city @@ -1957,9 +1706,7 @@ components: $ref: '#/components/schemas/GeoCoordinateDto' country: type: string - description: >- - The 2-digit country code of the physical postal address according to - ISO 3166-1. + description: The 2-digit country code of the physical postal address according to ISO 3166-1. enum: - UNDEFINED - AC @@ -2235,94 +1982,56 @@ components: - ZW administrativeAreaLevel1: type: string - description: >- - The 2-digit country subdivision code according to ISO 3166-2, such - as a region within a country. + description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country. postalCode: type: string - description: >- - The alphanumeric identifier (sometimes including spaces or - punctuation) of the physical postal address for the purpose of - sorting mail, synonyms:postcode, post code, PIN or ZIP code. + description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. city: type: string - description: >- - The name of the city of the physical postal address, synonyms: town, - village, municipality. + description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' deliveryServiceType: type: string - description: >- - One of the alternative postal address types: P.O. box, private bag, - boite postale. + description: 'One of the alternative postal address types: P.O. box, private bag, boite postale.' enum: - PO_BOX - PRIVATE_BAG - BOITE_POSTALE deliveryServiceQualifier: type: string - description: >- - The qualifier uniquely identifying the delivery service endpoint of - the alternative postal address in conjunction with the delivery - service number. In some countries for example, entering a P.O. box - number, postal code and city is not sufficient to uniquely identify - a P.O. box, because the same P.O. box number is assigned multiple - times in some cities. + description: The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities. deliveryServiceNumber: type: string - description: >- - The number indicating the delivery service endpoint of the - alternative postal address to which the delivery is to be delivered, - such as a P.O. box number or a private bag number. - description: >- - An alternative postal address describes an alternative way of delivery - for example if the goods are to be picked up somewhere else. + description: The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number. + description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. AlternativePostalAddressVerboseDto: type: object properties: geographicCoordinates: $ref: '#/components/schemas/GeoCoordinateDto' - country: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoCountryCode' - administrativeAreaLevel1: - $ref: '#/components/schemas/RegionDto' postalCode: type: string - description: >- - The alphanumeric identifier (sometimes including spaces or - punctuation) of the physical postal address for the purpose of - sorting mail, synonyms:postcode, post code, PIN or ZIP code. + description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. city: type: string - description: >- - The name of the city of the physical postal address, synonyms: town, - village, municipality. + description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' deliveryServiceType: type: string - description: >- - One of the alternative postal address types: P.O. box, private bag, - boite postale. + description: 'One of the alternative postal address types: P.O. box, private bag, boite postale.' enum: - PO_BOX - PRIVATE_BAG - BOITE_POSTALE deliveryServiceQualifier: type: string - description: >- - The qualifier uniquely identifying the delivery service endpoint of - the alternative postal address in conjunction with the delivery - service number. In some countries for example, entering a P.O. box - number, postal code and city is not sufficient to uniquely identify - a P.O. box, because the same P.O. box number is assigned multiple - times in some cities. + description: The qualifier uniquely identifying the delivery service endpoint of the alternative postal address in conjunction with the delivery service number. In some countries for example, entering a P.O. box number, postal code and city is not sufficient to uniquely identify a P.O. box, because the same P.O. box number is assigned multiple times in some cities. deliveryServiceNumber: type: string - description: >- - The number indicating the delivery service endpoint of the - alternative postal address to which the delivery is to be delivered, - such as a P.O. box number or a private bag number. - description: >- - An alternative postal address describes an alternative way of delivery - for example if the goods are to be picked up somewhere else. + description: The number indicating the delivery service endpoint of the alternative postal address to which the delivery is to be delivered, such as a P.O. box number or a private bag number. + country: + $ref: '#/components/schemas/TypeKeyNameVerboseDtoCountryCode' + administrativeAreaLevel1: + $ref: '#/components/schemas/RegionDto' + description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. BpnIdentifierMappingDto: type: object properties: @@ -2336,14 +2045,10 @@ components: properties: bpn: type: string - description: >- - The business partner number for which the changelog entry was - created. Can be either a BPNL, BPNS or BPNA. + description: The business partner number for which the changelog entry was created. Can be either a BPNL, BPNS or BPNA. businessPartnerType: type: string - description: >- - One of the types of business partners for which the changelog entry - was created: legal entity, site, address. + description: 'One of the types of business partners for which the changelog entry was created: legal entity, site, address.' enum: - LEGAL_ENTITY - SITE @@ -2355,16 +2060,11 @@ components: format: date-time changelogType: type: string - description: >- - One of the actions for which the changelog entry was created: - create, update. + description: 'One of the actions for which the changelog entry was created: create, update.' enum: - CREATE - UPDATE - description: >- - An entry of the changelog, which is created each time a business partner - is modified and contains data about the change. The actual new state of - the business partner is not included. + description: An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included. ChangelogSearchRequest: type: object properties: @@ -2376,17 +2076,13 @@ components: bpns: uniqueItems: true type: array - description: >- - Only for business partners with the given array of BPNL/S/A. Ignored - if empty. + description: Only for business partners with the given array of BPNL/S/A. Ignored if empty. items: type: string businessPartnerTypes: uniqueItems: true type: array - description: >- - Only for business partners with the given array of business partner - types. Ignored if empty. + description: Only for business partners with the given array of business partner types. Ignored if empty. items: type: string enum: @@ -2395,46 +2091,25 @@ components: - ADDRESS - GENERIC description: Request for searching and filtering the business partner changelog - ClassificationDto: - type: object - properties: - type: - type: string - description: Type of classification. - enum: - - NACE - - NAF - - NAICS - - SIC - code: - type: string - description: The identifier of the class belonging to the classification. - value: - type: string - description: The name of the class belonging to the classification. - description: >- - A legal entity classification is an assignment of the legal entity to an - industry. It does not necessarily have to be the only industry the - company is active in (see large companies operating in different - industries). Multiple assignments to several industries are possible per - classification type. - ClassificationVerboseDto: + ConfidenceCriteriaDto: type: object properties: - value: + sharedByOwner: + type: boolean + checkedByExternalDataSource: + type: boolean + numberOfBusinessPartners: + type: integer + format: int32 + lastConfidenceCheckAt: type: string - description: The name of the class belonging to the classification. - code: + format: date-time + nextConfidenceCheckAt: type: string - description: The identifier of the class belonging to the classification. - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoClassificationType' - description: >- - A legal entity classification is an assignment of the legal entity to an - industry. It does not necessarily have to be the only industry the - company is active in (see large companies operating in different - industries). Multiple assignments to several industries are possible per - classification type. + format: date-time + confidenceLevel: + type: integer + format: int32 CountrySubdivisionDto: type: object properties: @@ -3138,17 +2813,13 @@ components: type: number description: Altitude, if applicable format: float - description: >- - The exact location of the physical postal address in latitude, - longitude, and altitude. + description: The exact location of the physical postal address in latitude, longitude, and altitude. IdentifierTypeDetailDto: type: object properties: country: type: string - description: >- - 2-digit country code for which this identifier is valid; null for - universal identifiers. + description: 2-digit country code for which this identifier is valid; null for universal identifiers. enum: - UNDEFINED - AC @@ -3425,22 +3096,16 @@ components: mandatory: type: boolean description: True if identifier is mandatory in this country. - description: >- - Information for which countries an identifier type is valid and - mandatory. + description: Information for which countries an identifier type is valid and mandatory. IdentifierTypeDto: type: object properties: technicalKey: type: string - description: >- - The technical identifier (unique in combination with - businessPartnerType). + description: The technical identifier (unique in combination with businessPartnerType). businessPartnerType: type: string - description: >- - Specifies if an identifier type is valid for legal entities (L) or - addresses (A). Sites (S) are not supported. + description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. enum: - LEGAL_ENTITY - ADDRESS @@ -3452,18 +3117,13 @@ components: description: Validity details. items: $ref: '#/components/schemas/IdentifierTypeDetailDto' - description: >- - An identifier type defines the name or category of an identifier, such - as the German Handelsregisternummer, VAT number, Global Location Number - (GLN), etc. The identifier type is valid for a business partner type. + description: An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type. IdentifiersSearchRequest: type: object properties: businessPartnerType: type: string - description: >- - Specifies if an identifier type is valid for legal entities (L) or - addresses (A). Sites (S) are not supported. + description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. enum: - LEGAL_ENTITY - ADDRESS @@ -3490,6 +3150,38 @@ components: type: string format: date-time description: Legal address for legal entity + LegalEntityClassificationDto: + required: + - type + type: object + properties: + type: + type: string + description: Type of classification. + enum: + - NACE + - NAF + - NAICS + - SIC + code: + type: string + description: The identifier of the class belonging to the classification. + value: + type: string + description: The name of the class belonging to the classification. + description: A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type. + LegalEntityClassificationVerboseDto: + type: object + properties: + value: + type: string + description: The name of the class belonging to the classification. + code: + type: string + description: The identifier of the class belonging to the classification. + type: + $ref: '#/components/schemas/TypeKeyNameVerboseDtoClassificationType' + description: A legal entity classification is an assignment of the legal entity to an industry. It does not necessarily have to be the only industry the company is active in (see large companies operating in different industries). Multiple assignments to several industries are possible per classification type. LegalEntityIdentifierDto: type: object properties: @@ -3501,27 +3193,20 @@ components: description: The type of the identifier. issuingBody: type: string - description: >- - The name of the official register, where the identifier is - registered. For example, a Handelsregisternummer in Germany is only - valid with its corresponding Handelsregister. + description: The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister. + description: A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc. LegalEntityIdentifierVerboseDto: type: object properties: value: type: string description: The value of the identifier like "DE123465789". - type: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoString' issuingBody: type: string - description: >- - The name of the official register, where the identifier is - registered. For example, a Handelsregisternummer in Germany is only - valid with its corresponding Handelsregister. - description: >- - A legal entity identifier (uniquely) identifies the legal entity, such - as the German Handelsregisternummer, a VAT number, etc. + description: The name of the official register, where the identifier is registered. For example, a Handelsregisternummer in Germany is only valid with its corresponding Handelsregister. + type: + $ref: '#/components/schemas/TypeKeyNameVerboseDtoString' + description: A legal entity identifier (uniquely) identifies the legal entity, such as the German Handelsregisternummer, a VAT number, etc. LegalEntityMatchVerboseDto: type: object properties: @@ -3529,25 +3214,20 @@ components: type: number description: Relative quality score of the match. The higher the better. format: float + bpnl: + type: string + description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. legalName: type: string description: The name of the legal entity according to official registers. - bpnl: + legalShortName: type: string - description: >- - A BPNL represents and uniquely identifies a legal entity, which is - defined by its legal name (including legal form, if registered), - legal address and tax number. + description: The abbreviated name of the legal entity. identifiers: type: array description: The list of identifiers of the legal entity. items: $ref: '#/components/schemas/LegalEntityIdentifierVerboseDto' - legalShortName: - type: string - description: The abbreviated name of the legal entity. - legalForm: - $ref: '#/components/schemas/LegalFormDto' states: type: array description: The list of (temporary) states of the legal entity. @@ -3555,11 +3235,9 @@ components: $ref: '#/components/schemas/LegalEntityStateVerboseDto' classifications: type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. + description: The list of classifications of the legal entity, such as a specific industry. items: - $ref: '#/components/schemas/ClassificationVerboseDto' + $ref: '#/components/schemas/LegalEntityClassificationVerboseDto' relations: type: array description: Relations to other business partners. @@ -3567,10 +3245,10 @@ components: $ref: '#/components/schemas/RelationVerboseDto' currentness: type: string - description: >- - The date the business partner data was last indicated to be still - current. + description: The date the business partner data was last indicated to be still current. format: date-time + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' createdAt: type: string description: The date when the data record has been created. @@ -3579,40 +3257,28 @@ components: type: string description: The date when the data record has been last updated. format: date-time + legalForm: + $ref: '#/components/schemas/LegalFormDto' legalAddress: $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: >- - Match with score for a business partner record of type legal entity. In - general, a legal entity is a juridical person that has legal rights and - duties related to contracts, agreements, and obligations. The term - especially applies to any kind of organization (such as an enterprise or - company, university, association, etc.) established under the law - applicable to a country.In Catena-X, a legal entity is a type of - business partner representing a legally registered organization with its - official registration information, such as legal name (including legal - form, if registered), legal address and tax number.A legal entity has - exactly one legal address, but it is possible to specify additional - addresses that a legal entity owns. Thus, at least one address is - assigned to a legal entity. A legal entity can own sites. Thus, many or - no sites are assigned to a legal entity. A legal entity is uniquely - identified by the BPNL. + description: Match with score for a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityPartnerCreateRequest: type: object properties: legalName: type: string description: The name of the legal entity according to official registers. - identifiers: - type: array - description: The list of identifiers of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityIdentifierDto' legalShortName: type: string description: The abbreviated name of the legal entity. legalForm: type: string description: The legal form of the legal entity. + identifiers: + type: array + description: The list of identifiers of the legal entity. + items: + $ref: '#/components/schemas/LegalEntityIdentifierDto' states: type: array description: The list of (temporary) states of the legal entity. @@ -3620,33 +3286,19 @@ components: $ref: '#/components/schemas/LegalEntityStateDto' classifications: type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. + description: The list of classifications of the legal entity, such as a specific industry. items: - $ref: '#/components/schemas/ClassificationDto' + $ref: '#/components/schemas/LegalEntityClassificationDto' + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' legalAddress: $ref: '#/components/schemas/LogisticAddressDto' index: type: string - description: >- - User defined index to conveniently match this entry to the - corresponding entry in the response. - description: >- - Request for creating new business partner record of type legal entity. - In general, a legal entity is a juridical person that has legal rights - and duties related to contracts, agreements, and obligations. The term - especially applies to any kind of organization (such as an enterprise or - company, university, association, etc.) established under the law - applicable to a country.In Catena-X, a legal entity is a type of - business partner representing a legally registered organization with its - official registration information, such as legal name (including legal - form, if registered), legal address and tax number.A legal entity has - exactly one legal address, but it is possible to specify additional - addresses that a legal entity owns. Thus, at least one address is - assigned to a legal entity. A legal entity can own sites. Thus, many or - no sites are assigned to a legal entity. A legal entity is uniquely - identified by the BPNL. + description: User defined index to conveniently match this entry to the corresponding entry in the response. + requestKey: + type: string + description: Request for creating new business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityPartnerCreateResponseWrapper: type: object properties: @@ -3664,31 +3316,24 @@ components: entityCount: type: integer format: int32 - description: >- - Holds information about successfully and failed entities after the - creating/updating of several objects + description: Holds information about successfully and failed entities after the creating/updating of several objects LegalEntityPartnerCreateVerboseDto: type: object properties: + bpnl: + type: string + description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. legalName: type: string description: The name of the legal entity according to official registers. - bpnl: + legalShortName: type: string - description: >- - A BPNL represents and uniquely identifies a legal entity, which is - defined by its legal name (including legal form, if registered), - legal address and tax number. + description: The abbreviated name of the legal entity. identifiers: type: array description: The list of identifiers of the legal entity. items: $ref: '#/components/schemas/LegalEntityIdentifierVerboseDto' - legalShortName: - type: string - description: The abbreviated name of the legal entity. - legalForm: - $ref: '#/components/schemas/LegalFormDto' states: type: array description: The list of (temporary) states of the legal entity. @@ -3696,11 +3341,9 @@ components: $ref: '#/components/schemas/LegalEntityStateVerboseDto' classifications: type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. + description: The list of classifications of the legal entity, such as a specific industry. items: - $ref: '#/components/schemas/ClassificationVerboseDto' + $ref: '#/components/schemas/LegalEntityClassificationVerboseDto' relations: type: array description: Relations to other business partners. @@ -3708,10 +3351,10 @@ components: $ref: '#/components/schemas/RelationVerboseDto' currentness: type: string - description: >- - The date the business partner data was last indicated to be still - current. + description: The date the business partner data was last indicated to be still current. format: date-time + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' createdAt: type: string description: The date when the data record has been created. @@ -3720,51 +3363,34 @@ components: type: string description: The date when the data record has been last updated. format: date-time + legalForm: + $ref: '#/components/schemas/LegalFormDto' legalAddress: $ref: '#/components/schemas/LogisticAddressVerboseDto' index: type: string - description: >- - User defined index to conveniently match this entry to the - corresponding entry in the response. - description: >- - Created/updated business partner of type legal entity. In general, a - legal entity is a juridical person that has legal rights and duties - related to contracts, agreements, and obligations. The term especially - applies to any kind of organization (such as an enterprise or company, - university, association, etc.) established under the law applicable to a - country.In Catena-X, a legal entity is a type of business partner - representing a legally registered organization with its official - registration information, such as legal name (including legal form, if - registered), legal address and tax number.A legal entity has exactly one - legal address, but it is possible to specify additional addresses that a - legal entity owns. Thus, at least one address is assigned to a legal - entity. A legal entity can own sites. Thus, many or no sites are - assigned to a legal entity. A legal entity is uniquely identified by the - BPNL. + description: User defined index to conveniently match this entry to the corresponding entry in the response. + description: Created/updated business partner of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityPartnerUpdateRequest: type: object properties: bpnl: type: string - description: >- - A BPNL represents and uniquely identifies a legal entity, which is - defined by its legal name (including legal form, if registered), - legal address and tax number. + description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. legalName: type: string description: The name of the legal entity according to official registers. - identifiers: - type: array - description: The list of identifiers of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityIdentifierDto' legalShortName: type: string description: The abbreviated name of the legal entity. legalForm: type: string description: The legal form of the legal entity. + identifiers: + type: array + description: The list of identifiers of the legal entity. + items: + $ref: '#/components/schemas/LegalEntityIdentifierDto' states: type: array description: The list of (temporary) states of the legal entity. @@ -3772,28 +3398,16 @@ components: $ref: '#/components/schemas/LegalEntityStateDto' classifications: type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. + description: The list of classifications of the legal entity, such as a specific industry. items: - $ref: '#/components/schemas/ClassificationDto' + $ref: '#/components/schemas/LegalEntityClassificationDto' + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' legalAddress: $ref: '#/components/schemas/LogisticAddressDto' - description: >- - Request for updating a business partner record of type legal entity. In - general, a legal entity is a juridical person that has legal rights and - duties related to contracts, agreements, and obligations. The term - especially applies to any kind of organization (such as an enterprise or - company, university, association, etc.) established under the law - applicable to a country.In Catena-X, a legal entity is a type of - business partner representing a legally registered organization with its - official registration information, such as legal name (including legal - form, if registered), legal address and tax number.A legal entity has - exactly one legal address, but it is possible to specify additional - addresses that a legal entity owns. Thus, at least one address is - assigned to a legal entity. A legal entity can own sites. Thus, many or - no sites are assigned to a legal entity. A legal entity is uniquely - identified by the BPNL. + requestKey: + type: string + description: Request for updating a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityPartnerUpdateResponseWrapper: type: object properties: @@ -3811,17 +3425,10 @@ components: entityCount: type: integer format: int32 - description: >- - Holds information about successfully and failed entities after the - creating/updating of several objects + description: Holds information about successfully and failed entities after the creating/updating of several objects LegalEntityStateDto: type: object properties: - description: - type: string - description: >- - The description from the original source indicating the state of the - legal entity, such as from the German Handelsregister. validFrom: type: string description: The date from which the state is valid. @@ -3836,19 +3443,10 @@ components: enum: - ACTIVE - INACTIVE - description: >- - A legal entity state indicates if the legal entity is active or - inactive. This does not describe the relation between a sharing member - and a business partner and whether they have active business, but it - describes whether the legal entity is still operating. + description: A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating. LegalEntityStateVerboseDto: type: object properties: - description: - type: string - description: >- - The description from the original source indicating the state of the - legal entity, such as from the German Handelsregister. validFrom: type: string description: The date from which the state is valid. @@ -3859,11 +3457,58 @@ components: format: date-time type: $ref: '#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType' - description: >- - A legal entity state indicates if the legal entity is active or - inactive. This does not describe the relation between a sharing member - and a business partner and whether they have active business, but it - describes whether the legal entity is still operating. + description: A legal entity state indicates if the legal entity is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the legal entity is still operating. + LegalEntityWithLegalAddressVerboseDto: + type: object + properties: + bpnl: + type: string + description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. + legalName: + type: string + description: The name of the legal entity according to official registers. + legalShortName: + type: string + description: The abbreviated name of the legal entity. + identifiers: + type: array + description: The list of identifiers of the legal entity. + items: + $ref: '#/components/schemas/LegalEntityIdentifierVerboseDto' + states: + type: array + description: The list of (temporary) states of the legal entity. + items: + $ref: '#/components/schemas/LegalEntityStateVerboseDto' + classifications: + type: array + description: The list of classifications of the legal entity, such as a specific industry. + items: + $ref: '#/components/schemas/LegalEntityClassificationVerboseDto' + relations: + type: array + description: Relations to other business partners. + items: + $ref: '#/components/schemas/RelationVerboseDto' + currentness: + type: string + description: The date the business partner data was last indicated to be still current. + format: date-time + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + createdAt: + type: string + description: The date when the data record has been created. + format: date-time + updatedAt: + type: string + description: The date when the data record has been last updated. + format: date-time + legalForm: + $ref: '#/components/schemas/LegalFormDto' + legalAddress: + $ref: '#/components/schemas/LogisticAddressVerboseDto' + description: In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalFormDto: type: object properties: @@ -3875,12 +3520,8 @@ components: description: The name of legal form according to ISO 20275. abbreviation: type: string - description: >- - The abbreviated name of the legal form, such as AG for German - Aktiengesellschaft. - description: >- - A legal form is a mandatory corporate legal framework by which companies - can conduct business, charitable or other permissible activities. + description: The abbreviated name of the legal form, such as AG for German Aktiengesellschaft. + description: A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. LegalFormRequest: type: object properties: @@ -3896,9 +3537,7 @@ components: properties: name: type: string - description: >- - The name of the address. This is not according to official registers - but according to the name the sharing member chooses. + description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. states: type: array description: The list of (temporary) states of the address. @@ -3913,42 +3552,26 @@ components: $ref: '#/components/schemas/PhysicalPostalAddressDto' alternativePostalAddress: $ref: '#/components/schemas/AlternativePostalAddressDto' - description: >- - In general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. LogisticAddressVerboseDto: type: object properties: bpna: type: string - description: >- - A BPNA represents and uniquely identifies an address, which can be - the legal address of a legal entity, and/or the main address of a - site, or any additional address of a legal entity or site (such as - different gates). It is important to note that only the BPNL must be - used to uniquely identify a legal entity. Even in the case that the - BPNA represents the legal address of the legal entity, it shall not - be used to uniquely identify the legal entity. + description: A BPNA represents and uniquely identifies an address, which can be the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates). It is important to note that only the BPNL must be used to uniquely identify a legal entity. Even in the case that the BPNA represents the legal address of the legal entity, it shall not be used to uniquely identify the legal entity. name: type: string - description: >- - The name of the address. This is not according to official registers - but according to the name the sharing member chooses. + description: The name of the address. This is not according to official registers but according to the name the sharing member chooses. states: type: array + description: The list of (temporary) states of the address. items: $ref: '#/components/schemas/AddressStateVerboseDto' identifiers: type: array + description: The list of identifiers of the address. items: $ref: '#/components/schemas/AddressIdentifierVerboseDto' physicalPostalAddress: @@ -3969,27 +3592,15 @@ components: type: string description: The date when the data record has been last updated. format: date-time + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' isLegalAddress: type: boolean description: Indicates if the address is the legal address to a legal entity. isMainAddress: type: boolean - description: >- - Indicates if the address is the main address to a site. This is - where typically the main entrance or the reception is located, or - where the mail is delivered to. - description: >- - In general, an address is a collection of information to describe a - physical location, using a street name with a house number and/or a post - office box as reference. In addition, an address consists of several - postal attributes, such as country, region (state), county, township, - city, district, or postal code, which help deliver mail.In Catena-X, an - address is a type of business partner representing the legal address of - a legal entity, and/or the main address of a site, or any additional - address of a legal entity or site (such as different gates).An address - is owned by a legal entity. Thus, exactly one legal entity is assigned - to an address. An address can belong to a site. Thus, one or no site is - assigned to an address. An address is uniquely identified by the BPNA. + description: Indicates if the address is the main address to a site. This is where typically the main entrance or the reception is located, or where the mail is delivered to. + description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. MainAddressResponse: type: object properties: @@ -4231,7 +3842,7 @@ components: items: $ref: '#/components/schemas/SiteMatchVerboseDto' description: Paginated collection of results - PageDtoSitePoolVerboseDto: + PageDtoSiteVerboseDto: type: object properties: totalElements: @@ -4254,9 +3865,9 @@ components: type: array description: Collection of results in the page items: - $ref: '#/components/schemas/SitePoolVerboseDto' + $ref: '#/components/schemas/SiteVerboseDto' description: Paginated collection of results - PageDtoSiteVerboseDto: + PageDtoSiteWithMainAddressVerboseDto: type: object properties: totalElements: @@ -4279,7 +3890,7 @@ components: type: array description: Collection of results in the page items: - $ref: '#/components/schemas/SiteVerboseDto' + $ref: '#/components/schemas/SiteWithMainAddressVerboseDto' description: Paginated collection of results PhysicalPostalAddressDto: type: object @@ -4288,9 +3899,7 @@ components: $ref: '#/components/schemas/GeoCoordinateDto' country: type: string - description: >- - The 2-digit country code of the physical postal address according to - ISO 3166-1. + description: The 2-digit country code of the physical postal address according to ISO 3166-1. enum: - UNDEFINED - AC @@ -4566,199 +4175,82 @@ components: - ZW administrativeAreaLevel1: type: string - description: >- - The 2-digit country subdivision code according to ISO 3166-2, such - as a region within a country. + description: The 2-digit country subdivision code according to ISO 3166-2, such as a region within a country. administrativeAreaLevel2: type: string - description: >- - The name of the locally regulated secondary country subdivision of - the physical postal address, such as county within a country. + description: The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country. administrativeAreaLevel3: type: string - description: >- - The name of the locally regulated tertiary country subdivision of - the physical address, such as townships within a country. + description: The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country. postalCode: type: string - description: >- - The alphanumeric identifier (sometimes including spaces or - punctuation) of the physical postal address for the purpose of - sorting mail, synonyms:postcode, post code, PIN or ZIP code. + description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. city: type: string - description: >- - The name of the city of the physical postal address, synonyms: town, - village, municipality. + description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' district: type: string - description: >- - The name of the district of the physical postal address which - divides the city in several smaller areas. + description: The name of the district of the physical postal address which divides the city in several smaller areas. street: $ref: '#/components/schemas/StreetDto' companyPostalCode: type: string - description: >- - The company postal code of the physical postal address, which is - sometimes required for large companies. + description: The company postal code of the physical postal address, which is sometimes required for large companies. industrialZone: type: string - description: >- - The industrial zone of the physical postal address, designating an - area for industrial development, synonym: industrial area. + description: 'The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.' building: type: string - description: >- - The alphanumeric identifier of the building addressed by the - physical postal address. + description: The alphanumeric identifier of the building addressed by the physical postal address. floor: type: string - description: >- - The number of a floor in the building addressed by the physical - postal address, synonym: level. + description: 'The number of a floor in the building addressed by the physical postal address, synonym: level.' door: type: string - description: >- - The number of a door in the building on the respective floor - addressed by the physical postal address, synonyms: room, suite. - description: >- - A physical postal address describes the physical location of an office, - warehouse, gate, etc. + description: 'The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.' + description: A physical postal address describes the physical location of an office, warehouse, gate, etc. PhysicalPostalAddressVerboseDto: type: object properties: geographicCoordinates: $ref: '#/components/schemas/GeoCoordinateDto' - country: - $ref: '#/components/schemas/TypeKeyNameVerboseDtoCountryCode' - administrativeAreaLevel1: - $ref: '#/components/schemas/RegionDto' administrativeAreaLevel2: type: string - description: >- - The name of the locally regulated secondary country subdivision of - the physical postal address, such as county within a country. + description: The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country. administrativeAreaLevel3: type: string - description: >- - The name of the locally regulated tertiary country subdivision of - the physical address, such as townships within a country. + description: The name of the locally regulated tertiary country subdivision of the physical address, such as townships within a country. postalCode: type: string - description: >- - The alphanumeric identifier (sometimes including spaces or - punctuation) of the physical postal address for the purpose of - sorting mail, synonyms:postcode, post code, PIN or ZIP code. + description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. city: type: string - description: >- - The name of the city of the physical postal address, synonyms: town, - village, municipality. + description: 'The name of the city of the physical postal address, synonyms: town, village, municipality.' district: type: string - description: >- - The name of the district of the physical postal address which - divides the city in several smaller areas. + description: The name of the district of the physical postal address which divides the city in several smaller areas. street: $ref: '#/components/schemas/StreetDto' companyPostalCode: type: string - description: >- - The company postal code of the physical postal address, which is - sometimes required for large companies. + description: The company postal code of the physical postal address, which is sometimes required for large companies. industrialZone: type: string - description: >- - The industrial zone of the physical postal address, designating an - area for industrial development, synonym: industrial area. + description: 'The industrial zone of the physical postal address, designating an area for industrial development, synonym: industrial area.' building: type: string - description: >- - The alphanumeric identifier of the building addressed by the - physical postal address. + description: The alphanumeric identifier of the building addressed by the physical postal address. floor: type: string - description: >- - The number of a floor in the building addressed by the physical - postal address, synonym: level. + description: 'The number of a floor in the building addressed by the physical postal address, synonym: level.' door: type: string - description: >- - The number of a door in the building on the respective floor - addressed by the physical postal address, synonyms: room, suite. - description: >- - A physical postal address describes the physical location of an office, - warehouse, gate, etc. - PoolLegalEntityVerboseDto: - type: object - properties: - legalName: - type: string - description: The name of the legal entity according to official registers. - bpnl: - type: string - description: >- - A BPNL represents and uniquely identifies a legal entity, which is - defined by its legal name (including legal form, if registered), - legal address and tax number. - identifiers: - type: array - description: The list of identifiers of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityIdentifierVerboseDto' - legalShortName: - type: string - description: The abbreviated name of the legal entity. - legalForm: - $ref: '#/components/schemas/LegalFormDto' - states: - type: array - description: The list of (temporary) states of the legal entity. - items: - $ref: '#/components/schemas/LegalEntityStateVerboseDto' - classifications: - type: array - description: >- - The list of classifications of the legal entity, such as a specific - industry. - items: - $ref: '#/components/schemas/ClassificationVerboseDto' - relations: - type: array - description: Relations to other business partners. - items: - $ref: '#/components/schemas/RelationVerboseDto' - currentness: - type: string - description: >- - The date the business partner data was last indicated to be still - current. - format: date-time - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - legalAddress: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: >- - In general, a legal entity is a juridical person that has legal rights - and duties related to contracts, agreements, and obligations. The term - especially applies to any kind of organization (such as an enterprise or - company, university, association, etc.) established under the law - applicable to a country.In Catena-X, a legal entity is a type of - business partner representing a legally registered organization with its - official registration information, such as legal name (including legal - form, if registered), legal address and tax number.A legal entity has - exactly one legal address, but it is possible to specify additional - addresses that a legal entity owns. Thus, at least one address is - assigned to a legal entity. A legal entity can own sites. Thus, many or - no sites are assigned to a legal entity. A legal entity is uniquely - identified by the BPNL. + description: 'The number of a door in the building on the respective floor addressed by the physical postal address, synonyms: room, suite.' + country: + $ref: '#/components/schemas/TypeKeyNameVerboseDtoCountryCode' + administrativeAreaLevel1: + $ref: '#/components/schemas/RegionDto' + description: A physical postal address describes the physical location of an office, warehouse, gate, etc. RegionDto: type: object properties: @@ -5043,9 +4535,7 @@ components: description: Abbreviation or shorthand of the area regionName: type: string - description: >- - Describes the full name of the region within a country according to - ISO 3166-214 + description: Describes the full name of the region within a country according to ISO 3166-214 description: Region within a country RelationVerboseDto: type: object @@ -5085,52 +4575,29 @@ components: $ref: '#/components/schemas/LogisticAddressVerboseDto' site: $ref: '#/components/schemas/SiteVerboseDto' - description: >- - Match for a business partner record of type site. In general, a site is - a delimited geographical area in which an organization (such as an - enterprise or company, university, association, etc.) conducts business. - In Catena-X, a site is a type of business partner representing a - physical location or area owned by a legal entity, where a production - plant, a warehouse, or an office building is located. A site is owned by - a legal entity. Thus, exactly one legal entity is assigned to a site. A - site has exactly one main address, but it is possible to specify - additional addresses (such as different gates), that belong to a site. - Thus, at least one address is assigned to a site. A site can only be - uploaded and modified by the owner (the legal entity), because only the - owner knows which addresses belong to which site. A site is uniquely - identified by the BPNS. + description: Match for a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SitePartnerCreateRequest: type: object properties: name: type: string - description: >- - The name of the site. This is not according to official registers - but according to the name the owner chooses. + description: The name of the site. This is not according to official registers but according to the name the owner chooses. states: type: array + description: The list of the (temporary) states of the site. items: $ref: '#/components/schemas/SiteStateDto' mainAddress: $ref: '#/components/schemas/LogisticAddressDto' + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' bpnlParent: type: string index: type: string - description: >- - Request for creating new business partner record of type site. In - general, a site is a delimited geographical area in which an - organization (such as an enterprise or company, university, association, - etc.) conducts business. In Catena-X, a site is a type of business - partner representing a physical location or area owned by a legal - entity, where a production plant, a warehouse, or an office building is - located. A site is owned by a legal entity. Thus, exactly one legal - entity is assigned to a site. A site has exactly one main address, but - it is possible to specify additional addresses (such as different - gates), that belong to a site. Thus, at least one address is assigned to - a site. A site can only be uploaded and modified by the owner (the legal - entity), because only the owner knows which addresses belong to which - site. A site is uniquely identified by the BPNS. + requestKey: + type: string + description: Request for creating new business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SitePartnerCreateResponseWrapper: type: object properties: @@ -5148,25 +4615,19 @@ components: entityCount: type: integer format: int32 - description: >- - Holds information about successfully and failed entities after the - creating/updating of several objects + description: Holds information about successfully and failed entities after the creating/updating of several objects SitePartnerCreateVerboseDto: type: object properties: bpns: type: string - description: >- - A BPNS represents and uniquely identifies a site, which is where for - example a production plant, a warehouse, or an office building is - located. + description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. name: type: string - description: >- - The name of the site. This is not according to official registers - but according to the name the owner chooses. + description: The name of the site. This is not according to official registers but according to the name the owner chooses. states: type: array + description: The list of the (temporary) states of the site. items: $ref: '#/components/schemas/SiteStateVerboseDto' bpnLegalEntity: @@ -5180,27 +4641,14 @@ components: type: string description: The date when the data record has been last updated. format: date-time + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' mainAddress: $ref: '#/components/schemas/LogisticAddressVerboseDto' index: type: string - description: >- - User defined index to conveniently match this entry to the - corresponding entry in the response. - description: >- - Created/updated business partner of type site. In general, a site is a - delimited geographical area in which an organization (such as an - enterprise or company, university, association, etc.) conducts business. - In Catena-X, a site is a type of business partner representing a - physical location or area owned by a legal entity, where a production - plant, a warehouse, or an office building is located. A site is owned by - a legal entity. Thus, exactly one legal entity is assigned to a site. A - site has exactly one main address, but it is possible to specify - additional addresses (such as different gates), that belong to a site. - Thus, at least one address is assigned to a site. A site can only be - uploaded and modified by the owner (the legal entity), because only the - owner knows which addresses belong to which site. A site is uniquely - identified by the BPNS. + description: User defined index to conveniently match this entry to the corresponding entry in the response. + description: Created/updated business partner of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SitePartnerUpdateRequest: type: object properties: @@ -5208,29 +4656,19 @@ components: type: string name: type: string - description: >- - The name of the site. This is not according to official registers - but according to the name the owner chooses. + description: The name of the site. This is not according to official registers but according to the name the owner chooses. states: type: array + description: The list of the (temporary) states of the site. items: $ref: '#/components/schemas/SiteStateDto' mainAddress: $ref: '#/components/schemas/LogisticAddressDto' - description: >- - Request for updating a business partner record of type site. In general, - a site is a delimited geographical area in which an organization (such - as an enterprise or company, university, association, etc.) conducts - business. In Catena-X, a site is a type of business partner representing - a physical location or area owned by a legal entity, where a production - plant, a warehouse, or an office building is located. A site is owned by - a legal entity. Thus, exactly one legal entity is assigned to a site. A - site has exactly one main address, but it is possible to specify - additional addresses (such as different gates), that belong to a site. - Thus, at least one address is assigned to a site. A site can only be - uploaded and modified by the owner (the legal entity), because only the - owner knows which addresses belong to which site. A site is uniquely - identified by the BPNS. + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + requestKey: + type: string + description: Request for updating a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SitePartnerUpdateResponseWrapper: type: object properties: @@ -5248,61 +4686,10 @@ components: entityCount: type: integer format: int32 - description: >- - Holds information about successfully and failed entities after the - creating/updating of several objects - SitePoolVerboseDto: - type: object - properties: - bpns: - type: string - description: >- - A BPNS represents and uniquely identifies a site, which is where for - example a production plant, a warehouse, or an office building is - located. - name: - type: string - description: >- - The name of the site. This is not according to official registers - but according to the name the owner chooses. - states: - type: array - items: - $ref: '#/components/schemas/SiteStateVerboseDto' - bpnLegalEntity: - type: string - description: The BPNL of the legal entity owning the site. - createdAt: - type: string - description: The date when the data record has been created. - format: date-time - updatedAt: - type: string - description: The date when the data record has been last updated. - format: date-time - mainAddress: - $ref: '#/components/schemas/LogisticAddressVerboseDto' - description: >- - In general, a site is a delimited geographical area in which an - organization (such as an enterprise or company, university, association, - etc.) conducts business. In Catena-X, a site is a type of business - partner representing a physical location or area owned by a legal - entity, where a production plant, a warehouse, or an office building is - located. A site is owned by a legal entity. Thus, exactly one legal - entity is assigned to a site. A site has exactly one main address, but - it is possible to specify additional addresses (such as different - gates), that belong to a site. Thus, at least one address is assigned to - a site. A site can only be uploaded and modified by the owner (the legal - entity), because only the owner knows which addresses belong to which - site. A site is uniquely identified by the BPNS. + description: Holds information about successfully and failed entities after the creating/updating of several objects SiteStateDto: type: object properties: - description: - type: string - description: >- - The description from the original source indicating the state of the - site. validFrom: type: string description: The date from which the state is valid. @@ -5317,19 +4704,10 @@ components: enum: - ACTIVE - INACTIVE - description: >- - A site state indicates if the site is active or inactive. This does not - describe the relation between a sharing member and a business partner - and whether they have active business, but it describes whether the site - is still operating. + description: A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating. SiteStateVerboseDto: type: object properties: - description: - type: string - description: >- - The description from the original source indicating the state of the - site. validFrom: type: string description: The date from which the state is valid. @@ -5340,27 +4718,19 @@ components: format: date-time type: $ref: '#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType' - description: >- - A site state indicates if the site is active or inactive. This does not - describe the relation between a sharing member and a business partner - and whether they have active business, but it describes whether the site - is still operating. + description: A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating. SiteVerboseDto: type: object properties: bpns: type: string - description: >- - A BPNS represents and uniquely identifies a site, which is where for - example a production plant, a warehouse, or an office building is - located. + description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. name: type: string - description: >- - The name of the site. This is not according to official registers - but according to the name the owner chooses. + description: The name of the site. This is not according to official registers but according to the name the owner chooses. states: type: array + description: The list of the (temporary) states of the site. items: $ref: '#/components/schemas/SiteStateVerboseDto' bpnLegalEntity: @@ -5374,19 +4744,39 @@ components: type: string description: The date when the data record has been last updated. format: date-time - description: >- - In general, a site is a delimited geographical area in which an - organization (such as an enterprise or company, university, association, - etc.) conducts business. In Catena-X, a site is a type of business - partner representing a physical location or area owned by a legal - entity, where a production plant, a warehouse, or an office building is - located. A site is owned by a legal entity. Thus, exactly one legal - entity is assigned to a site. A site has exactly one main address, but - it is possible to specify additional addresses (such as different - gates), that belong to a site. Thus, at least one address is assigned to - a site. A site can only be uploaded and modified by the owner (the legal - entity), because only the owner knows which addresses belong to which - site. A site is uniquely identified by the BPNS. + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + description: In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. + SiteWithMainAddressVerboseDto: + type: object + properties: + bpns: + type: string + description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. + name: + type: string + description: The name of the site. This is not according to official registers but according to the name the owner chooses. + states: + type: array + description: The list of the (temporary) states of the site. + items: + $ref: '#/components/schemas/SiteStateVerboseDto' + bpnLegalEntity: + type: string + description: The BPNL of the legal entity owning the site. + createdAt: + type: string + description: The date when the data record has been created. + format: date-time + updatedAt: + type: string + description: The date when the data record has been last updated. + format: date-time + confidenceCriteria: + $ref: '#/components/schemas/ConfidenceCriteriaDto' + mainAddress: + $ref: '#/components/schemas/LogisticAddressVerboseDto' + description: In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. StreetDto: type: object properties: @@ -5395,52 +4785,28 @@ components: description: The name of the street. houseNumber: type: string - description: >- - The number representing the exact location of a building within the - street. + description: The number representing the exact location of a building within the street. + houseNumberSupplement: + type: string milestone: type: string - description: >- - The number representing the exact location of an addressed object - within a street without house numbers, such as within long roads. + description: The number representing the exact location of an addressed object within a street without house numbers, such as within long roads. direction: type: string - description: >- - The cardinal direction describing where the exit to the location of - the addressed object on large highways / motorways is located, such - as Highway 101 South. - description: >- - The street of the physical postal address, synonyms: road, avenue, lane, - boulevard, highway - SyncDto: - type: object - properties: - type: - type: string - enum: - - OPENSEARCH - - SAAS_IMPORT - status: + description: The cardinal direction describing where the exit to the location of the addressed object on large highways / motorways is located, such as Highway 101 South. + namePrefix: type: string - enum: - - NOT_SYNCED - - RUNNING - - SUCCESS - - ERROR - count: - type: integer - format: int32 - progress: - type: number - format: float - errorDetails: + description: The street related information, which is usually printed before the official street name on an address label. + additionalNamePrefix: type: string - startedAt: + description: The additional street related information, which is usually printed before the official street name on an address label. + nameSuffix: type: string - format: date-time - finishedAt: + description: The street related information, which is usually printed after the official street name on an address label. + additionalNameSuffix: type: string - format: date-time + description: The additional street related information, which is usually printed after the official street name on an address label. + description: 'The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway' TypeKeyNameVerboseDtoBusinessStateType: type: object properties: