openapi: 3.0.1 info: title: Business Partner Data Management Pool description: Service that manages and shares business partner data with other CatenaX services version: 6.2.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: Bpn Controller description: Support functionality for BPN operations - name: Address Controller description: Read, create and update business partner of type address paths: /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 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: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 /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 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: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 /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: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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/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: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 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_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 /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 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' - 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 /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 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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/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: uniqueItems: true type: array items: $ref: '#/components/schemas/BpnIdentifierMappingDto' '400': description: On malformed request parameters or if number of requested bpns exceeds limit '404': description: Specified identifier type not found /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_1 parameters: - name: page in: query description: Number of page to get results from required: false schema: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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/{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 /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 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 default: BPN 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_1 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: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 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: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 /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: minimum: 0 type: string default: '0' - name: size in: query description: Size of each page required: false schema: maximum: 100 minimum: 0 type: string default: '10' 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 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: required: - type - value type: object properties: value: type: string description: The value of the identifier like "0847976000005". type: type: string description: The type of the identifier. description: An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN). AddressIdentifierVerboseDto: required: - type - value type: object properties: value: type: string description: The value of the identifier like "0847976000005". type: $ref: '#/components/schemas/TypeKeyNameVerboseDtoString' description: An address identifier (uniquely) identifies the address, such as the Global Location Number (GLN). AddressPartnerCreateRequest: required: - bpnParent type: object properties: bpnParent: type: string description: BPNL of the legal entity or BPNS of the site this address belongs to. index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. requestKey: type: string description: Request for creating new business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressPartnerCreateResponseWrapper: required: - entities - entityCount - errorCount - errors type: object 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 description: Holds information about successfully and failed entities after the creating/updating of several objects AddressPartnerCreateVerboseDto: type: object properties: index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. description: Created business partner of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressPartnerUpdateRequest: required: - bpna - requestKey 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. requestKey: type: string description: Request for updating a business partner record of type address. In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. AddressPartnerUpdateResponseWrapper: required: - entities - entityCount - errorCount - errors type: object properties: entities: type: array items: $ref: '#/components/schemas/LogisticAddressVerboseDto' errors: type: array items: $ref: '#/components/schemas/ErrorInfoAddressUpdateError' entityCount: type: integer format: int32 errorCount: type: integer format: int32 description: Holds information about successfully and failed entities after the creating/updating of several objects AddressSearchRequest: required: - addressBpns - legalEntityBpns - siteBpns 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: required: - type type: object properties: validFrom: type: string description: The date from which the state is valid. format: date-time validTo: type: string description: The date until the state is valid. format: date-time type: type: string description: 'One of the state types: active, inactive.' enum: - ACTIVE - INACTIVE description: An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address. AddressStateVerboseDto: required: - type type: object properties: validFrom: type: string description: The date from which the state is valid. format: date-time validTo: type: string description: The date until the state is valid. format: date-time type: $ref: '#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType' description: An address state indicates if the address is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the business partner is still operating at that address. AlternativePostalAddressDto: required: - city - country - deliveryServiceNumber - deliveryServiceType type: object properties: geographicCoordinates: $ref: '#/components/schemas/GeoCoordinateDto' country: type: string description: The 2-digit country code of the physical postal address according to ISO 3166-1. 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. description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. AlternativePostalAddressVerboseDto: required: - city - country - deliveryServiceNumber - deliveryServiceType type: object properties: geographicCoordinates: $ref: '#/components/schemas/GeoCoordinateDto' country: $ref: '#/components/schemas/TypeKeyNameVerboseDtoCountryCode' administrativeAreaLevel1: $ref: '#/components/schemas/RegionDto' postalCode: type: string description: The alphanumeric identifier (sometimes including spaces or punctuation) of the physical postal address for the purpose of sorting mail, synonyms:postcode, post code, PIN or ZIP code. 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. description: An alternative postal address describes an alternative way of delivery for example if the goods are to be picked up somewhere else. BpnIdentifierMappingDto: required: - bpn - idValue type: object properties: idValue: type: string description: Value of the identifier bpn: type: string description: Business Partner Number description: Mapping of Business Partner Number to identifier value ChangelogEntryVerboseDto: required: - bpn - businessPartnerType - changelogType - timestamp type: object 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 description: The date and time when the changelog entry was created. format: date-time changelogType: type: string description: 'One of the actions for which the changelog entry was created: create, update.' enum: - CREATE - UPDATE description: An entry of the changelog, which is created each time a business partner is modified and contains data about the change. The actual new state of the business partner is not included. ChangelogSearchRequest: type: object properties: timestampAfter: type: string description: Only changelog entries created after this time. Ignored if empty. format: date-time example: '2023-03-20T10:23:28.194Z' bpns: uniqueItems: true type: array description: Only for business partners with the given array of BPNL/S/A. Ignored if empty. items: type: string businessPartnerTypes: uniqueItems: true type: array description: Only for business partners with the given array of business partner types. Ignored if empty. items: type: string enum: - LEGAL_ENTITY - SITE - ADDRESS - GENERIC description: Request for searching and filtering the business partner changelog ConfidenceCriteriaDto: required: - checkedByExternalDataSource - confidenceLevel - lastConfidenceCheckAt - nextConfidenceCheckAt - numberOfSharingMembers - sharedByOwner 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: required: - code - countryCode - name type: object 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 description: Country subdivision ErrorInfoAddressCreateError: title: ErrorInfo required: - errorCode - message type: object properties: errorCode: type: string description: AddressCreateError enum: - BpnNotValid - SiteNotFound - LegalEntityNotFound - RegionNotFound - IdentifierNotFound - AddressDuplicateIdentifier message: type: string description: Error message that explains the error entityKey: type: string description: 'Key of the entity that failed from the request object: index or BPN' description: Holds information about failures when creating or updating an entity ErrorInfoAddressUpdateError: title: ErrorInfo required: - errorCode - message type: object properties: errorCode: type: string description: AddressUpdateError enum: - AddressNotFound - RegionNotFound - IdentifierNotFound - AddressDuplicateIdentifier message: type: string description: Error message that explains the error entityKey: type: string description: 'Key of the entity that failed from the request object: index or BPN' description: Holds information about failures when creating or updating an entity ErrorInfoLegalEntityCreateError: title: ErrorInfo required: - errorCode - message type: object properties: errorCode: type: string description: LegalEntityCreateError enum: - LegalEntityDuplicateIdentifier - LegalFormNotFound - LegalEntityIdentifierNotFound - LegalAddressRegionNotFound - LegalAddressIdentifierNotFound - LegalAddressDuplicateIdentifier - LegalEntityErrorMapping message: type: string description: Error message that explains the error entityKey: type: string description: 'Key of the entity that failed from the request object: index or BPN' description: Holds information about failures when creating or updating an entity ErrorInfoLegalEntityUpdateError: title: ErrorInfo required: - errorCode - message type: object properties: errorCode: type: string description: LegalEntityUpdateError enum: - LegalEntityNotFound - LegalEntityDuplicateIdentifier - LegalFormNotFound - LegalEntityIdentifierNotFound - LegalAddressRegionNotFound - LegalAddressIdentifierNotFound - LegalAddressDuplicateIdentifier - LegalEntityErrorMapping message: type: string description: Error message that explains the error entityKey: type: string description: 'Key of the entity that failed from the request object: index or BPN' description: Holds information about failures when creating or updating an entity ErrorInfoSiteCreateError: title: ErrorInfo required: - errorCode - message type: object properties: errorCode: type: string description: SiteCreateError enum: - LegalEntityNotFound - MainAddressIdentifierNotFound - MainAddressRegionNotFound - MainAddressDuplicateIdentifier message: type: string description: Error message that explains the error entityKey: type: string description: 'Key of the entity that failed from the request object: index or BPN' description: Holds information about failures when creating or updating an entity ErrorInfoSiteUpdateError: title: ErrorInfo required: - errorCode - message type: object properties: errorCode: type: string description: SiteUpdateError enum: - SiteNotFound - MainAddressIdentifierNotFound - MainAddressRegionNotFound - MainAddressDuplicateIdentifier message: type: string description: Error message that explains the error entityKey: type: string description: 'Key of the entity that failed from the request object: index or BPN' description: Holds information about failures when creating or updating an entity FieldQualityRuleDto: required: - country - fieldPath - qualityLevel type: object 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: Defines the quality of an entity field. enum: - MANDATORY - OPTIONAL - FORBIDDEN description: 'Rule for the quality level of an entity field ' GeoCoordinateDto: required: - latitude - longitude type: object properties: longitude: type: number description: Longitude coordinate format: float latitude: type: number description: Latitude coordinate format: float altitude: type: number description: Altitude, if applicable format: float description: The exact location of the physical postal address in latitude, longitude, and altitude. IdentifierTypeDetailDto: required: - mandatory type: object 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. description: Information for which countries an identifier type is valid and mandatory. IdentifierTypeDto: required: - businessPartnerType - details - name - technicalKey type: object properties: technicalKey: type: string description: The technical identifier (unique in combination with businessPartnerType). businessPartnerType: type: string description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. 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. details: type: array description: Validity details. items: $ref: '#/components/schemas/IdentifierTypeDetailDto' description: An identifier type defines the name or category of an identifier, such as the German Handelsregisternummer, VAT number, Global Location Number (GLN), etc. The identifier type is valid for a business partner type. IdentifiersSearchRequest: required: - businessPartnerType - idType - idValues type: object properties: businessPartnerType: type: string description: Specifies if an identifier type is valid for legal entities (L) or addresses (A). Sites (S) are not supported. enum: - LEGAL_ENTITY - ADDRESS idType: type: string description: Technical key of the type to which the identifiers belongs to idValues: type: array description: Values of the identifiers items: type: string description: Values of the identifiers description: Contains identifiers to search legal entities by LegalEntityPartnerCreateRequest: required: - legalAddress type: object properties: legalAddress: $ref: '#/components/schemas/LogisticAddressDto' index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. requestKey: type: string description: Request for creating new business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityPartnerCreateResponseWrapper: required: - entities - entityCount - errorCount - errors type: object 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 description: Holds information about successfully and failed entities after the creating/updating of several objects LegalEntityPartnerCreateVerboseDto: required: - legalAddress type: object properties: legalAddress: $ref: '#/components/schemas/LogisticAddressVerboseDto' index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. description: Created/updated business partner of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityPartnerUpdateRequest: required: - bpnl - legalAddress - requestKey type: object properties: bpnl: type: string description: A BPNL represents and uniquely identifies a legal entity, which is defined by its legal name (including legal form, if registered), legal address and tax number. legalAddress: $ref: '#/components/schemas/LogisticAddressDto' requestKey: type: string description: Request for updating a business partner record of type legal entity. In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalEntityPartnerUpdateResponseWrapper: required: - entities - entityCount - errorCount - errors type: object 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 description: Holds information about successfully and failed entities after the creating/updating of several objects LegalEntitySearchRequest: required: - bpnLs type: object properties: bpnLs: type: array items: type: string legalName: type: string LegalEntityWithLegalAddressVerboseDto: required: - legalAddress type: object properties: legalAddress: $ref: '#/components/schemas/LogisticAddressVerboseDto' description: In general, a legal entity is a juridical person that has legal rights and duties related to contracts, agreements, and obligations. The term especially applies to any kind of organization (such as an enterprise or company, university, association, etc.) established under the law applicable to a country.In Catena-X, a legal entity is a type of business partner representing a legally registered organization with its official registration information, such as legal name (including legal form, if registered), legal address and tax number.A legal entity has exactly one legal address, but it is possible to specify additional addresses that a legal entity owns. Thus, at least one address is assigned to a legal entity. A legal entity can own sites. Thus, many or no sites are assigned to a legal entity. A legal entity is uniquely identified by the BPNL. LegalFormDto: required: - name - technicalKey type: object 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. abbreviation: type: string description: The abbreviated name of the legal form, such as AG for German Aktiengesellschaft. description: A legal form is a mandatory corporate legal framework by which companies can conduct business, charitable or other permissible activities. LegalFormRequest: required: - name - technicalKey type: object properties: technicalKey: type: string description: Unique key to be used for reference name: type: string description: Full name of the legal form abbreviation: type: string description: Abbreviation of the legal form name description: New legal form record to be referenced by business partners LogisticAddressDto: required: - confidenceCriteria - identifiers - physicalPostalAddress - states type: object 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' alternativePostalAddress: $ref: '#/components/schemas/AlternativePostalAddressDto' confidenceCriteria: $ref: '#/components/schemas/ConfidenceCriteriaDto' description: In general, an address is a collection of information to describe a physical location, using a street name with a house number and/or a post office box as reference. In addition, an address consists of several postal attributes, such as country, region (state), county, township, city, district, or postal code, which help deliver mail.In Catena-X, an address is a type of business partner representing the legal address of a legal entity, and/or the main address of a site, or any additional address of a legal entity or site (such as different gates).An address is owned by a legal entity. Thus, exactly one legal entity is assigned to an address. An address can belong to a site. Thus, one or no site is assigned to an address. An address is uniquely identified by the BPNA. LogisticAddressVerboseDto: required: - bpna - confidenceCriteria - createdAt - identifiers - isCatenaXMemberData - physicalPostalAddress - states - updatedAt 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' alternativePostalAddress: $ref: '#/components/schemas/AlternativePostalAddressVerboseDto' 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. isCatenaXMemberData: type: boolean description: Indicates whether the address is owned and thus provided by a Catena-X Member. createdAt: type: string description: The date when the data record has been created. format: date-time updatedAt: type: string description: The date when the data record has been last updated. format: date-time confidenceCriteria: $ref: '#/components/schemas/ConfidenceCriteriaDto' 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 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. PageDtoChangelogEntryVerboseDto: required: - content - contentSize - page - totalElements - totalPages type: object properties: totalElements: type: integer description: Total number of all results in all pages format: int64 totalPages: type: integer description: Total number pages format: int32 page: type: integer description: Current page number format: int32 contentSize: type: integer description: Number of results in the page format: int32 content: type: array description: Collection of results in the page items: $ref: '#/components/schemas/ChangelogEntryVerboseDto' description: Paginated collection of results PageDtoCountrySubdivisionDto: required: - content - contentSize - page - totalElements - totalPages type: object properties: totalElements: type: integer description: Total number of all results in all pages format: int64 totalPages: type: integer description: Total number pages format: int32 page: type: integer description: Current page number format: int32 contentSize: type: integer description: Number of results in the page format: int32 content: type: array description: Collection of results in the page items: $ref: '#/components/schemas/CountrySubdivisionDto' description: Paginated collection of results PageDtoIdentifierTypeDto: required: - content - contentSize - page - totalElements - totalPages type: object properties: totalElements: type: integer description: Total number of all results in all pages format: int64 totalPages: type: integer description: Total number pages format: int32 page: type: integer description: Current page number format: int32 contentSize: type: integer description: Number of results in the page format: int32 content: type: array description: Collection of results in the page items: $ref: '#/components/schemas/IdentifierTypeDto' description: Paginated collection of results PageDtoLegalEntityWithLegalAddressVerboseDto: required: - content - contentSize - page - totalElements - totalPages type: object properties: totalElements: type: integer description: Total number of all results in all pages format: int64 totalPages: type: integer description: Total number pages format: int32 page: type: integer description: Current page number format: int32 contentSize: type: integer description: Number of results in the page format: int32 content: type: array description: Collection of results in the page items: $ref: '#/components/schemas/LegalEntityWithLegalAddressVerboseDto' description: Paginated collection of results PageDtoLegalFormDto: required: - content - contentSize - page - totalElements - totalPages type: object properties: totalElements: type: integer description: Total number of all results in all pages format: int64 totalPages: type: integer description: Total number pages format: int32 page: type: integer description: Current page number format: int32 contentSize: type: integer description: Number of results in the page format: int32 content: type: array description: Collection of results in the page items: $ref: '#/components/schemas/LegalFormDto' description: Paginated collection of results PageDtoLogisticAddressVerboseDto: required: - content - contentSize - page - totalElements - totalPages type: object properties: totalElements: type: integer description: Total number of all results in all pages format: int64 totalPages: type: integer description: Total number pages format: int32 page: type: integer description: Current page number format: int32 contentSize: type: integer description: Number of results in the page format: int32 content: type: array description: Collection of results in the page items: $ref: '#/components/schemas/LogisticAddressVerboseDto' description: Paginated collection of results PageDtoSiteVerboseDto: required: - content - contentSize - page - totalElements - totalPages type: object properties: totalElements: type: integer description: Total number of all results in all pages format: int64 totalPages: type: integer description: Total number pages format: int32 page: type: integer description: Current page number format: int32 contentSize: type: integer description: Number of results in the page format: int32 content: type: array description: Collection of results in the page items: $ref: '#/components/schemas/SiteVerboseDto' description: Paginated collection of results PageDtoSiteWithMainAddressVerboseDto: required: - content - contentSize - page - totalElements - totalPages type: object properties: totalElements: type: integer description: Total number of all results in all pages format: int64 totalPages: type: integer description: Total number pages format: int32 page: type: integer description: Current page number format: int32 contentSize: type: integer description: Number of results in the page format: int32 content: type: array description: Collection of results in the page items: $ref: '#/components/schemas/SiteWithMainAddressVerboseDto' description: Paginated collection of results PhysicalPostalAddressDto: required: - city - country type: object properties: geographicCoordinates: $ref: '#/components/schemas/GeoCoordinateDto' country: type: string description: The 2-digit country code of the physical postal address according to ISO 3166-1. 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. description: A physical postal address describes the physical location of an office, warehouse, gate, etc. PhysicalPostalAddressVerboseDto: required: - city - country type: object properties: geographicCoordinates: $ref: '#/components/schemas/GeoCoordinateDto' country: $ref: '#/components/schemas/TypeKeyNameVerboseDtoCountryCode' administrativeAreaLevel1: $ref: '#/components/schemas/RegionDto' administrativeAreaLevel2: type: string description: The name of the locally regulated secondary country subdivision of the physical postal address, such as county within a country. 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. description: A physical postal address describes the physical location of an office, warehouse, gate, etc. RegionDto: required: - countryCode - regionCode - regionName type: object 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 description: Region within a country SiteCreateRequestWithLegalAddressAsMain: required: - bpnLParent - confidenceCriteria - name - states 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: required: - bpnlParent type: object properties: bpnlParent: type: string description: The BPNL of the legal entity owning the site. index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. requestKey: type: string description: Request for creating new business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SitePartnerCreateResponseWrapper: required: - entities - entityCount - errorCount - errors type: object 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 description: Holds information about successfully and failed entities after the creating/updating of several objects SitePartnerCreateVerboseDto: required: - mainAddress type: object properties: mainAddress: $ref: '#/components/schemas/LogisticAddressVerboseDto' index: type: string description: User defined index to conveniently match this entry to the corresponding entry in the response. description: Created/updated business partner of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SitePartnerUpdateRequest: required: - bpns - requestKey type: object properties: bpns: type: string description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. requestKey: type: string description: Request for updating a business partner record of type site. In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SitePartnerUpdateResponseWrapper: required: - entities - entityCount - errorCount - errors type: object 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 description: Holds information about successfully and failed entities after the creating/updating of several objects SiteSearchRequest: required: - legalEntityBpns - siteBpns type: object properties: siteBpns: type: array items: type: string legalEntityBpns: type: array items: type: string name: type: string SiteStateDto: required: - type type: object properties: validFrom: type: string description: The date from which the state is valid. format: date-time validTo: type: string description: The date until the state is valid. format: date-time type: type: string description: 'One of the state types: active, inactive.' enum: - ACTIVE - INACTIVE description: A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating. SiteStateVerboseDto: required: - type type: object properties: validFrom: type: string description: The date from which the state is valid. format: date-time validTo: type: string description: The date until the state is valid. format: date-time type: $ref: '#/components/schemas/TypeKeyNameVerboseDtoBusinessStateType' description: A site state indicates if the site is active or inactive. This does not describe the relation between a sharing member and a business partner and whether they have active business, but it describes whether the site is still operating. SiteVerboseDto: required: - bpnLegalEntity - bpns - confidenceCriteria - createdAt - isCatenaXMemberData - name - states - updatedAt type: object properties: bpns: type: string description: A BPNS represents and uniquely identifies a site, which is where for example a production plant, a warehouse, or an office building is located. name: type: string description: The name of the site. This is not according to official registers but according to the name the owner chooses. states: type: array description: The list of the (temporary) states of the site. items: $ref: '#/components/schemas/SiteStateVerboseDto' isCatenaXMemberData: type: boolean description: Indicates whether the site is owned and thus provided by a Catena-X Member. bpnLegalEntity: type: string description: The BPNL of the legal entity owning the site. createdAt: type: string description: The date when the data record has been created. format: date-time updatedAt: type: string description: The date when the data record has been last updated. format: date-time confidenceCriteria: $ref: '#/components/schemas/ConfidenceCriteriaDto' description: In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. SiteWithMainAddressVerboseDto: required: - mainAddress type: object properties: mainAddress: $ref: '#/components/schemas/LogisticAddressVerboseDto' description: In general, a site is a delimited geographical area in which an organization (such as an enterprise or company, university, association, etc.) conducts business. In Catena-X, a site is a type of business partner representing a physical location or area owned by a legal entity, where a production plant, a warehouse, or an office building is located. A site is owned by a legal entity. Thus, exactly one legal entity is assigned to a site. A site has exactly one main address, but it is possible to specify additional addresses (such as different gates), that belong to a site. Thus, at least one address is assigned to a site. A site can only be uploaded and modified by the owner (the legal entity), because only the owner knows which addresses belong to which site. A site is uniquely identified by the BPNS. StreetDto: type: object properties: 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. description: 'The street of the physical postal address, synonyms: road, avenue, lane, boulevard, highway' TypeKeyNameVerboseDtoBusinessStateType: required: - name - technicalKey type: object 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 description: Named type uniquely identified by its technical key TypeKeyNameVerboseDtoCountryCode: required: - name - technicalKey type: object 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 description: Named type uniquely identified by its technical key TypeKeyNameVerboseDtoString: required: - name - technicalKey type: object properties: technicalKey: type: string description: Unique key of this type for reference name: type: string description: Name or denotation of this type description: Named type uniquely identified by its technical key securitySchemes: open_id_scheme: type: oauth2 flows: clientCredentials: tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token 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