openapi: 3.1.0 info: title: Business Partner Data Management Pool description: Service that manages and shares business partner data with other CatenaX services version: 7.4.0-SNAPSHOT servers: - url: http://localhost:8080 description: Generated server url security: - open_id_scheme: [] - bearer_scheme: [] tags: - name: Changelog Controller description: Read change events of business partner data - name: Legal Entity Controller description: "Read, create and update business partner of type legal entity" - name: Metadata Controller description: Read and create supporting data that is referencable in business partner data - name: Site Controller description: "Read, create and update business partner of type site" - name: Business Partners Controller description: Look-up business partner - name: Bpn Controller description: Support functionality for BPN operations - name: Address Controller description: "Read, create and update business partner of type address" paths: /v7/sites: get: tags: - Site Controller summary: Get page of sites matching the pagination search criteria description: This endpoint retrieves all existing business partners of type sites. operationId: getSites parameters: - name: siteBpns in: query required: false schema: type: array items: type: string - name: legalEntityBpns in: query required: false schema: type: array items: type: string - name: name in: query required: false schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of business partners matching the search criteria, may\ \ be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoSiteWithMainAddressVerboseDto" "400": description: On malformed pagination request put: 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." operationId: updateSite requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/SitePartnerUpdateRequest" required: true responses: "200": description: "Update sites request was processed successfully, possible\ \ errors are returned" content: application/json: schema: $ref: "#/components/schemas/SitePartnerUpdateResponseWrapper" "400": description: On malformed requests post: 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." operationId: createSite requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/SitePartnerCreateRequest" required: true responses: "200": description: "New sites request was processed successfully, possible errors\ \ are returned" content: application/json: schema: $ref: "#/components/schemas/SitePartnerCreateResponseWrapper" "400": description: On malformed requests /v7/legal-entities: get: 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. " operationId: getLegalEntities parameters: - name: bpnLs in: query required: false schema: type: array items: type: string - name: legalName in: query required: false schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of business partners matching the search criteria, may\ \ be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoLegalEntityWithLegalAddressVerboseDto" "400": description: On malformed search or pagination request put: 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." operationId: updateBusinessPartners requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/LegalEntityPartnerUpdateRequest" required: true responses: "200": description: "Update legal entities request was processed successfully,\ \ possible errors are returned" content: application/json: schema: $ref: "#/components/schemas/LegalEntityPartnerUpdateResponseWrapper" "400": description: On malformed requests post: 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." operationId: createBusinessPartners requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/LegalEntityPartnerCreateRequest" required: true responses: "200": description: "New legal entities request was processed successfully, possible\ \ errors are returned" content: application/json: schema: $ref: "#/components/schemas/LegalEntityPartnerCreateResponseWrapper" "400": description: On malformed requests /v7/data-space-participants: get: tags: - data-space-participants-controller operationId: get parameters: - name: bpnLs in: query required: false schema: type: array items: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoDataSpaceParticipantDto" put: tags: - data-space-participants-controller operationId: put requestBody: content: application/json: schema: $ref: "#/components/schemas/DataSpaceParticipantUpdateRequest" required: true responses: "200": description: OK /v7/addresses: get: 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. " operationId: getAddresses parameters: - name: addressBpns in: query required: false schema: type: array items: type: string - name: legalEntityBpns in: query required: false schema: type: array items: type: string - name: siteBpns in: query required: false schema: type: array items: type: string - name: name in: query required: false schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of addresses matching the search criteria, may be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoLogisticAddressVerboseDto" "400": description: On malformed search or pagination request put: 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." operationId: updateAddresses requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/AddressPartnerUpdateRequest" required: true responses: "200": description: "The successfully updated records, possible errors are returned" content: application/json: schema: $ref: "#/components/schemas/AddressPartnerUpdateResponseWrapper" "400": description: On malformed requests post: 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." operationId: createAddresses requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/AddressPartnerCreateRequest" required: true responses: "200": description: "New business partner record successfully created, possible\ \ errors are returned" content: application/json: schema: $ref: "#/components/schemas/AddressPartnerCreateResponseWrapper" "400": description: On malformed requests /v6/sites: get: tags: - Site Controller summary: Get page of sites matching the pagination search criteria description: This endpoint retrieves all existing business partners of type sites. operationId: getSites_1 parameters: - name: siteBpns in: query required: false schema: type: array items: type: string - name: legalEntityBpns in: query required: false schema: type: array items: type: string - name: name in: query required: false schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of business partners matching the search criteria, may\ \ be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoSiteWithMainAddressVerboseDto" "400": description: On malformed pagination request put: 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." operationId: updateSite_1 requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/SitePartnerUpdateRequest" required: true responses: "200": description: "Update sites request was processed successfully, possible\ \ errors are returned" content: application/json: schema: $ref: "#/components/schemas/SitePartnerUpdateResponseWrapper" "400": description: On malformed requests post: 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." operationId: createSite_1 requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/SitePartnerCreateRequest" required: true responses: "200": description: "New sites request was processed successfully, possible errors\ \ are returned" content: application/json: schema: $ref: "#/components/schemas/SitePartnerCreateResponseWrapper" "400": description: On malformed requests /v6/legal-entities: get: 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. " operationId: getLegalEntities_1 parameters: - name: bpnLs in: query required: false schema: type: array items: type: string - name: legalName in: query required: false schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of business partners matching the search criteria, may\ \ be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoLegalEntityWithLegalAddressVerboseDto" "400": description: On malformed search or pagination request put: 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." operationId: updateBusinessPartners_1 requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/LegalEntityPartnerUpdateRequest" required: true responses: "200": description: "Update legal entities request was processed successfully,\ \ possible errors are returned" content: application/json: schema: $ref: "#/components/schemas/LegalEntityPartnerUpdateResponseWrapper" "400": description: On malformed requests post: 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." operationId: createBusinessPartners_1 requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/LegalEntityPartnerCreateRequest" required: true responses: "200": description: "New legal entities request was processed successfully, possible\ \ errors are returned" content: application/json: schema: $ref: "#/components/schemas/LegalEntityPartnerCreateResponseWrapper" "400": description: On malformed requests /v6/cx-memberships: get: tags: - cx-membership-controller operationId: get_1 parameters: - name: bpnLs in: query required: false schema: type: array items: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoCxMembershipDto" put: tags: - cx-membership-controller operationId: put_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/CxMembershipUpdateRequest" required: true responses: "200": description: OK /v6/addresses: get: 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. " operationId: getAddresses_1 parameters: - name: addressBpns in: query required: false schema: type: array items: type: string - name: legalEntityBpns in: query required: false schema: type: array items: type: string - name: siteBpns in: query required: false schema: type: array items: type: string - name: name in: query required: false schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of addresses matching the search criteria, may be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoLogisticAddressVerboseDto" "400": description: On malformed search or pagination request put: 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." operationId: updateAddresses_1 requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/AddressPartnerUpdateRequest" required: true responses: "200": description: "The successfully updated records, possible errors are returned" content: application/json: schema: $ref: "#/components/schemas/AddressPartnerUpdateResponseWrapper" "400": description: On malformed requests post: 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." operationId: createAddresses_1 requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/AddressPartnerCreateRequest" required: true responses: "200": description: "New business partner record successfully created, possible\ \ errors are returned" content: application/json: schema: $ref: "#/components/schemas/AddressPartnerCreateResponseWrapper" "400": description: On malformed requests /v7/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 operationId: postSiteSearch parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/SiteSearchRequest" required: true responses: "200": description: Found sites that belong to specified legal entites content: application/json: schema: $ref: "#/components/schemas/PageDtoSiteWithMainAddressVerboseDto" "400": description: On malformed request parameters /v7/sites/legal-main-sites: post: tags: - Site Controller summary: Create a new site with legal entity reference description: Create a business partner site with the given legal entity reference. It will designate the address information as both legal and site main address. operationId: createSiteWithLegalReference requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/SiteCreateRequestWithLegalAddressAsMain" required: true responses: "200": description: "New sites request was processed successfully, possible errors\ \ are returned" content: application/json: schema: $ref: "#/components/schemas/SitePartnerCreateResponseWrapper" "400": description: On malformed pagination request /v7/participants/sites/search: post: tags: - Site Controller operationId: postSiteSearch_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/SiteSearchRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoSiteWithMainAddressVerboseDto" /v7/participants/legal-entities/search: post: tags: - Legal Entity Controller operationId: searchLegalEntities parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/LegalEntitySearchRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoLegalEntityWithLegalAddressVerboseDto" /v7/participants/changelog/search: post: tags: - Changelog Controller operationId: searchChangelogEntries parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/ChangelogSearchRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoChangelogEntryVerboseDto" /v7/participants/addresses/search: post: tags: - Address Controller operationId: searchAddresses parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/AddressSearchRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoLogisticAddressInvariantVerboseDto" /v7/legal-forms: get: tags: - Metadata Controller summary: Returns all legal forms description: Lists all currently known legal forms in a paginated result operationId: getLegalForms parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of existing legal forms, may be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoLegalFormDto" "400": description: On malformed request parameters post: 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." operationId: createLegalForm requestBody: content: application/json: schema: $ref: "#/components/schemas/LegalFormRequest" required: true responses: "200": description: New legal form successfully created content: application/json: schema: $ref: "#/components/schemas/LegalFormDto" "400": description: On malformed request parameters "409": description: Legal form with specified technical key already exists /v7/legal-entities/search: post: tags: - Legal Entity Controller summary: Returns legal entities by different search parameters 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: postLegalEntitySearch parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/LegalEntitySearchRequest" required: true responses: "200": description: Found legal entites content: application/json: schema: $ref: "#/components/schemas/PageDtoLegalEntityWithLegalAddressVerboseDto" "400": description: On malformed request parameters or if number of requested bpns exceeds limit /v7/identifier-types: 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 operationId: getIdentifierTypes parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 - name: businessPartnerType in: query 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. enum: - LEGAL_ENTITY - ADDRESS - name: country in: query required: false schema: type: string enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW responses: "200": description: "Page of existing identifier types, may be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoIdentifierTypeDto" "400": description: On malformed request parameters post: 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." operationId: createIdentifierType requestBody: content: application/json: schema: $ref: "#/components/schemas/IdentifierTypeDto" required: true responses: "200": description: New identifier type successfully created content: application/json: schema: $ref: "#/components/schemas/IdentifierTypeDto" "400": description: On malformed request parameters "409": description: Identifier type with specified technical key already exists /v7/business-partners/search: post: tags: - Business Partners Controller summary: Return business partners look-up result description: Look-up the business partner data by parameters operationId: searchBusinessPartners parameters: - name: searchResultFilter in: query required: false schema: type: array items: type: string enum: - IncludeLegalEntities - IncludeSites - IncludeAdditionalAddresses uniqueItems: true - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/LegalEntityPropertiesSearchRequest" required: true responses: "200": description: Matching business partners content: application/json: schema: $ref: "#/components/schemas/PageDtoBusinessPartnerSearchResultDto" "400": description: "Invalid request (e.g., missing both ID and legalName)" content: application/json: schema: $ref: "#/components/schemas/PageDtoBusinessPartnerSearchResultDto" /v7/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. operationId: searchAddresses_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/AddressSearchRequest" required: true responses: "200": description: Found sites for the specified sites and legal entities content: application/json: schema: $ref: "#/components/schemas/PageDtoLogisticAddressVerboseDto" "400": description: On malformed pagination request /v6/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 operationId: postSiteSearch_2 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/SiteSearchRequest" required: true responses: "200": description: Found sites that belong to specified legal entites content: application/json: schema: $ref: "#/components/schemas/PageDtoSiteWithMainAddressVerboseDto" "400": description: On malformed request parameters /v6/sites/legal-main-sites: post: tags: - Site Controller summary: Create a new site with legal entity reference description: Create a business partner site with the given legal entity reference. It will designate the address information as both legal and site main address. operationId: createSiteWithLegalReference_1 requestBody: content: application/json: schema: type: array items: $ref: "#/components/schemas/SiteCreateRequestWithLegalAddressAsMain" required: true responses: "200": description: "New sites request was processed successfully, possible errors\ \ are returned" content: application/json: schema: $ref: "#/components/schemas/SitePartnerCreateResponseWrapper" "400": description: On malformed pagination request /v6/members/sites/search: post: tags: - Site Controller operationId: postSiteSearch_3 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/SiteSearchRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoSiteWithMainAddressVerboseDto" /v6/members/legal-entities/search: post: tags: - Legal Entity Controller operationId: searchLegalEntities_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/LegalEntitySearchRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoLegalEntityWithLegalAddressVerboseDto" /v6/members/changelog/search: post: tags: - Changelog Controller operationId: searchChangelogEntries_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/ChangelogSearchRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoChangelogEntryVerboseDto" /v6/members/addresses/search: post: tags: - Address Controller operationId: searchAddresses_2 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/AddressSearchRequest" required: true responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoLogisticAddressVerboseDto" /v6/legal-forms: get: tags: - Metadata Controller summary: Returns all legal forms description: Lists all currently known legal forms in a paginated result operationId: getLegalForms_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of existing legal forms, may be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoLegalFormDto" "400": description: On malformed request parameters post: 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." operationId: createLegalForm_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/LegalFormRequest" required: true responses: "200": description: New legal form successfully created content: application/json: schema: $ref: "#/components/schemas/LegalFormDto" "400": description: On malformed request parameters "409": description: Legal form with specified technical key already exists /v6/legal-entities/search: post: tags: - Legal Entity Controller summary: Returns legal entities by different search parameters 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: postLegalEntitySearch_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/LegalEntitySearchRequest" required: true responses: "200": description: Found legal entites content: application/json: schema: $ref: "#/components/schemas/PageDtoLegalEntityWithLegalAddressVerboseDto" "400": description: On malformed request parameters or if number of requested bpns exceeds limit /v6/identifier-types: 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 operationId: getIdentifierTypes_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 - name: businessPartnerType in: query 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. enum: - LEGAL_ENTITY - ADDRESS - name: country in: query required: false schema: type: string enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW responses: "200": description: "Page of existing identifier types, may be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoIdentifierTypeDto" "400": description: On malformed request parameters post: 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." operationId: createIdentifierType_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/IdentifierTypeDto" required: true responses: "200": description: New identifier type successfully created content: application/json: schema: $ref: "#/components/schemas/IdentifierTypeDto" "400": description: On malformed request parameters "409": description: Identifier type with specified technical key already exists /v7/business-partners/changelog/search: 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" operationId: getChangelogEntries parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/ChangelogSearchRequest" required: true responses: "200": description: The specified changelog entries content: application/json: schema: $ref: "#/components/schemas/PageDtoChangelogEntryVerboseDto" "400": description: On malformed pagination request "404": description: No business partner found for specified bpn /v6/business-partners/changelog/search: 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" operationId: getChangelogEntries_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/ChangelogSearchRequest" required: true responses: "200": description: The specified changelog entries content: application/json: schema: $ref: "#/components/schemas/PageDtoChangelogEntryVerboseDto" "400": description: On malformed pagination request "404": description: No business partner found for specified bpn /v7/bpn/search: 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." operationId: findBpnsByIdentifiers requestBody: content: application/json: schema: $ref: "#/components/schemas/IdentifiersSearchRequest" required: true responses: "200": description: Found bpn to identifier value mappings content: application/json: schema: type: array items: $ref: "#/components/schemas/BpnIdentifierMappingDto" uniqueItems: true "400": description: On malformed request parameters or if number of requested bpns exceeds limit "404": description: Specified identifier type not found /v6/bpn/search: 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." operationId: findBpnsByIdentifiers_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/IdentifiersSearchRequest" required: true responses: "200": description: Found bpn to identifier value mappings content: application/json: schema: type: array items: $ref: "#/components/schemas/BpnIdentifierMappingDto" uniqueItems: true "400": description: On malformed request parameters or if number of requested bpns exceeds limit "404": description: Specified identifier type not found /v6/bpn/request-ids/search: post: tags: - Bpn Controller summary: Return BPNL/S/A based on the requested identifiers description: Find business partner numbers by requested-identifiers. operationId: findBpnByRequestedIdentifiers requestBody: content: application/json: schema: $ref: "#/components/schemas/BpnRequestIdentifierSearchRequest" required: true responses: "200": description: Found bpn to based on the requested identifiers content: application/json: schema: type: array items: $ref: "#/components/schemas/BpnRequestIdentifierMappingDto" uniqueItems: true /v7/bpn/request-ids/search: post: tags: - Bpn Controller summary: Return BPNL/S/A based on the requested identifiers description: Find business partner numbers by requested-identifiers. operationId: findBpnByRequestedIdentifiers_1 requestBody: content: application/json: schema: $ref: "#/components/schemas/BpnRequestIdentifierSearchRequest" required: true responses: "200": description: Found bpn to based on the requested identifiers content: application/json: schema: type: array items: $ref: "#/components/schemas/BpnRequestIdentifierMappingDto" uniqueItems: true /v6/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. operationId: searchAddresses_3 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 requestBody: content: application/json: schema: $ref: "#/components/schemas/AddressSearchRequest" required: true responses: "200": description: Found sites for the specified sites and legal entities content: application/json: schema: $ref: "#/components/schemas/PageDtoLogisticAddressVerboseDto" "400": description: On malformed pagination request /v7/sites/{bpns}: get: tags: - Site Controller summary: Returns a site by its BPNS description: Get business partners of type site by BPNS ignoring case. operationId: getSite parameters: - name: bpns in: path description: BPNS value required: true schema: type: string responses: "200": description: Found site with specified BPNS content: application/json: schema: $ref: "#/components/schemas/SiteWithMainAddressVerboseDto" "400": description: On malformed request parameters "404": description: No site found under specified BPNS /v7/script-codes: get: tags: - metadata-controller operationId: getScriptCodes parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/PageDtoScriptCodeDto" /v7/legal-entities/{idValue}: 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. operationId: getLegalEntity parameters: - name: idValue in: path description: Identifier value required: true schema: type: string - name: idType in: query description: "Type of identifier to use, defaults to BPN when omitted" required: false schema: type: string responses: "200": description: Found business partner with specified identifier content: application/json: schema: $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 /v7/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." operationId: getSites_2 parameters: - name: bpnl in: path description: BPNL value required: true schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: The sites for the specified bpnl content: application/json: schema: $ref: "#/components/schemas/PageDtoSiteVerboseDto" "400": description: On malformed pagination request "404": description: No business partner found for specified bpnl /v7/legal-entities/{bpnl}/addresses: get: 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." operationId: getAddresses_2 parameters: - name: bpnl in: path description: BPNL value required: true schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: The addresses for the specified BPNL content: application/json: schema: $ref: "#/components/schemas/PageDtoLogisticAddressVerboseDto" "400": description: On malformed pagination request "404": description: No business partner found for specified BPNL /v7/addresses/{bpna}: get: tags: - Address Controller summary: Returns an address by its BPNA description: Get business partners of type address by BPNA ignoring case. operationId: getAddress parameters: - name: bpna in: path description: BPNA value required: true schema: type: string responses: "200": description: Found address with specified BPNA content: application/json: schema: $ref: "#/components/schemas/LogisticAddressVerboseDto" "400": description: On malformed request parameters "404": description: No address found under specified BPNA /v6/sites/{bpns}: get: tags: - Site Controller summary: Returns a site by its BPNS description: Get business partners of type site by BPNS ignoring case. operationId: getSite_1 parameters: - name: bpns in: path description: BPNS value required: true schema: type: string responses: "200": description: Found site with specified BPNS content: application/json: schema: $ref: "#/components/schemas/SiteWithMainAddressVerboseDto" "400": description: On malformed request parameters "404": description: No site found under specified BPNS /v6/legal-entities/{idValue}: 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. operationId: getLegalEntity_1 parameters: - name: idValue in: path description: Identifier value required: true schema: type: string - name: idType in: query description: "Type of identifier to use, defaults to BPN when omitted" required: false schema: type: string responses: "200": description: Found business partner with specified identifier content: application/json: schema: $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 /v6/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." operationId: getSites_3 parameters: - name: bpnl in: path description: BPNL value required: true schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: The sites for the specified bpnl content: application/json: schema: $ref: "#/components/schemas/PageDtoSiteVerboseDto" "400": description: On malformed pagination request "404": description: No business partner found for specified bpnl /v6/legal-entities/{bpnl}/addresses: get: 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." operationId: getAddresses_3 parameters: - name: bpnl in: path description: BPNL value required: true schema: type: string - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: The addresses for the specified BPNL content: application/json: schema: $ref: "#/components/schemas/PageDtoLogisticAddressVerboseDto" "400": description: On malformed pagination request "404": description: No business partner found for specified BPNL /v6/field-quality-rules/: 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. operationId: getFieldQualityRules parameters: - name: country in: query description: ISO 3166-1 alpha-2 country code required: true schema: type: string enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW responses: "200": description: List of the existing rules for the given country content: application/json: schema: type: array items: $ref: "#/components/schemas/FieldQualityRuleDto" "400": description: On malformed request parameters /v7/field-quality-rules/: 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. operationId: getFieldQualityRules_1 parameters: - name: country in: query description: ISO 3166-1 alpha-2 country code required: true schema: type: string enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW responses: "200": description: List of the existing rules for the given country content: application/json: schema: type: array items: $ref: "#/components/schemas/FieldQualityRuleDto" "400": description: On malformed request parameters /v6/administrative-areas-level1: 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 operationId: getAdminAreasLevel1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of existing country subdivisions, may be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoCountrySubdivisionDto" "400": description: On malformed request parameters /v7/administrative-areas-level1: 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 operationId: getAdminAreasLevel1_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: type: string minimum: 0 - name: size in: query description: Size of each page required: false schema: type: string maximum: 100 minimum: 0 responses: "200": description: "Page of existing country subdivisions, may be empty" content: application/json: schema: $ref: "#/components/schemas/PageDtoCountrySubdivisionDto" "400": description: On malformed request parameters /v6/addresses/{bpna}: get: tags: - Address Controller summary: Returns an address by its BPNA description: Get business partners of type address by BPNA ignoring case. operationId: getAddress_1 parameters: - name: bpna in: path description: BPNA value required: true schema: type: string responses: "200": description: Found address with specified BPNA content: application/json: schema: $ref: "#/components/schemas/LogisticAddressVerboseDto" "400": description: On malformed request parameters "404": description: No address found under specified BPNA components: schemas: AddressIdentifierDto: type: object description: "An address identifier (uniquely) identifies the address, such\ \ as the Global Location Number (GLN)." properties: value: type: string description: The value of the identifier like "0847976000005". type: type: string description: The type of the identifier. AddressIdentifierVerboseDto: type: object description: "An address identifier (uniquely) identifies the address, such\ \ as the Global Location Number (GLN)." properties: value: type: string description: The value of the identifier like "0847976000005". type: $ref: "#/components/schemas/TypeKeyNameVerboseDtoString" description: The type of the identifier. AddressPartnerCreateRequest: type: object 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." 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. states: type: array description: The list of (temporary) states of the address. items: $ref: "#/components/schemas/AddressStateDto" identifiers: type: array description: The list of identifiers of the address. items: $ref: "#/components/schemas/AddressIdentifierDto" physicalPostalAddress: $ref: "#/components/schemas/PhysicalPostalAddressDto" description: "The physical postal address of the address, such as an office,\ \ warehouse, gate, etc." alternativePostalAddress: $ref: "#/components/schemas/AlternativePostalAddressDto" description: "The alternative postal address of the address, for example\ \ if the goods are to be picked up somewhere else." confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" scriptVariants: type: array items: $ref: "#/components/schemas/LogisticAddressScriptVariantDto" bpnParent: type: string index: type: string requestKey: type: string AddressPartnerCreateResponseWrapper: type: object description: Holds information about successfully and failed entities after the creating/updating of several objects properties: entities: type: array items: $ref: "#/components/schemas/AddressPartnerCreateVerboseDto" errors: type: array items: $ref: "#/components/schemas/ErrorInfoAddressCreateError" entityCount: type: integer format: int32 errorCount: type: integer format: int32 AddressPartnerCreateVerboseDto: type: object 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." 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." 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. 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: $ref: "#/components/schemas/PhysicalPostalAddressVerboseDto" description: "The physical postal address of the address, such as an office,\ \ warehouse, gate, etc." alternativePostalAddress: $ref: "#/components/schemas/AlternativePostalAddressVerboseDto" description: "The alternative postal address of the address, for example\ \ if the goods are to be picked up somewhere else." bpnLegalEntity: type: string description: The BPNL of the legal entity owning the address. bpnSite: type: string description: The BPNS of the site the address belongs to. createdAt: type: string format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" addressType: type: string description: "Indicates the address type, the legal address to a legal entity\ \ or the main address to a site, an additional address, or both legal\ \ and site address.The site main address is where typically the main entrance\ \ or the reception is located, or where the mail is delivered to." enum: - LegalAndSiteMainAddress - LegalAddress - SiteMainAddress - AdditionalAddress isParticipantData: type: boolean description: Indicates whether the address is owned and thus provided by a Data Space Participant. scriptVariants: type: array items: $ref: "#/components/schemas/LogisticAddressScriptVariantDto" index: type: string AddressPartnerUpdateRequest: type: object 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." properties: bpna: 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. states: type: array description: The list of (temporary) states of the address. items: $ref: "#/components/schemas/AddressStateDto" identifiers: type: array description: The list of identifiers of the address. items: $ref: "#/components/schemas/AddressIdentifierDto" physicalPostalAddress: $ref: "#/components/schemas/PhysicalPostalAddressDto" description: "The physical postal address of the address, such as an office,\ \ warehouse, gate, etc." alternativePostalAddress: $ref: "#/components/schemas/AlternativePostalAddressDto" description: "The alternative postal address of the address, for example\ \ if the goods are to be picked up somewhere else." confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" scriptVariants: type: array items: $ref: "#/components/schemas/LogisticAddressScriptVariantDto" requestKey: type: string AddressPartnerUpdateResponseWrapper: type: object description: Holds information about successfully and failed entities after the creating/updating of several objects properties: entities: type: array items: $ref: "#/components/schemas/AddressPartnerUpdateVerboseDto" errors: type: array items: $ref: "#/components/schemas/ErrorInfoAddressUpdateError" entityCount: type: integer format: int32 errorCount: type: integer format: int32 AddressPartnerUpdateVerboseDto: 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." 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. 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: $ref: "#/components/schemas/PhysicalPostalAddressVerboseDto" description: "The physical postal address of the address, such as an office,\ \ warehouse, gate, etc." alternativePostalAddress: $ref: "#/components/schemas/AlternativePostalAddressVerboseDto" description: "The alternative postal address of the address, for example\ \ if the goods are to be picked up somewhere else." bpnLegalEntity: type: string description: The BPNL of the legal entity owning the address. bpnSite: type: string description: The BPNS of the site the address belongs to. createdAt: type: string format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" addressType: type: string description: "Indicates the address type, the legal address to a legal entity\ \ or the main address to a site, an additional address, or both legal\ \ and site address.The site main address is where typically the main entrance\ \ or the reception is located, or where the mail is delivered to." enum: - LegalAndSiteMainAddress - LegalAddress - SiteMainAddress - AdditionalAddress isParticipantData: type: boolean description: Indicates whether the address is owned and thus provided by a Data Space Participant. scriptVariants: type: array items: $ref: "#/components/schemas/LogisticAddressScriptVariantDto" AddressSearchRequest: type: object properties: addressBpns: type: array items: type: string legalEntityBpns: type: array items: type: string siteBpns: type: array items: type: string name: type: string AddressStateDto: type: object 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." properties: validFrom: type: string format: date-time description: The date from which the state is valid. validTo: type: string format: date-time description: The date until the state is valid. type: type: string description: "One of the state types: active, inactive." enum: - ACTIVE - INACTIVE AddressStateVerboseDto: type: object 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." properties: validFrom: type: string format: date-time description: The date from which the state is valid. validTo: type: string format: date-time description: The date until the state is valid. type: $ref: "#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType" description: "One of the state types: active, inactive." AlternativeAddressScriptVariantDto: type: object properties: postalCode: type: string city: type: string deliveryServiceQualifier: type: string deliveryServiceNumber: type: string AlternativePostalAddressDto: type: object description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. 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. enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW administrativeAreaLevel1: type: string 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." city: type: string 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." 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." 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." required: - city - country - deliveryServiceNumber - deliveryServiceType AlternativePostalAddressVerboseDto: type: object description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. properties: geographicCoordinates: $ref: "#/components/schemas/GeoCoordinateDto" 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." city: type: string 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." 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." 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" description: The 2-digit country code of the physical postal address according to ISO 3166-1. administrativeAreaLevel1: $ref: "#/components/schemas/RegionDto" description: "The 2-digit country subdivision code according to ISO 3166-2,\ \ such as a region within a country." BpnIdentifierMappingDto: type: object description: Mapping of Business Partner Number to identifier value properties: idValue: type: string bpn: type: string BpnRequestIdentifierMappingDto: type: object description: Mapping of Business Partner Number to requested-identifier value properties: requestedIdentifier: type: string bpn: type: string BpnRequestIdentifierSearchRequest: type: object description: Mapping of Business Partner Number to requested-identifier value properties: requestedIdentifiers: type: array items: type: string uniqueItems: true BusinessPartnerConfidenceCriteriaDto: type: object properties: sharedByOwner: type: boolean checkedByExternalDataSource: type: boolean numberOfSharingMembers: type: integer format: int32 lastConfidenceCheckAt: type: string format: date-time nextConfidenceCheckAt: type: string format: date-time confidenceLevel: type: integer format: int32 BusinessPartnerIdentifierDto: type: object properties: type: type: string description: The type of the identifier. value: type: string description: The value of the identifier like “DE123465789. 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 Registergericht and Registerart." BusinessPartnerLegalEntity: type: object properties: legalEntityBpn: type: string legalName: type: string shortName: type: string legalForm: type: string confidenceCriteria: $ref: "#/components/schemas/BusinessPartnerConfidenceCriteriaDto" states: type: array items: $ref: "#/components/schemas/BusinessPartnerStateDto" BusinessPartnerPostalAddress: type: object properties: addressBpn: type: string name: type: string addressType: type: string enum: - LegalAndSiteMainAddress - LegalAddress - SiteMainAddress - AdditionalAddress physicalPostalAddress: $ref: "#/components/schemas/PhysicalPostalAddressDto" alternativePostalAddress: $ref: "#/components/schemas/AlternativePostalAddressDto" confidenceCriteria: $ref: "#/components/schemas/BusinessPartnerConfidenceCriteriaDto" states: type: array items: $ref: "#/components/schemas/BusinessPartnerStateDto" identifiers: type: array items: $ref: "#/components/schemas/AddressIdentifierDto" BusinessPartnerSearchResultDto: type: object description: Response of the business partner search result. properties: identifiers: type: array items: $ref: "#/components/schemas/BusinessPartnerIdentifierDto" states: type: array items: $ref: "#/components/schemas/BusinessPartnerStateDto" legalEntity: $ref: "#/components/schemas/BusinessPartnerLegalEntity" site: $ref: "#/components/schemas/BusinessPartnerSite" address: $ref: "#/components/schemas/BusinessPartnerPostalAddress" isParticipantData: type: boolean BusinessPartnerSite: type: object properties: siteBpn: type: string name: type: string confidenceCriteria: $ref: "#/components/schemas/BusinessPartnerConfidenceCriteriaDto" states: type: array items: $ref: "#/components/schemas/BusinessPartnerStateDto" BusinessPartnerStateDto: type: object properties: validFrom: type: string format: date-time validTo: type: string format: date-time type: type: string enum: - ACTIVE - INACTIVE ChangelogEntryVerboseDto: type: object 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." properties: bpn: type: string 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." enum: - LEGAL_ENTITY - SITE - ADDRESS - GENERIC timestamp: type: string format: date-time description: The date and time when the changelog entry was created. changelogType: type: string description: "One of the actions for which the changelog entry was created:\ \ create, update." enum: - CREATE - UPDATE ChangelogSearchRequest: type: object description: Request for searching and filtering the business partner changelog properties: timestampAfter: type: string format: date-time description: Only changelog entries created after this time. Ignored if empty. example: 2023-03-20T10:23:28.194Z bpns: type: array description: Only for business partners with the given array of BPNL/S/A. Ignored if empty. items: type: string uniqueItems: true businessPartnerTypes: type: array description: Only for business partners with the given array of business partner types. Ignored if empty. items: type: string enum: - LEGAL_ENTITY - SITE - ADDRESS - GENERIC uniqueItems: true ConfidenceCriteriaDto: type: object properties: sharedByOwner: type: boolean checkedByExternalDataSource: type: boolean numberOfSharingMembers: type: integer format: int32 lastConfidenceCheckAt: type: string format: date-time nextConfidenceCheckAt: type: string format: date-time confidenceLevel: type: integer format: int32 CountrySubdivisionDto: type: object description: Country subdivision properties: countryCode: type: string description: Country code enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW code: type: string description: The country subdivision code according to ISO 3166-2 name: type: string description: The name of the country subdivision according to ISO 3166-2 CxMembershipDto: type: object properties: bpnL: type: string isCatenaXMember: type: boolean CxMembershipUpdateRequest: type: object properties: memberships: type: array items: $ref: "#/components/schemas/CxMembershipDto" DataSpaceParticipantDto: type: object properties: bpnL: type: string isDataSpaceParticipant: type: boolean DataSpaceParticipantUpdateRequest: type: object properties: participants: type: array items: $ref: "#/components/schemas/DataSpaceParticipantDto" ErrorInfoAddressCreateError: type: object description: Holds information about failures when creating or updating an entity properties: errorCode: type: string description: AddressCreateError enum: - BpnNotValid - SiteNotFound - LegalEntityNotFound - RegionNotFound - IdentifierNotFound - AddressDuplicateIdentifier - IdentifiersTooMany message: type: string entityKey: type: string title: ErrorInfo ErrorInfoAddressUpdateError: type: object description: Holds information about failures when creating or updating an entity properties: errorCode: type: string description: AddressUpdateError enum: - AddressNotFound - RegionNotFound - IdentifierNotFound - AddressDuplicateIdentifier - IdentifiersTooMany message: type: string entityKey: type: string title: ErrorInfo ErrorInfoLegalEntityCreateError: type: object description: Holds information about failures when creating or updating an entity properties: errorCode: type: string description: LegalEntityCreateError enum: - LegalEntityDuplicateIdentifier - LegalFormNotFound - LegalEntityIdentifierNotFound - LegalAddressRegionNotFound - LegalAddressIdentifierNotFound - LegalAddressDuplicateIdentifier - LegalEntityIdentifiersTooMany - LegalAddressIdentifiersTooMany message: type: string entityKey: type: string title: ErrorInfo ErrorInfoLegalEntityUpdateError: type: object description: Holds information about failures when creating or updating an entity properties: errorCode: type: string description: LegalEntityUpdateError enum: - LegalEntityNotFound - LegalEntityDuplicateIdentifier - LegalFormNotFound - LegalEntityIdentifierNotFound - LegalAddressRegionNotFound - LegalAddressIdentifierNotFound - LegalAddressDuplicateIdentifier - LegalEntityIdentifiersTooMany - LegalAddressIdentifiersTooMany message: type: string entityKey: type: string title: ErrorInfo ErrorInfoSiteCreateError: type: object description: Holds information about failures when creating or updating an entity properties: errorCode: type: string description: SiteCreateError enum: - LegalEntityNotFound - MainAddressIdentifierNotFound - MainAddressRegionNotFound - MainAddressDuplicateIdentifier - MainAddressIdentifiersTooMany message: type: string entityKey: type: string title: ErrorInfo ErrorInfoSiteUpdateError: type: object description: Holds information about failures when creating or updating an entity properties: errorCode: type: string description: SiteUpdateError enum: - SiteNotFound - MainAddressIdentifierNotFound - MainAddressRegionNotFound - MainAddressDuplicateIdentifier - MainAddressIdentifiersTooMany message: type: string entityKey: type: string title: ErrorInfo FieldQualityRuleDto: type: object description: 'Rule for the quality level of an entity field ' properties: fieldPath: type: string description: Path to the field schemaName: type: string description: Schema name of the entity the field belongs to country: type: string description: Country for wich the rule is valid enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW qualityLevel: type: string description: Quality level of the field enum: - MANDATORY - OPTIONAL - FORBIDDEN GeoCoordinateDto: type: object description: "The exact location of the physical postal address in latitude,\ \ longitude, and altitude." properties: longitude: type: number format: double description: Longitude coordinate latitude: type: number format: double description: Latitude coordinate altitude: type: number format: double description: "Altitude, if applicable" IdentifierTypeDetailDto: type: object description: Information for which countries an identifier type is valid and mandatory. properties: country: type: string description: 2-digit country code for which this identifier is valid; null for universal identifiers. enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW mandatory: type: boolean description: True if identifier is mandatory in this country. IdentifierTypeDto: type: object 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." properties: technicalKey: type: string description: The technical identifier (unique in combination with businessPartnerType). businessPartnerType: type: string description: One of the types of business partners for which the identifier type is valid. enum: - LEGAL_ENTITY - ADDRESS name: type: string description: The name of the identifier type. abbreviation: type: string description: The local short form of the identifier type used in particular country. transliteratedName: type: string description: The transliterated (Latinized) form of the name. transliteratedAbbreviation: type: string description: The transliterated (Latinized) form of the abbreviation. format: type: string description: "The expected format of the identifier values for this type,\ \ given as a regular expression" categories: type: array description: |- The broader categories to which the identifier type belongs to: * `VAT` - value-added tax registration (so-called value-added tax identification numbers (VAT IDs or VATINs), e.g. EU VAT ID, UID MWST/TVA/IPA) * `TIN` - taxpayer identification (so-called taxpayer identification numbers (TINs), e.g. SIREN, NIF) * `NBR` - national business registration (e.g. HRB-Nummer, Firmenbuchnummer) for different purposes (e.g. commercial register, trade register), which are not related to tax * `IBR` - international business registration (e.g. LEI, EORI) for different purposes (e.g. regulatory reporting, risk management at financial regulatory bodies) * `OTH` - other identifier types (e.g. D&B D-U-N-S, GS1 GLN), which are not legally secure items: type: string enum: - VAT - TIN - NBR - IBR - OTH uniqueItems: true details: type: array description: Validity details. items: $ref: "#/components/schemas/IdentifierTypeDetailDto" IdentifiersSearchRequest: type: object description: Contains identifiers to search legal entities by properties: businessPartnerType: type: string description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. enum: - LEGAL_ENTITY - ADDRESS idType: type: string idValues: type: array items: type: string LegalEntityIdentifierDto: type: object description: "A legal entity identifier (uniquely) identifies the legal entity,\ \ such as the German Handelsregisternummer, a VAT number, etc." properties: value: type: string description: The value of the identifier like "DE123465789". type: type: string 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." LegalEntityIdentifierVerboseDto: type: object description: "A legal entity identifier (uniquely) identifies the legal entity,\ \ such as the German Handelsregisternummer, a VAT number, etc." properties: value: type: string description: The value of the identifier like "DE123465789". 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: The type of the identifier. LegalEntityPartnerCreateRequest: type: object 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." properties: 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. 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. items: $ref: "#/components/schemas/LegalEntityStateDto" confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" isParticipantData: type: boolean legalAddress: $ref: "#/components/schemas/LogisticAddressDto" description: "The official, legal correspondence address to be provided\ \ to government and tax authorities and used in all legal or court documents." scriptVariants: type: array items: $ref: "#/components/schemas/LegalEntityScriptVariantDto" index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. requestKey: type: string LegalEntityPartnerCreateResponseWrapper: type: object description: Holds information about successfully and failed entities after the creating/updating of several objects properties: entities: type: array items: $ref: "#/components/schemas/LegalEntityPartnerCreateVerboseDto" errors: type: array items: $ref: "#/components/schemas/ErrorInfoLegalEntityCreateError" entityCount: type: integer format: int32 errorCount: type: integer format: int32 LegalEntityPartnerCreateVerboseDto: type: object 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." 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" relations: type: array description: Relations to other business partners. items: $ref: "#/components/schemas/RelationVerboseDto" currentness: type: string format: date-time description: The date the business partner data was last indicated to be still current. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" createdAt: type: string format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. isParticipantData: type: boolean description: Indicates whether the legal entity is owned and thus provided by a Data Space Participant. legalForm: $ref: "#/components/schemas/LegalFormDto" description: The legal form of the legal entity. legalAddress: $ref: "#/components/schemas/LogisticAddressInvariantVerboseDto" description: "The official, legal correspondence address to be provided\ \ to government and tax authorities and used in all legal or court documents." scriptVariants: type: array items: $ref: "#/components/schemas/LegalEntityScriptVariantDto" index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. LegalEntityPartnerUpdateRequest: type: object 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." 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. 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. items: $ref: "#/components/schemas/LegalEntityStateDto" confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" isParticipantData: type: boolean legalAddress: $ref: "#/components/schemas/LogisticAddressDto" description: "The official, legal correspondence address to be provided\ \ to government and tax authorities and used in all legal or court documents." scriptVariants: type: array items: $ref: "#/components/schemas/LegalEntityScriptVariantDto" requestKey: type: string LegalEntityPartnerUpdateResponseWrapper: type: object description: Holds information about successfully and failed entities after the creating/updating of several objects properties: entities: type: array items: $ref: "#/components/schemas/LegalEntityPartnerCreateVerboseDto" errors: type: array items: $ref: "#/components/schemas/ErrorInfoLegalEntityUpdateError" entityCount: type: integer format: int32 errorCount: type: integer format: int32 LegalEntityPropertiesSearchRequest: type: object description: Contains keywords used for searching in legal entity properties properties: legalName: type: string bpn: type: string streetName: type: string postalCode: type: string city: type: string country: type: string enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW LegalEntityScriptVariantDto: type: object properties: scriptCode: type: string legalName: type: string shortName: type: string legalAddress: $ref: "#/components/schemas/PostalAddressScriptVariantDto" LegalEntitySearchRequest: type: object properties: bpnLs: type: array items: type: string legalName: type: string LegalEntityStateDto: type: object 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." properties: validFrom: type: string format: date-time description: The date from which the state is valid. validTo: type: string format: date-time description: The date until the state is valid. type: type: string description: "One of the state types: active, inactive." enum: - ACTIVE - INACTIVE LegalEntityStateVerboseDto: type: object 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." properties: validFrom: type: string format: date-time description: The date from which the state is valid. validTo: type: string format: date-time description: The date until the state is valid. type: $ref: "#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType" description: "One of the state types: active, inactive." LegalEntityWithLegalAddressVerboseDto: type: object 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." 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" relations: type: array description: Relations to other business partners. items: $ref: "#/components/schemas/RelationVerboseDto" currentness: type: string format: date-time description: The date the business partner data was last indicated to be still current. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" createdAt: type: string format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. isParticipantData: type: boolean description: Indicates whether the legal entity is owned and thus provided by a Data Space Participant. legalForm: $ref: "#/components/schemas/LegalFormDto" description: The legal form of the legal entity. legalAddress: $ref: "#/components/schemas/LogisticAddressInvariantVerboseDto" description: "The official, legal correspondence address to be provided\ \ to government and tax authorities and used in all legal or court documents." scriptVariants: type: array items: $ref: "#/components/schemas/LegalEntityScriptVariantDto" LegalFormDto: type: object description: "A legal form is a mandatory corporate legal framework by which\ \ companies can conduct business, charitable or other permissible activities." properties: technicalKey: type: string description: The technical identifier of the legal form according to ISO 20275. name: type: string description: The name of legal form according to ISO 20275. transliteratedName: type: string abbreviations: type: string description: "The abbreviated name of the legal form, such as AG for German\ \ Aktiengesellschaft." country: type: string enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW language: type: string enum: - undefined - aa - ab - ae - af - ak - am - an - ar - as - av - ay - az - ba - be - bg - bh - bi - bm - bn - bo - br - bs - ca - ce - ch - co - cr - cs - cu - cv - cy - da - de - dv - dz - ee - el - en - eo - es - et - eu - fa - ff - fi - fj - fo - fr - fy - ga - gd - gl - gn - gu - gv - ha - he - hi - ho - hr - ht - hu - hy - hz - ia - id - ie - ig - ii - ik - io - is - it - iu - ja - jv - ka - kg - ki - kj - kk - kl - km - kn - ko - kr - ks - ku - kv - kw - ky - la - lb - lg - li - ln - lo - lt - lu - lv - mg - mh - mi - mk - ml - mn - mr - ms - mt - my - na - nb - nd - ne - ng - nl - nn - "no" - nr - nv - ny - oc - oj - om - or - os - pa - pi - pl - ps - pt - qu - rm - rn - ro - ru - rw - sa - sc - sd - se - sg - si - sk - sl - sm - sn - so - sq - sr - ss - st - su - sv - sw - ta - te - tg - th - ti - tk - tl - tn - to - tr - ts - tt - tw - ty - ug - uk - ur - uz - ve - vi - vo - wa - wo - xh - yi - yo - za - zh - zu administrativeAreaLevel1: type: string transliteratedAbbreviations: type: string isActive: type: boolean LegalFormRequest: type: object description: New legal form record to be referenced by business partners properties: technicalKey: type: string name: type: string transliteratedName: type: string abbreviations: type: string transliteratedAbbreviations: type: string country: type: string enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW language: type: string enum: - undefined - aa - ab - ae - af - ak - am - an - ar - as - av - ay - az - ba - be - bg - bh - bi - bm - bn - bo - br - bs - ca - ce - ch - co - cr - cs - cu - cv - cy - da - de - dv - dz - ee - el - en - eo - es - et - eu - fa - ff - fi - fj - fo - fr - fy - ga - gd - gl - gn - gu - gv - ha - he - hi - ho - hr - ht - hu - hy - hz - ia - id - ie - ig - ii - ik - io - is - it - iu - ja - jv - ka - kg - ki - kj - kk - kl - km - kn - ko - kr - ks - ku - kv - kw - ky - la - lb - lg - li - ln - lo - lt - lu - lv - mg - mh - mi - mk - ml - mn - mr - ms - mt - my - na - nb - nd - ne - ng - nl - nn - "no" - nr - nv - ny - oc - oj - om - or - os - pa - pi - pl - ps - pt - qu - rm - rn - ro - ru - rw - sa - sc - sd - se - sg - si - sk - sl - sm - sn - so - sq - sr - ss - st - su - sv - sw - ta - te - tg - th - ti - tk - tl - tn - to - tr - ts - tt - tw - ty - ug - uk - ur - uz - ve - vi - vo - wa - wo - xh - yi - yo - za - zh - zu administrativeAreaLevel1: type: string isActive: type: boolean description: Whether this legal form is considered as active according to GLEIF LogisticAddressDto: type: object 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." 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. states: type: array description: The list of (temporary) states of the address. items: $ref: "#/components/schemas/AddressStateDto" identifiers: type: array description: The list of identifiers of the address. items: $ref: "#/components/schemas/AddressIdentifierDto" physicalPostalAddress: $ref: "#/components/schemas/PhysicalPostalAddressDto" description: "The physical postal address of the address, such as an office,\ \ warehouse, gate, etc." alternativePostalAddress: $ref: "#/components/schemas/AlternativePostalAddressDto" description: "The alternative postal address of the address, for example\ \ if the goods are to be picked up somewhere else." confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" LogisticAddressInvariantVerboseDto: type: object 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." 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." 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. 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: $ref: "#/components/schemas/PhysicalPostalAddressVerboseDto" description: "The physical postal address of the address, such as an office,\ \ warehouse, gate, etc." alternativePostalAddress: $ref: "#/components/schemas/AlternativePostalAddressVerboseDto" description: "The alternative postal address of the address, for example\ \ if the goods are to be picked up somewhere else." bpnLegalEntity: type: string description: The BPNL of the legal entity owning the address. bpnSite: type: string description: The BPNS of the site the address belongs to. createdAt: type: string format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" addressType: type: string description: "Indicates the address type, the legal address to a legal entity\ \ or the main address to a site, an additional address, or both legal\ \ and site address.The site main address is where typically the main entrance\ \ or the reception is located, or where the mail is delivered to." enum: - LegalAndSiteMainAddress - LegalAddress - SiteMainAddress - AdditionalAddress isParticipantData: type: boolean description: Indicates whether the address is owned and thus provided by a Data Space Participant. LogisticAddressScriptVariantDto: type: object properties: scriptCode: type: string addressName: type: string physicalAddress: $ref: "#/components/schemas/PhysicalAddressScriptVariantDto" alternativeAddress: $ref: "#/components/schemas/AlternativeAddressScriptVariantDto" LogisticAddressVerboseDto: type: object 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." 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." 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. 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: $ref: "#/components/schemas/PhysicalPostalAddressVerboseDto" description: "The physical postal address of the address, such as an office,\ \ warehouse, gate, etc." alternativePostalAddress: $ref: "#/components/schemas/AlternativePostalAddressVerboseDto" description: "The alternative postal address of the address, for example\ \ if the goods are to be picked up somewhere else." bpnLegalEntity: type: string description: The BPNL of the legal entity owning the address. bpnSite: type: string description: The BPNS of the site the address belongs to. createdAt: type: string format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" addressType: type: string description: "Indicates the address type, the legal address to a legal entity\ \ or the main address to a site, an additional address, or both legal\ \ and site address.The site main address is where typically the main entrance\ \ or the reception is located, or where the mail is delivered to." enum: - LegalAndSiteMainAddress - LegalAddress - SiteMainAddress - AdditionalAddress isCatenaXMemberData: type: boolean description: Indicates whether the address is owned and thus provided by a Catena-X Member. PageDtoBusinessPartnerSearchResultDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/BusinessPartnerSearchResultDto" PageDtoChangelogEntryVerboseDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/ChangelogEntryVerboseDto" PageDtoCountrySubdivisionDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/CountrySubdivisionDto" PageDtoCxMembershipDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/CxMembershipDto" PageDtoDataSpaceParticipantDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/DataSpaceParticipantDto" PageDtoIdentifierTypeDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/IdentifierTypeDto" PageDtoLegalEntityWithLegalAddressVerboseDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/LegalEntityWithLegalAddressVerboseDto" PageDtoLegalFormDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/LegalFormDto" PageDtoLogisticAddressInvariantVerboseDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/LogisticAddressInvariantVerboseDto" PageDtoLogisticAddressVerboseDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/LogisticAddressVerboseDto" PageDtoScriptCodeDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/ScriptCodeDto" PageDtoSiteVerboseDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/SiteVerboseDto" PageDtoSiteWithMainAddressVerboseDto: type: object description: Paginated collection of results properties: totalElements: type: integer format: int64 description: Total number of all results in all pages totalPages: type: integer format: int32 description: Total number pages page: type: integer format: int32 description: Current page number contentSize: type: integer format: int32 description: Number of results in the page content: type: array description: Collection of results in the page items: $ref: "#/components/schemas/SiteWithMainAddressVerboseDto" PhysicalAddressScriptVariantDto: type: object properties: postalCode: type: string city: type: string district: type: string street: $ref: "#/components/schemas/StreetDto" companyPostalCode: type: string industrialZone: type: string building: type: string floor: type: string door: type: string taxJurisdictionCode: type: string PhysicalPostalAddressDto: type: object description: "A physical postal address describes the physical location of an\ \ office, warehouse, gate, etc." 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. enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW administrativeAreaLevel1: type: string 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." administrativeAreaLevel3: type: string 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." city: type: string 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. 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." industrialZone: type: string 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. floor: type: string 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." taxJurisdictionCode: type: string description: "Tax jurisdiction codes are used to identify the specific jurisdiction(s)\ \ that a company belong to, particularly in bureaucratic processes such\ \ as tax returns and IRS forms." PhysicalPostalAddressVerboseDto: type: object description: "A physical postal address describes the physical location of an\ \ office, warehouse, gate, etc." properties: geographicCoordinates: $ref: "#/components/schemas/GeoCoordinateDto" administrativeAreaLevel2: type: string 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." 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." city: type: string 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. 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." industrialZone: type: string 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. floor: type: string 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." taxJurisdictionCode: type: string description: "Tax jurisdiction codes are used to identify the specific jurisdiction(s)\ \ that a company belong to, particularly in bureaucratic processes such\ \ as tax returns and IRS forms." country: $ref: "#/components/schemas/TypeKeyNameVerboseDtoCountryCode" description: The 2-digit country code of the physical postal address according to ISO 3166-1. administrativeAreaLevel1: $ref: "#/components/schemas/RegionDto" description: "The 2-digit country subdivision code according to ISO 3166-2,\ \ such as a region within a country." PostalAddressScriptVariantDto: type: object properties: addressName: type: string physicalAddress: $ref: "#/components/schemas/PhysicalAddressScriptVariantDto" alternativeAddress: $ref: "#/components/schemas/AlternativeAddressScriptVariantDto" RegionDto: type: object description: Region within a country properties: countryCode: type: string description: Country code enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW regionCode: type: string 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 RelationValidityPeriod: type: object description: A relation validity describes a timeframe in which a relation is active. properties: validFrom: type: string format: date description: The date from which the relation is valid. validTo: type: string format: date description: The date until which the relation is valid. RelationVerboseDto: type: object description: Directed relation between two business partners properties: type: type: string description: The type of relation between the Legal Entities enum: - IsAlternativeHeadquarterFor - IsManagedBy - IsOwnedBy businessPartnerSourceBpnl: type: string description: BPN of partner from which the relation emerges (the source) businessPartnerTargetBpnl: type: string description: BPN of partner to which this relation goes (the target) validityPeriods: type: array items: $ref: "#/components/schemas/RelationValidityPeriod" ScriptCodeDto: type: object properties: technicalKey: type: string description: type: string SiteCreateRequestWithLegalAddressAsMain: 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. states: type: array description: The list of the (temporary) states of the site. items: $ref: "#/components/schemas/SiteStateDto" confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" bpnLParent: type: string SitePartnerCreateRequest: type: object 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." 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. 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" scriptVariants: type: array items: $ref: "#/components/schemas/SiteScriptVariantDto" bpnlParent: type: string index: type: string requestKey: type: string SitePartnerCreateResponseWrapper: type: object description: Holds information about successfully and failed entities after the creating/updating of several objects properties: entities: type: array items: $ref: "#/components/schemas/SitePartnerCreateVerboseDto" errors: type: array items: $ref: "#/components/schemas/ErrorInfoSiteCreateError" entityCount: type: integer format: int32 errorCount: type: integer format: int32 SitePartnerCreateVerboseDto: type: object 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." 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 format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" scriptVariants: type: array items: $ref: "#/components/schemas/SiteScriptVariantDto" isParticipantData: type: boolean description: Indicates whether the site is owned and thus provided by a Data Space Participant. mainAddress: $ref: "#/components/schemas/LogisticAddressInvariantVerboseDto" description: "The address, where typically the main entrance or the reception\ \ is located, or where the mail is delivered to." index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. SitePartnerUpdateRequest: type: object 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." properties: bpns: 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. 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" scriptVariants: type: array items: $ref: "#/components/schemas/SiteScriptVariantDto" requestKey: type: string SitePartnerUpdateResponseWrapper: type: object description: Holds information about successfully and failed entities after the creating/updating of several objects properties: entities: type: array items: $ref: "#/components/schemas/SitePartnerCreateVerboseDto" errors: type: array items: $ref: "#/components/schemas/ErrorInfoSiteUpdateError" entityCount: type: integer format: int32 errorCount: type: integer format: int32 SiteScriptVariantDto: type: object properties: scriptCode: type: string name: type: string mainAddress: $ref: "#/components/schemas/PostalAddressScriptVariantDto" SiteSearchRequest: type: object properties: siteBpns: type: array items: type: string legalEntityBpns: type: array items: type: string name: type: string SiteStateDto: type: object 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." properties: validFrom: type: string format: date-time description: The date from which the state is valid. validTo: type: string format: date-time description: The date until the state is valid. type: type: string description: "One of the state types: active, inactive." enum: - ACTIVE - INACTIVE SiteStateVerboseDto: type: object 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." properties: validFrom: type: string format: date-time description: The date from which the state is valid. validTo: type: string format: date-time description: The date until the state is valid. type: $ref: "#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType" description: "One of the state types: active, inactive." SiteVerboseDto: type: object 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." 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 format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" scriptVariants: type: array items: $ref: "#/components/schemas/SiteScriptVariantDto" isParticipantData: type: boolean description: Indicates whether the site is owned and thus provided by a Data Space Participant. SiteWithMainAddressVerboseDto: type: object 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." 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 format: date-time description: The date when the data record has been created. updatedAt: type: string format: date-time description: The date when the data record has been last updated. confidenceCriteria: $ref: "#/components/schemas/ConfidenceCriteriaDto" scriptVariants: type: array items: $ref: "#/components/schemas/SiteScriptVariantDto" isParticipantData: type: boolean description: Indicates whether the site is owned and thus provided by a Data Space Participant. mainAddress: $ref: "#/components/schemas/LogisticAddressInvariantVerboseDto" StreetDto: type: object description: "The street of the physical postal address, synonyms: road, avenue,\ \ lane, boulevard, highway" properties: name: type: string description: The name of the street. houseNumber: 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." 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." namePrefix: type: string 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." 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." TypeKeyNameVerboseDtoBusinessStateType: type: object description: Named type uniquely identified by its technical key properties: technicalKey: type: string description: Unique key of this type for reference enum: - ACTIVE - INACTIVE name: type: string description: Name or denotation of this type TypeKeyNameVerboseDtoCountryCode: type: object description: Named type uniquely identified by its technical key properties: technicalKey: type: string description: Unique key of this type for reference enum: - UNDEFINED - AC - AD - AE - AF - AG - AI - AL - AM - AN - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BU - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CP - CR - CS - CU - CV - CW - CX - CY - CZ - DE - DG - DJ - DK - DM - DO - DZ - EA - EC - EE - EG - EH - ER - ES - ET - EU - EZ - FI - FJ - FK - FM - FO - FR - FX - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - IC - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - "NO" - NP - NR - NT - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SF - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SU - SV - SX - SY - SZ - TA - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TP - TR - TT - TV - TW - TZ - UA - UG - UK - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - XI - XU - XK - YE - YT - YU - ZA - ZM - ZR - ZW name: type: string description: Name or denotation of this type TypeKeyNameVerboseDtoString: type: object description: Named type uniquely identified by its technical key properties: technicalKey: type: string description: Unique key of this type for reference name: type: string description: Name or denotation of this type securitySchemes: open_id_scheme: type: oauth2 flows: clientCredentials: tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token scopes: {} authorizationCode: authorizationUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/auth tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token refreshUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token scopes: {} bearer_scheme: type: http scheme: bearer bearerFormat: JWT