openapi: 3.0.0 info: title: SAP API version: 1.0.0 servers: - url: http://localhost:8080 paths: /rfc/BUPA_PARTNER_CONTACT_SEARCH: post: tags: - BUBA_3 summary: 'SAP BP, BAPI: Search Business Partner for Telephone, E-Mail, Address' operationId: /rfc/BUPA_PARTNER_CONTACT_SEARCH requestBody: content: application/json: schema: properties: ADDRESS: type: object properties: NAME_FIRST: type: string maxLength: 25 description: First name in upper case for search help NAME_LAST: type: string maxLength: 25 description: Last name in upper-case for search help DEPARTMENT: type: string maxLength: 40 description: Department ROOMNUM_C: type: string maxLength: 10 description: Room or Appartment Number SORT1_P: type: string maxLength: 20 description: Search Term 1 SORT2_P: type: string maxLength: 20 description: Search Term 2 NAME1: type: string maxLength: 25 description: Name (field NAME1) in upper case for matchcode NAME2: type: string maxLength: 40 description: Name 2 CITY1: type: string maxLength: 25 description: City name in upper case for search help CITY2: type: string maxLength: 40 description: District POST_CODE1: type: string maxLength: 10 description: City postal code POST_CODE2: type: string maxLength: 10 description: PO Box postal code POST_CODE3: type: string maxLength: 10 description: Company postal code (for large customers) PO_BOX_LOC: type: string maxLength: 40 description: PO Box city STREET: type: string maxLength: 25 description: Street name in upper case for search help HOUSE_NUM1: type: string maxLength: 10 description: House Number HOUSE_NUM2: type: string maxLength: 10 description: House number supplement COUNTRY: type: string maxLength: 3 description: Country Key REGION: type: string maxLength: 3 description: Region (State, Province, County) SORT1: type: string maxLength: 20 description: Search Term 1 SORT2: type: string maxLength: 20 description: Search Term 2 PERSNUMBER: type: string maxLength: 10 description: Person number ADDRNUMBER: type: string maxLength: 10 description: Address number BUSINESSPARTNER: type: string maxLength: 10 description: Internet Mail (SMTP) Address Search Field E_MAIL: type: string maxLength: 241 description: Internet Mail (SMTP) Address Search Field TELEPHONE: type: string maxLength: 30 description: Telephone number for determining caller COMPANIES: type: array items: type: object properties: BUSINESSPARTNER: type: string maxLength: 10 description: Business Partner Number ADDRNUMBER: type: string maxLength: 10 description: Address number ADDRHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) NATION: type: string maxLength: 1 description: International address version ID DATE: type: string format: date description: Date referred to DATE_FROM: type: string format: date description: Valid-from date - in current Release only 00010101 possible DATE_TO: type: string format: date description: Valid-to date in current Release only 99991231 possible TITLE: type: string maxLength: 4 description: Form-of-Address Key NAME1: type: string maxLength: 40 description: Name 1 NAME2: type: string maxLength: 40 description: Name 2 NAME3: type: string maxLength: 40 description: Name 3 NAME4: type: string maxLength: 40 description: Name 4 NAME_TXT: type: string maxLength: 50 description: Converted name field (with form of address) NAME_CO: type: string maxLength: 40 description: c/o name CITY1: type: string maxLength: 40 description: City CITY2: type: string maxLength: 40 description: District CITY_CODE: type: string maxLength: 12 description: City code for city/street file CITYP_CODE: type: string maxLength: 8 description: District code for City and Street file HOME_CITY: type: string maxLength: 40 description: City (different from postal city) CITYH_CODE: type: string maxLength: 12 description: Different city for city/street file CHCKSTATUS: type: string maxLength: 1 description: 'City file test status enumValues: C=checked against city index,D=differs from city index,""=Not checked' enum: - C - D - '' REGIOGROUP: type: string maxLength: 8 description: Regional structure grouping POST_CODE1: type: string maxLength: 10 description: City postal code POST_CODE2: type: string maxLength: 10 description: PO Box postal code POST_CODE3: type: string maxLength: 10 description: Company postal code (for large customers) PCODE1_EXT: type: string maxLength: 10 description: (Not Supported)City Postal Code Extension, e.g. ZIP+4+2 Code PCODE2_EXT: type: string maxLength: 10 description: (Not Supported) PO Box Postal Code Extension PCODE3_EXT: type: string maxLength: 10 description: (Not Supported) Major Customer Postal Code Extension PO_BOX: type: string maxLength: 10 description: PO Box DONT_USE_P: type: string maxLength: 4 description: PO Box Address Undeliverable Flag PO_BOX_NUM: type: string maxLength: 1 description: 'Flag: PO Box without number enumValues: ""=No,X=Yes' enum: - '' - X PO_BOX_LOC: type: string maxLength: 40 description: PO Box city CITY_CODE2: type: string maxLength: 12 description: City PO box code (City file) PO_BOX_REG: type: string maxLength: 3 description: Region for PO Box (Country, State, Province, ...) PO_BOX_CTY: type: string maxLength: 3 description: PO box country POSTALAREA: type: string maxLength: 15 description: (Not Supported) Post Delivery District TRANSPZONE: type: string maxLength: 10 description: Transportation zone to or from which the goods are delivered STREET: type: string maxLength: 60 description: Street DONT_USE_S: type: string maxLength: 4 description: Street Address Undeliverable Flag STREETCODE: type: string maxLength: 12 description: Street Number for City/Street File STREETABBR: type: string maxLength: 2 description: (Not Supported) Abbreviation of Street Name HOUSE_NUM1: type: string maxLength: 10 description: House Number HOUSE_NUM2: type: string maxLength: 10 description: House number supplement HOUSE_NUM3: type: string maxLength: 10 description: (Not supported) House Number Range STR_SUPPL1: type: string maxLength: 40 description: Street 2 STR_SUPPL2: type: string maxLength: 40 description: Street 3 STR_SUPPL3: type: string maxLength: 40 description: Street 4 LOCATION: type: string maxLength: 40 description: Street 5 BUILDING: type: string maxLength: 20 description: Building (Number or Code) FLOOR: type: string maxLength: 10 description: Floor in building ROOMNUMBER: type: string maxLength: 10 description: Room or Appartment Number COUNTRY: type: string maxLength: 3 description: Country Key LANGU: type: string maxLength: 1 description: Language Key REGION: type: string maxLength: 3 description: Region (State, Province, County) SORT1: type: string maxLength: 20 description: Search Term 1 SORT2: type: string maxLength: 20 description: Search Term 2 SORT_PHN: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field ADDRORIGIN: type: string maxLength: 4 description: (Not Supported) Address Data Source (Key) EXTENSION1: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. data line) EXTENSION2: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. telebox) TIME_ZONE: type: string maxLength: 6 description: Address time zone TAXJURCODE: type: string maxLength: 15 description: Tax Jurisdiction ADDRESS_ID: type: string maxLength: 10 description: (Not supported) Physical address ID REMARK: type: string maxLength: 50 description: Address notes LANGU_CREA: type: string maxLength: 1 description: Address record creation original language DEFLT_COMM: type: string maxLength: 3 description: Communication Method (Key) (Business Address Services) TEL_NUMBER: type: string maxLength: 30 description: 'First telephone no.: dialling code+number' TEL_EXTENS: type: string maxLength: 10 description: 'First Telephone No.: Extension' FAX_NUMBER: type: string maxLength: 30 description: 'First fax no.: dialling code+number' FAX_EXTENS: type: string maxLength: 10 description: 'First fax no.: extension' ADDR_GROUP: type: string maxLength: 4 description: Address Group (Key) (Business Address Services) CONTACTS: type: array items: type: object properties: BUSINESSPARTNER: type: string maxLength: 10 description: Business Partner Number COMPANY: type: string maxLength: 10 description: Business Partner Number PERSNUMBER: type: string maxLength: 10 description: Person number ADDRNUMBER: type: string maxLength: 10 description: Address number ADDRHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) NATION: type: string maxLength: 1 description: International address version ID DATE: type: string format: date description: Date referred to PERSHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) DATE_FROM: type: string format: date description: Valid-from date - in current Release only 00010101 possible DATE_TO: type: string format: date description: Valid-to date in current Release only 99991231 possible SO_KEY: type: string maxLength: 10 description: SAP-Office key DEPARTMENT: type: string maxLength: 40 description: Department FUNCTION: type: string maxLength: 40 description: Function BUILDING_C: type: string maxLength: 10 description: Building (number or code) FLOOR_C: type: string maxLength: 10 description: Floor in building ROOMNUM_C: type: string maxLength: 10 description: Room or Appartment Number ID_CODE: type: string maxLength: 10 description: Short name for correspondence IH_MAIL: type: string maxLength: 10 description: Int. mail postal code SORT1_C: type: string maxLength: 20 description: (Not Supported) Search Term SORT2_C: type: string maxLength: 20 description: (Not Supported) Search Term SORT_PHN_C: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field TITLE_P: type: string maxLength: 4 description: Form-of-Address Key NAME_FIRST: type: string maxLength: 40 description: First name NAME_LAST: type: string maxLength: 40 description: Last name NAME2_P: type: string maxLength: 40 description: Name of person at birth NAMEMIDDLE: type: string maxLength: 40 description: Middle name or second forename of a person NAME_LAST2: type: string maxLength: 40 description: Second surname of a person NAME_TEXT: type: string maxLength: 80 description: Full Name of Person CONVERTED: type: string maxLength: 1 description: 'Status of Field ''Full Name'' NAME_TEXT enumValues: M=Maintained manually,""=Generated from the parts of the name,X=Converted from the previous release' enum: - M - '' - X TITLE_ACA1: type: string maxLength: 4 description: 'Academic Title: Key' TITLE_ACA2: type: string maxLength: 4 description: Second academic title (key) PREFIX1: type: string maxLength: 4 description: Name Prefix (Key) PREFIX2: type: string maxLength: 4 description: 2nd name prefix (key) TITLE_SPPL: type: string maxLength: 4 description: Name supplement, e.g. noble title (key) NICKNAME: type: string maxLength: 40 description: Nickname or name used INITIALS: type: string maxLength: 10 description: '"Middle Initial" or personal initials' NAMEFORMAT: type: string maxLength: 2 description: Name format NAMCOUNTRY: type: string maxLength: 3 description: Country for name format rule PROFESSION: type: string maxLength: 40 description: Profession SEX: type: string maxLength: 1 description: 'Gender key enumValues: 1=Male,2=Female,""=Gender not known' enum: - '1' - '2' - '' LANGU_P: type: string maxLength: 1 description: Language Key SORT1_P: type: string maxLength: 20 description: Search Term 1 SORT2_P: type: string maxLength: 20 description: Search Term 2 SORT_PHN_P: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field PERSORIGIN: type: string maxLength: 4 description: Personal data source (key) LANGU_CR_P: type: string maxLength: 1 description: Address record creation original language DEFLT_COMM: type: string maxLength: 3 description: Communication Method (Key) (Business Address Services) ADDR_COMP: type: string maxLength: 10 description: (not used) AD_COMP_HD: type: string maxLength: 140 description: 'First company address: internal ID if DB no. not yet issued' TITLE: type: string maxLength: 4 description: Form-of-Address Key NAME1: type: string maxLength: 40 description: Name 1 NAME2: type: string maxLength: 40 description: Name 2 NAME3: type: string maxLength: 40 description: Name 3 NAME4: type: string maxLength: 40 description: Name 4 NAME_TXT: type: string maxLength: 50 description: Converted name field (with form of address) NAME_CO: type: string maxLength: 40 description: c/o name CITY1: type: string maxLength: 40 description: City CITY2: type: string maxLength: 40 description: District CITY_CODE: type: string maxLength: 12 description: City code for city/street file CITYP_CODE: type: string maxLength: 8 description: District code for City and Street file HOME_CITY: type: string maxLength: 40 description: City (different from postal city) CITYH_CODE: type: string maxLength: 12 description: Different city for city/street file CHCKSTATUS: type: string maxLength: 1 description: 'City file test status enumValues: C=checked against city index,D=differs from city index,""=Not checked' enum: - C - D - '' REGIOGROUP: type: string maxLength: 8 description: Regional structure grouping POST_CODE1: type: string maxLength: 10 description: City postal code POST_CODE2: type: string maxLength: 10 description: PO Box postal code POST_CODE3: type: string maxLength: 10 description: Company postal code (for large customers) PCODE1_EXT: type: string maxLength: 10 description: (Not Supported)City Postal Code Extension, e.g. ZIP+4+2 Code PCODE2_EXT: type: string maxLength: 10 description: (Not Supported) PO Box Postal Code Extension PCODE3_EXT: type: string maxLength: 10 description: (Not Supported) Major Customer Postal Code Extension PO_BOX: type: string maxLength: 10 description: PO Box DONT_USE_P: type: string maxLength: 4 description: PO Box Address Undeliverable Flag PO_BOX_NUM: type: string maxLength: 1 description: 'Flag: PO Box without number enumValues: ""=No,X=Yes' enum: - '' - X PO_BOX_LOC: type: string maxLength: 40 description: PO Box city CITY_CODE2: type: string maxLength: 12 description: City PO box code (City file) PO_BOX_REG: type: string maxLength: 3 description: Region for PO Box (Country, State, Province, ...) PO_BOX_CTY: type: string maxLength: 3 description: PO box country POSTALAREA: type: string maxLength: 15 description: (Not Supported) Post Delivery District TRANSPZONE: type: string maxLength: 10 description: Transportation zone to or from which the goods are delivered STREET: type: string maxLength: 60 description: Street DONT_USE_S: type: string maxLength: 4 description: Street Address Undeliverable Flag STREETCODE: type: string maxLength: 12 description: Street Number for City/Street File STREETABBR: type: string maxLength: 2 description: (Not Supported) Abbreviation of Street Name HOUSE_NUM1: type: string maxLength: 10 description: House Number HOUSE_NUM2: type: string maxLength: 10 description: House number supplement HOUSE_NUM3: type: string maxLength: 10 description: (Not supported) House Number Range STR_SUPPL1: type: string maxLength: 40 description: Street 2 STR_SUPPL2: type: string maxLength: 40 description: Street 3 STR_SUPPL3: type: string maxLength: 40 description: Street 4 LOCATION: type: string maxLength: 40 description: Street 5 BUILDING: type: string maxLength: 20 description: Building (Number or Code) FLOOR: type: string maxLength: 10 description: Floor in building ROOMNUMBER: type: string maxLength: 10 description: Room or Appartment Number COUNTRY: type: string maxLength: 3 description: Country Key LANGU: type: string maxLength: 1 description: Language Key REGION: type: string maxLength: 3 description: Region (State, Province, County) SORT1: type: string maxLength: 20 description: Search Term 1 SORT2: type: string maxLength: 20 description: Search Term 2 SORT_PHN: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field ADDRORIGIN: type: string maxLength: 4 description: (Not Supported) Address Data Source (Key) EXTENSION1: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. data line) EXTENSION2: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. telebox) TIME_ZONE: type: string maxLength: 6 description: Address time zone TAXJURCODE: type: string maxLength: 15 description: Tax Jurisdiction ADDRESS_ID: type: string maxLength: 10 description: (Not supported) Physical address ID REMARK: type: string maxLength: 50 description: Address notes LANGU_CREA: type: string maxLength: 1 description: Address record creation original language TEL_NUMBER: type: string maxLength: 30 description: 'First telephone no.: dialling code+number' TEL_EXTENS: type: string maxLength: 10 description: 'First Telephone No.: Extension' FAX_NUMBER: type: string maxLength: 30 description: 'First fax no.: dialling code+number' FAX_EXTENS: type: string maxLength: 10 description: 'First fax no.: extension' TEL_NUMCMP: type: string maxLength: 30 description: 'First telephone no.: dialling code+number' TEL_EXTCMP: type: string maxLength: 10 description: 'First Telephone No.: Extension' FAX_NUMCMP: type: string maxLength: 30 description: 'First fax no.: dialling code+number' FAX_EXTCMP: type: string maxLength: 10 description: 'First fax no.: extension' PERS_GROUP: type: string maxLength: 4 description: Person Group (Key) (Business Address Services) ADDR_GROUP: type: string maxLength: 4 description: Address Group (Key) (Business Address Services) PERSONS: type: array items: type: object properties: BUSINESSPARTNER: type: string maxLength: 10 description: Business Partner Number PERSNUMBER: type: string maxLength: 10 description: Person number PERSHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) ADDRNUMBER: type: string maxLength: 10 description: Address number ADDRHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) NATION: type: string maxLength: 1 description: International address version ID DATE: type: string format: date description: Date referred to DATE_FROM: type: string format: date description: Valid-from date - in current Release only 00010101 possible DATE_TO: type: string format: date description: Valid-to date in current Release only 99991231 possible NAME_CO: type: string maxLength: 40 description: c/o name CITY1: type: string maxLength: 40 description: City CITY2: type: string maxLength: 40 description: District CITY_CODE: type: string maxLength: 12 description: City code for city/street file CITYP_CODE: type: string maxLength: 8 description: District code for City and Street file HOME_CITY: type: string maxLength: 40 description: City (different from postal city) CITYH_CODE: type: string maxLength: 12 description: Different city for city/street file CHCKSTATUS: type: string maxLength: 1 description: 'City file test status enumValues: C=checked against city index,D=differs from city index,""=Not checked' enum: - C - D - '' REGIOGROUP: type: string maxLength: 8 description: Regional structure grouping POST_CODE1: type: string maxLength: 10 description: City postal code POST_CODE2: type: string maxLength: 10 description: PO Box postal code POST_CODE3: type: string maxLength: 10 description: Company postal code (for large customers) PCODE1_EXT: type: string maxLength: 10 description: (Not Supported)City Postal Code Extension, e.g. ZIP+4+2 Code PCODE2_EXT: type: string maxLength: 10 description: (Not Supported) PO Box Postal Code Extension PCODE3_EXT: type: string maxLength: 10 description: (Not Supported) Major Customer Postal Code Extension PO_BOX: type: string maxLength: 10 description: PO Box DONT_USE_P: type: string maxLength: 4 description: PO Box Address Undeliverable Flag PO_BOX_NUM: type: string maxLength: 1 description: 'Flag: PO Box without number enumValues: ""=No,X=Yes' enum: - '' - X PO_BOX_LOC: type: string maxLength: 40 description: PO Box city CITY_CODE2: type: string maxLength: 12 description: City PO box code (City file) PO_BOX_REG: type: string maxLength: 3 description: Region for PO Box (Country, State, Province, ...) PO_BOX_CTY: type: string maxLength: 3 description: PO box country POSTALAREA: type: string maxLength: 15 description: (Not Supported) Post Delivery District TRANSPZONE: type: string maxLength: 10 description: Transportation zone to or from which the goods are delivered STREET: type: string maxLength: 60 description: Street DONT_USE_S: type: string maxLength: 4 description: Street Address Undeliverable Flag STREETCODE: type: string maxLength: 12 description: Street Number for City/Street File STREETABBR: type: string maxLength: 2 description: (Not Supported) Abbreviation of Street Name HOUSE_NUM1: type: string maxLength: 10 description: House Number HOUSE_NUM2: type: string maxLength: 10 description: House number supplement HOUSE_NUM3: type: string maxLength: 10 description: (Not supported) House Number Range STR_SUPPL1: type: string maxLength: 40 description: Street 2 STR_SUPPL2: type: string maxLength: 40 description: Street 3 STR_SUPPL3: type: string maxLength: 40 description: Street 4 LOCATION: type: string maxLength: 40 description: Street 5 BUILDING: type: string maxLength: 20 description: Building (Number or Code) FLOOR: type: string maxLength: 10 description: Floor in building ROOMNUMBER: type: string maxLength: 10 description: Room or Appartment Number COUNTRY: type: string maxLength: 3 description: Country Key LANGU: type: string maxLength: 1 description: Language Key REGION: type: string maxLength: 3 description: Region (State, Province, County) SORT1: type: string maxLength: 20 description: Search Term 1 SORT2: type: string maxLength: 20 description: Search Term 2 SORT_PHN: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field ADDRORIGIN: type: string maxLength: 4 description: (Not Supported) Address Data Source (Key) EXTENSION1: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. data line) EXTENSION2: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. telebox) TIME_ZONE: type: string maxLength: 6 description: Address time zone TAXJURCODE: type: string maxLength: 15 description: Tax Jurisdiction ADDRESS_ID: type: string maxLength: 10 description: (Not supported) Physical address ID REMARK: type: string maxLength: 50 description: Address notes LANGU_CREA: type: string maxLength: 1 description: Address record creation original language TITLE_P: type: string maxLength: 4 description: Form-of-Address Key NAME_FIRST: type: string maxLength: 40 description: First name NAME_LAST: type: string maxLength: 40 description: Last name NAME2_P: type: string maxLength: 40 description: Name of person at birth NAMEMIDDLE: type: string maxLength: 40 description: Middle name or second forename of a person NAME_LAST2: type: string maxLength: 40 description: Second surname of a person NAME_TEXT: type: string maxLength: 80 description: Full Name of Person CONVERTED: type: string maxLength: 1 description: 'Status of Field ''Full Name'' NAME_TEXT enumValues: M=Maintained manually,""=Generated from the parts of the name,X=Converted from the previous release' enum: - M - '' - X TITLE_ACA1: type: string maxLength: 4 description: 'Academic Title: Key' TITLE_ACA2: type: string maxLength: 4 description: Second academic title (key) PREFIX1: type: string maxLength: 4 description: Name Prefix (Key) PREFIX2: type: string maxLength: 4 description: 2nd name prefix (key) TITLE_SPPL: type: string maxLength: 4 description: Name supplement, e.g. noble title (key) NICKNAME: type: string maxLength: 40 description: Nickname or name used INITIALS: type: string maxLength: 10 description: '"Middle Initial" or personal initials' NAMEFORMAT: type: string maxLength: 2 description: Name format NAMCOUNTRY: type: string maxLength: 3 description: Country for name format rule PROFESSION: type: string maxLength: 40 description: Profession SEX: type: string maxLength: 1 description: 'Gender key enumValues: 1=Male,2=Female,""=Gender not known' enum: - '1' - '2' - '' LANGU_P: type: string maxLength: 1 description: Language Key SORT1_P: type: string maxLength: 20 description: Search Term 1 SORT2_P: type: string maxLength: 20 description: Search Term 2 SORT_PHN_P: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field PERSORIGIN: type: string maxLength: 4 description: Personal data source (key) LANGU_CR_P: type: string maxLength: 1 description: Address record creation original language SO_KEY: type: string maxLength: 10 description: SAP-Office key DEFLT_COMM: type: string maxLength: 3 description: Communication Method (Key) (Business Address Services) ADDR_PERS: type: string maxLength: 10 description: (not used) AD_PERS_HD: type: string maxLength: 140 description: 'First pers. address: internal key, if number not yet issued' TEL_NUMBER: type: string maxLength: 30 description: 'First telephone no.: dialling code+number' TEL_EXTENS: type: string maxLength: 10 description: 'First Telephone No.: Extension' FAX_NUMBER: type: string maxLength: 30 description: 'First fax no.: dialling code+number' FAX_EXTENS: type: string maxLength: 10 description: 'First fax no.: extension' PERS_GROUP: type: string maxLength: 4 description: Person Group (Key) (Business Address Services) ADDR_GROUP: type: string maxLength: 4 description: Address Group (Key) (Business Address Services) responses: '200': description: OK content: application/json: schema: properties: COMPANIES: type: array items: type: object properties: BUSINESSPARTNER: type: string maxLength: 10 description: Business Partner Number ADDRNUMBER: type: string maxLength: 10 description: Address number ADDRHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) NATION: type: string maxLength: 1 description: International address version ID DATE: type: string format: date description: Date referred to DATE_FROM: type: string format: date description: Valid-from date - in current Release only 00010101 possible DATE_TO: type: string format: date description: Valid-to date in current Release only 99991231 possible TITLE: type: string maxLength: 4 description: Form-of-Address Key NAME1: type: string maxLength: 40 description: Name 1 NAME2: type: string maxLength: 40 description: Name 2 NAME3: type: string maxLength: 40 description: Name 3 NAME4: type: string maxLength: 40 description: Name 4 NAME_TXT: type: string maxLength: 50 description: Converted name field (with form of address) NAME_CO: type: string maxLength: 40 description: c/o name CITY1: type: string maxLength: 40 description: City CITY2: type: string maxLength: 40 description: District CITY_CODE: type: string maxLength: 12 description: City code for city/street file CITYP_CODE: type: string maxLength: 8 description: District code for City and Street file HOME_CITY: type: string maxLength: 40 description: City (different from postal city) CITYH_CODE: type: string maxLength: 12 description: Different city for city/street file CHCKSTATUS: type: string maxLength: 1 description: 'City file test status enumValues: C=checked against city index,D=differs from city index,""=Not checked' enum: - C - D - '' REGIOGROUP: type: string maxLength: 8 description: Regional structure grouping POST_CODE1: type: string maxLength: 10 description: City postal code POST_CODE2: type: string maxLength: 10 description: PO Box postal code POST_CODE3: type: string maxLength: 10 description: Company postal code (for large customers) PCODE1_EXT: type: string maxLength: 10 description: (Not Supported)City Postal Code Extension, e.g. ZIP+4+2 Code PCODE2_EXT: type: string maxLength: 10 description: (Not Supported) PO Box Postal Code Extension PCODE3_EXT: type: string maxLength: 10 description: (Not Supported) Major Customer Postal Code Extension PO_BOX: type: string maxLength: 10 description: PO Box DONT_USE_P: type: string maxLength: 4 description: PO Box Address Undeliverable Flag PO_BOX_NUM: type: string maxLength: 1 description: 'Flag: PO Box without number enumValues: ""=No,X=Yes' enum: - '' - X PO_BOX_LOC: type: string maxLength: 40 description: PO Box city CITY_CODE2: type: string maxLength: 12 description: City PO box code (City file) PO_BOX_REG: type: string maxLength: 3 description: Region for PO Box (Country, State, Province, ...) PO_BOX_CTY: type: string maxLength: 3 description: PO box country POSTALAREA: type: string maxLength: 15 description: (Not Supported) Post Delivery District TRANSPZONE: type: string maxLength: 10 description: Transportation zone to or from which the goods are delivered STREET: type: string maxLength: 60 description: Street DONT_USE_S: type: string maxLength: 4 description: Street Address Undeliverable Flag STREETCODE: type: string maxLength: 12 description: Street Number for City/Street File STREETABBR: type: string maxLength: 2 description: (Not Supported) Abbreviation of Street Name HOUSE_NUM1: type: string maxLength: 10 description: House Number HOUSE_NUM2: type: string maxLength: 10 description: House number supplement HOUSE_NUM3: type: string maxLength: 10 description: (Not supported) House Number Range STR_SUPPL1: type: string maxLength: 40 description: Street 2 STR_SUPPL2: type: string maxLength: 40 description: Street 3 STR_SUPPL3: type: string maxLength: 40 description: Street 4 LOCATION: type: string maxLength: 40 description: Street 5 BUILDING: type: string maxLength: 20 description: Building (Number or Code) FLOOR: type: string maxLength: 10 description: Floor in building ROOMNUMBER: type: string maxLength: 10 description: Room or Appartment Number COUNTRY: type: string maxLength: 3 description: Country Key LANGU: type: string maxLength: 1 description: Language Key REGION: type: string maxLength: 3 description: Region (State, Province, County) SORT1: type: string maxLength: 20 description: Search Term 1 SORT2: type: string maxLength: 20 description: Search Term 2 SORT_PHN: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field ADDRORIGIN: type: string maxLength: 4 description: (Not Supported) Address Data Source (Key) EXTENSION1: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. data line) EXTENSION2: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. telebox) TIME_ZONE: type: string maxLength: 6 description: Address time zone TAXJURCODE: type: string maxLength: 15 description: Tax Jurisdiction ADDRESS_ID: type: string maxLength: 10 description: (Not supported) Physical address ID REMARK: type: string maxLength: 50 description: Address notes LANGU_CREA: type: string maxLength: 1 description: Address record creation original language DEFLT_COMM: type: string maxLength: 3 description: Communication Method (Key) (Business Address Services) TEL_NUMBER: type: string maxLength: 30 description: 'First telephone no.: dialling code+number' TEL_EXTENS: type: string maxLength: 10 description: 'First Telephone No.: Extension' FAX_NUMBER: type: string maxLength: 30 description: 'First fax no.: dialling code+number' FAX_EXTENS: type: string maxLength: 10 description: 'First fax no.: extension' ADDR_GROUP: type: string maxLength: 4 description: Address Group (Key) (Business Address Services) CONTACTS: type: array items: type: object properties: BUSINESSPARTNER: type: string maxLength: 10 description: Business Partner Number COMPANY: type: string maxLength: 10 description: Business Partner Number PERSNUMBER: type: string maxLength: 10 description: Person number ADDRNUMBER: type: string maxLength: 10 description: Address number ADDRHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) NATION: type: string maxLength: 1 description: International address version ID DATE: type: string format: date description: Date referred to PERSHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) DATE_FROM: type: string format: date description: Valid-from date - in current Release only 00010101 possible DATE_TO: type: string format: date description: Valid-to date in current Release only 99991231 possible SO_KEY: type: string maxLength: 10 description: SAP-Office key DEPARTMENT: type: string maxLength: 40 description: Department FUNCTION: type: string maxLength: 40 description: Function BUILDING_C: type: string maxLength: 10 description: Building (number or code) FLOOR_C: type: string maxLength: 10 description: Floor in building ROOMNUM_C: type: string maxLength: 10 description: Room or Appartment Number ID_CODE: type: string maxLength: 10 description: Short name for correspondence IH_MAIL: type: string maxLength: 10 description: Int. mail postal code SORT1_C: type: string maxLength: 20 description: (Not Supported) Search Term SORT2_C: type: string maxLength: 20 description: (Not Supported) Search Term SORT_PHN_C: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field TITLE_P: type: string maxLength: 4 description: Form-of-Address Key NAME_FIRST: type: string maxLength: 40 description: First name NAME_LAST: type: string maxLength: 40 description: Last name NAME2_P: type: string maxLength: 40 description: Name of person at birth NAMEMIDDLE: type: string maxLength: 40 description: Middle name or second forename of a person NAME_LAST2: type: string maxLength: 40 description: Second surname of a person NAME_TEXT: type: string maxLength: 80 description: Full Name of Person CONVERTED: type: string maxLength: 1 description: 'Status of Field ''Full Name'' NAME_TEXT enumValues: M=Maintained manually,""=Generated from the parts of the name,X=Converted from the previous release' enum: - M - '' - X TITLE_ACA1: type: string maxLength: 4 description: 'Academic Title: Key' TITLE_ACA2: type: string maxLength: 4 description: Second academic title (key) PREFIX1: type: string maxLength: 4 description: Name Prefix (Key) PREFIX2: type: string maxLength: 4 description: 2nd name prefix (key) TITLE_SPPL: type: string maxLength: 4 description: Name supplement, e.g. noble title (key) NICKNAME: type: string maxLength: 40 description: Nickname or name used INITIALS: type: string maxLength: 10 description: '"Middle Initial" or personal initials' NAMEFORMAT: type: string maxLength: 2 description: Name format NAMCOUNTRY: type: string maxLength: 3 description: Country for name format rule PROFESSION: type: string maxLength: 40 description: Profession SEX: type: string maxLength: 1 description: 'Gender key enumValues: 1=Male,2=Female,""=Gender not known' enum: - '1' - '2' - '' LANGU_P: type: string maxLength: 1 description: Language Key SORT1_P: type: string maxLength: 20 description: Search Term 1 SORT2_P: type: string maxLength: 20 description: Search Term 2 SORT_PHN_P: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field PERSORIGIN: type: string maxLength: 4 description: Personal data source (key) LANGU_CR_P: type: string maxLength: 1 description: Address record creation original language DEFLT_COMM: type: string maxLength: 3 description: Communication Method (Key) (Business Address Services) ADDR_COMP: type: string maxLength: 10 description: (not used) AD_COMP_HD: type: string maxLength: 140 description: 'First company address: internal ID if DB no. not yet issued' TITLE: type: string maxLength: 4 description: Form-of-Address Key NAME1: type: string maxLength: 40 description: Name 1 NAME2: type: string maxLength: 40 description: Name 2 NAME3: type: string maxLength: 40 description: Name 3 NAME4: type: string maxLength: 40 description: Name 4 NAME_TXT: type: string maxLength: 50 description: Converted name field (with form of address) NAME_CO: type: string maxLength: 40 description: c/o name CITY1: type: string maxLength: 40 description: City CITY2: type: string maxLength: 40 description: District CITY_CODE: type: string maxLength: 12 description: City code for city/street file CITYP_CODE: type: string maxLength: 8 description: District code for City and Street file HOME_CITY: type: string maxLength: 40 description: City (different from postal city) CITYH_CODE: type: string maxLength: 12 description: Different city for city/street file CHCKSTATUS: type: string maxLength: 1 description: 'City file test status enumValues: C=checked against city index,D=differs from city index,""=Not checked' enum: - C - D - '' REGIOGROUP: type: string maxLength: 8 description: Regional structure grouping POST_CODE1: type: string maxLength: 10 description: City postal code POST_CODE2: type: string maxLength: 10 description: PO Box postal code POST_CODE3: type: string maxLength: 10 description: Company postal code (for large customers) PCODE1_EXT: type: string maxLength: 10 description: (Not Supported)City Postal Code Extension, e.g. ZIP+4+2 Code PCODE2_EXT: type: string maxLength: 10 description: (Not Supported) PO Box Postal Code Extension PCODE3_EXT: type: string maxLength: 10 description: (Not Supported) Major Customer Postal Code Extension PO_BOX: type: string maxLength: 10 description: PO Box DONT_USE_P: type: string maxLength: 4 description: PO Box Address Undeliverable Flag PO_BOX_NUM: type: string maxLength: 1 description: 'Flag: PO Box without number enumValues: ""=No,X=Yes' enum: - '' - X PO_BOX_LOC: type: string maxLength: 40 description: PO Box city CITY_CODE2: type: string maxLength: 12 description: City PO box code (City file) PO_BOX_REG: type: string maxLength: 3 description: Region for PO Box (Country, State, Province, ...) PO_BOX_CTY: type: string maxLength: 3 description: PO box country POSTALAREA: type: string maxLength: 15 description: (Not Supported) Post Delivery District TRANSPZONE: type: string maxLength: 10 description: Transportation zone to or from which the goods are delivered STREET: type: string maxLength: 60 description: Street DONT_USE_S: type: string maxLength: 4 description: Street Address Undeliverable Flag STREETCODE: type: string maxLength: 12 description: Street Number for City/Street File STREETABBR: type: string maxLength: 2 description: (Not Supported) Abbreviation of Street Name HOUSE_NUM1: type: string maxLength: 10 description: House Number HOUSE_NUM2: type: string maxLength: 10 description: House number supplement HOUSE_NUM3: type: string maxLength: 10 description: (Not supported) House Number Range STR_SUPPL1: type: string maxLength: 40 description: Street 2 STR_SUPPL2: type: string maxLength: 40 description: Street 3 STR_SUPPL3: type: string maxLength: 40 description: Street 4 LOCATION: type: string maxLength: 40 description: Street 5 BUILDING: type: string maxLength: 20 description: Building (Number or Code) FLOOR: type: string maxLength: 10 description: Floor in building ROOMNUMBER: type: string maxLength: 10 description: Room or Appartment Number COUNTRY: type: string maxLength: 3 description: Country Key LANGU: type: string maxLength: 1 description: Language Key REGION: type: string maxLength: 3 description: Region (State, Province, County) SORT1: type: string maxLength: 20 description: Search Term 1 SORT2: type: string maxLength: 20 description: Search Term 2 SORT_PHN: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field ADDRORIGIN: type: string maxLength: 4 description: (Not Supported) Address Data Source (Key) EXTENSION1: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. data line) EXTENSION2: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. telebox) TIME_ZONE: type: string maxLength: 6 description: Address time zone TAXJURCODE: type: string maxLength: 15 description: Tax Jurisdiction ADDRESS_ID: type: string maxLength: 10 description: (Not supported) Physical address ID REMARK: type: string maxLength: 50 description: Address notes LANGU_CREA: type: string maxLength: 1 description: Address record creation original language TEL_NUMBER: type: string maxLength: 30 description: 'First telephone no.: dialling code+number' TEL_EXTENS: type: string maxLength: 10 description: 'First Telephone No.: Extension' FAX_NUMBER: type: string maxLength: 30 description: 'First fax no.: dialling code+number' FAX_EXTENS: type: string maxLength: 10 description: 'First fax no.: extension' TEL_NUMCMP: type: string maxLength: 30 description: 'First telephone no.: dialling code+number' TEL_EXTCMP: type: string maxLength: 10 description: 'First Telephone No.: Extension' FAX_NUMCMP: type: string maxLength: 30 description: 'First fax no.: dialling code+number' FAX_EXTCMP: type: string maxLength: 10 description: 'First fax no.: extension' PERS_GROUP: type: string maxLength: 4 description: Person Group (Key) (Business Address Services) ADDR_GROUP: type: string maxLength: 4 description: Address Group (Key) (Business Address Services) PERSONS: type: array items: type: object properties: BUSINESSPARTNER: type: string maxLength: 10 description: Business Partner Number PERSNUMBER: type: string maxLength: 10 description: Person number PERSHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) ADDRNUMBER: type: string maxLength: 10 description: Address number ADDRHANDLE: type: string maxLength: 140 description: Handle for Creating Addresses/Persons (Bus. Addr. Services) NATION: type: string maxLength: 1 description: International address version ID DATE: type: string format: date description: Date referred to DATE_FROM: type: string format: date description: Valid-from date - in current Release only 00010101 possible DATE_TO: type: string format: date description: Valid-to date in current Release only 99991231 possible NAME_CO: type: string maxLength: 40 description: c/o name CITY1: type: string maxLength: 40 description: City CITY2: type: string maxLength: 40 description: District CITY_CODE: type: string maxLength: 12 description: City code for city/street file CITYP_CODE: type: string maxLength: 8 description: District code for City and Street file HOME_CITY: type: string maxLength: 40 description: City (different from postal city) CITYH_CODE: type: string maxLength: 12 description: Different city for city/street file CHCKSTATUS: type: string maxLength: 1 description: 'City file test status enumValues: C=checked against city index,D=differs from city index,""=Not checked' enum: - C - D - '' REGIOGROUP: type: string maxLength: 8 description: Regional structure grouping POST_CODE1: type: string maxLength: 10 description: City postal code POST_CODE2: type: string maxLength: 10 description: PO Box postal code POST_CODE3: type: string maxLength: 10 description: Company postal code (for large customers) PCODE1_EXT: type: string maxLength: 10 description: (Not Supported)City Postal Code Extension, e.g. ZIP+4+2 Code PCODE2_EXT: type: string maxLength: 10 description: (Not Supported) PO Box Postal Code Extension PCODE3_EXT: type: string maxLength: 10 description: (Not Supported) Major Customer Postal Code Extension PO_BOX: type: string maxLength: 10 description: PO Box DONT_USE_P: type: string maxLength: 4 description: PO Box Address Undeliverable Flag PO_BOX_NUM: type: string maxLength: 1 description: 'Flag: PO Box without number enumValues: ""=No,X=Yes' enum: - '' - X PO_BOX_LOC: type: string maxLength: 40 description: PO Box city CITY_CODE2: type: string maxLength: 12 description: City PO box code (City file) PO_BOX_REG: type: string maxLength: 3 description: Region for PO Box (Country, State, Province, ...) PO_BOX_CTY: type: string maxLength: 3 description: PO box country POSTALAREA: type: string maxLength: 15 description: (Not Supported) Post Delivery District TRANSPZONE: type: string maxLength: 10 description: Transportation zone to or from which the goods are delivered STREET: type: string maxLength: 60 description: Street DONT_USE_S: type: string maxLength: 4 description: Street Address Undeliverable Flag STREETCODE: type: string maxLength: 12 description: Street Number for City/Street File STREETABBR: type: string maxLength: 2 description: (Not Supported) Abbreviation of Street Name HOUSE_NUM1: type: string maxLength: 10 description: House Number HOUSE_NUM2: type: string maxLength: 10 description: House number supplement HOUSE_NUM3: type: string maxLength: 10 description: (Not supported) House Number Range STR_SUPPL1: type: string maxLength: 40 description: Street 2 STR_SUPPL2: type: string maxLength: 40 description: Street 3 STR_SUPPL3: type: string maxLength: 40 description: Street 4 LOCATION: type: string maxLength: 40 description: Street 5 BUILDING: type: string maxLength: 20 description: Building (Number or Code) FLOOR: type: string maxLength: 10 description: Floor in building ROOMNUMBER: type: string maxLength: 10 description: Room or Appartment Number COUNTRY: type: string maxLength: 3 description: Country Key LANGU: type: string maxLength: 1 description: Language Key REGION: type: string maxLength: 3 description: Region (State, Province, County) SORT1: type: string maxLength: 20 description: Search Term 1 SORT2: type: string maxLength: 20 description: Search Term 2 SORT_PHN: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field ADDRORIGIN: type: string maxLength: 4 description: (Not Supported) Address Data Source (Key) EXTENSION1: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. data line) EXTENSION2: type: string maxLength: 40 description: Extension (only for data conversion) (e.g. telebox) TIME_ZONE: type: string maxLength: 6 description: Address time zone TAXJURCODE: type: string maxLength: 15 description: Tax Jurisdiction ADDRESS_ID: type: string maxLength: 10 description: (Not supported) Physical address ID REMARK: type: string maxLength: 50 description: Address notes LANGU_CREA: type: string maxLength: 1 description: Address record creation original language TITLE_P: type: string maxLength: 4 description: Form-of-Address Key NAME_FIRST: type: string maxLength: 40 description: First name NAME_LAST: type: string maxLength: 40 description: Last name NAME2_P: type: string maxLength: 40 description: Name of person at birth NAMEMIDDLE: type: string maxLength: 40 description: Middle name or second forename of a person NAME_LAST2: type: string maxLength: 40 description: Second surname of a person NAME_TEXT: type: string maxLength: 80 description: Full Name of Person CONVERTED: type: string maxLength: 1 description: 'Status of Field ''Full Name'' NAME_TEXT enumValues: M=Maintained manually,""=Generated from the parts of the name,X=Converted from the previous release' enum: - M - '' - X TITLE_ACA1: type: string maxLength: 4 description: 'Academic Title: Key' TITLE_ACA2: type: string maxLength: 4 description: Second academic title (key) PREFIX1: type: string maxLength: 4 description: Name Prefix (Key) PREFIX2: type: string maxLength: 4 description: 2nd name prefix (key) TITLE_SPPL: type: string maxLength: 4 description: Name supplement, e.g. noble title (key) NICKNAME: type: string maxLength: 40 description: Nickname or name used INITIALS: type: string maxLength: 10 description: '"Middle Initial" or personal initials' NAMEFORMAT: type: string maxLength: 2 description: Name format NAMCOUNTRY: type: string maxLength: 3 description: Country for name format rule PROFESSION: type: string maxLength: 40 description: Profession SEX: type: string maxLength: 1 description: 'Gender key enumValues: 1=Male,2=Female,""=Gender not known' enum: - '1' - '2' - '' LANGU_P: type: string maxLength: 1 description: Language Key SORT1_P: type: string maxLength: 20 description: Search Term 1 SORT2_P: type: string maxLength: 20 description: Search Term 2 SORT_PHN_P: type: string maxLength: 20 description: (Not Supported) Phonetic Search Sort Field PERSORIGIN: type: string maxLength: 4 description: Personal data source (key) LANGU_CR_P: type: string maxLength: 1 description: Address record creation original language SO_KEY: type: string maxLength: 10 description: SAP-Office key DEFLT_COMM: type: string maxLength: 3 description: Communication Method (Key) (Business Address Services) ADDR_PERS: type: string maxLength: 10 description: (not used) AD_PERS_HD: type: string maxLength: 140 description: 'First pers. address: internal key, if number not yet issued' TEL_NUMBER: type: string maxLength: 30 description: 'First telephone no.: dialling code+number' TEL_EXTENS: type: string maxLength: 10 description: 'First Telephone No.: Extension' FAX_NUMBER: type: string maxLength: 30 description: 'First fax no.: dialling code+number' FAX_EXTENS: type: string maxLength: 10 description: 'First fax no.: extension' PERS_GROUP: type: string maxLength: 4 description: Person Group (Key) (Business Address Services) ADDR_GROUP: type: string maxLength: 4 description: Address Group (Key) (Business Address Services) RETURN: type: array items: type: object properties: TYPE: type: string maxLength: 1 description: 'Message type: S Success, E Error, W Warning, I Info, A Abort' ID: type: string maxLength: 20 description: Message Class NUMBER: type: integer format: int64 description: Message Number MESSAGE: type: string maxLength: 220 description: Message Text LOG_NO: type: string maxLength: 20 description: 'Application log: log number' LOG_MSG_NO: type: integer format: int64 description: 'Application log: Internal message serial number' MESSAGE_V1: type: string maxLength: 50 description: Message Variable MESSAGE_V2: type: string maxLength: 50 description: Message Variable MESSAGE_V3: type: string maxLength: 50 description: Message Variable MESSAGE_V4: type: string maxLength: 50 description: Message Variable PARAMETER: type: string maxLength: 32 description: Parameter Name ROW: type: integer format: int32 description: Lines in parameter FIELD: type: string maxLength: 30 description: Field in parameter SYSTEM: type: string maxLength: 10 description: Logical system from which message originates '400': description: Bad request. 5XX: description: Unexpected error.