> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
> Use this file to discover all available pages before exploring further.
# sap-s4hana-business-partner
> SAP S/4HANA Business Partner
**Server path:** `/sap-s4hana-business-partner` | **Type:** Application | **PCID required:** Yes
## Tools
| Tool | Description |
| ----------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| [`sap_s4hana_business_partner_create_bprelationship`](#sap_s4hana_business_partner_create_bprelationship) | Creates new business partner relationship data. |
| [`sap_s4hana_business_partner_create_business_partner`](#sap_s4hana_business_partner_create_business_partner) | Creates a new business partner record. |
| [`sap_s4hana_business_partner_create_business_partner_address`](#sap_s4hana_business_partner_create_business_partner_address) | Creates a new address data for an existing business partner. |
| [`sap_s4hana_business_partner_create_business_partner_bank`](#sap_s4hana_business_partner_create_business_partner_bank) | Creates new business partner bank data. |
| [`sap_s4hana_business_partner_create_business_partner_contact`](#sap_s4hana_business_partner_create_business_partner_contact) | Creates new business partner contact relationship data of type 'BUR001' |
| [`sap_s4hana_business_partner_create_business_partner_role`](#sap_s4hana_business_partner_create_business_partner_role) | Creates a new role for an existing business partner. |
| [`sap_s4hana_business_partner_create_business_partner_tax_number`](#sap_s4hana_business_partner_create_business_partner_tax_number) | Creates a new tax number data. |
| [`sap_s4hana_business_partner_delete_address`](#sap_s4hana_business_partner_delete_address) | Deletes business partner address record identified by address ID and business partner number. |
| [`sap_s4hana_business_partner_delete_bank`](#sap_s4hana_business_partner_delete_bank) | Deletes business partner bank data. |
| [`sap_s4hana_business_partner_delete_bprelationship`](#sap_s4hana_business_partner_delete_bprelationship) | Removes the relationship assigned to the business partner by using the key fields. |
| [`sap_s4hana_business_partner_delete_contact`](#sap_s4hana_business_partner_delete_contact) | Removes the contact person relationship assigned to the business partner by using the key fields. |
| [`sap_s4hana_business_partner_delete_tax_number`](#sap_s4hana_business_partner_delete_tax_number) | Deletes tax number data linked to a business partner. |
| [`sap_s4hana_business_partner_get_address`](#sap_s4hana_business_partner_get_address) | Retrieves business partner address data by using the key field. |
| [`sap_s4hana_business_partner_get_bank`](#sap_s4hana_business_partner_get_bank) | Retrieves business partner bank data by using key fields. |
| [`sap_s4hana_business_partner_get_bprelationship`](#sap_s4hana_business_partner_get_bprelationship) | Retrieves business partner relationship data by using key fields. |
| [`sap_s4hana_business_partner_get_business_partner`](#sap_s4hana_business_partner_get_business_partner) | Retrieves business partner data by using business partner number. |
| [`sap_s4hana_business_partner_get_contact`](#sap_s4hana_business_partner_get_contact) | Retrieves business partner contact data by using key fields. |
| [`sap_s4hana_business_partner_get_customer`](#sap_s4hana_business_partner_get_customer) | Retrieves customer data by using customer number. |
| [`sap_s4hana_business_partner_get_role`](#sap_s4hana_business_partner_get_role) | Retrieves business partner role data using the key fields. |
| [`sap_s4hana_business_partner_get_supplier`](#sap_s4hana_business_partner_get_supplier) | Retrieves supplier general data by using supplier number. |
| [`sap_s4hana_business_partner_get_tax_number`](#sap_s4hana_business_partner_get_tax_number) | Retrieves business partner tax number data by using key fields. |
| [`sap_s4hana_business_partner_list_bprelationship`](#sap_s4hana_business_partner_list_bprelationship) | Retrieves business partner relationship data. |
| [`sap_s4hana_business_partner_list_business_partner`](#sap_s4hana_business_partner_list_business_partner) | Retrieves business partner general data. |
| [`sap_s4hana_business_partner_list_business_partner_address`](#sap_s4hana_business_partner_list_business_partner_address) | Retrieves business partner address data. |
| [`sap_s4hana_business_partner_list_business_partner_bank`](#sap_s4hana_business_partner_list_business_partner_bank) | Retrieves business partner bank data. |
| [`sap_s4hana_business_partner_list_business_partner_contact`](#sap_s4hana_business_partner_list_business_partner_contact) | Retrieves business partner contact data. |
| [`sap_s4hana_business_partner_list_business_partner_role`](#sap_s4hana_business_partner_list_business_partner_role) | Retrieves business partner role data. |
| [`sap_s4hana_business_partner_list_business_partner_tax_number`](#sap_s4hana_business_partner_list_business_partner_tax_number) | Retrieves business partner tax number data. |
| [`sap_s4hana_business_partner_list_customer`](#sap_s4hana_business_partner_list_customer) | Retrieves customer general data. |
| [`sap_s4hana_business_partner_list_supplier`](#sap_s4hana_business_partner_list_supplier) | Retrieves supplier general data. |
| [`sap_s4hana_business_partner_update_bprelationship`](#sap_s4hana_business_partner_update_bprelationship) | Updates business partner relationship data. |
| [`sap_s4hana_business_partner_update_business_partner`](#sap_s4hana_business_partner_update_business_partner) | Updates business partner general data. |
| [`sap_s4hana_business_partner_update_business_partner_address`](#sap_s4hana_business_partner_update_business_partner_address) | Updates business partner address data. |
| [`sap_s4hana_business_partner_update_business_partner_bank`](#sap_s4hana_business_partner_update_business_partner_bank) | Updates business partner bank data. |
| [`sap_s4hana_business_partner_update_business_partner_contact`](#sap_s4hana_business_partner_update_business_partner_contact) | Updates business partner contact data. |
| [`sap_s4hana_business_partner_update_business_partner_role`](#sap_s4hana_business_partner_update_business_partner_role) | Updates role data fields. |
| [`sap_s4hana_business_partner_update_business_partner_tax_number`](#sap_s4hana_business_partner_update_business_partner_tax_number) | Updates tax number data linked to a business partner. |
| [`sap_s4hana_business_partner_update_customer`](#sap_s4hana_business_partner_update_customer) | Updates customer general data. |
| [`sap_s4hana_business_partner_update_supplier`](#sap_s4hana_business_partner_update_supplier) | Updates supplier general data. |
***
## sap\_s4hana\_business\_partner\_create\_bprelationship
Creates new business partner relationship data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | -------------------------------------- |
| `BPRelationshipType` | string | No | — | Business partner relationship type |
| `BusinessPartner1` | string | Yes | — | Business Partner Number |
| `BusinessPartner2` | string | Yes | — | Business Partner Number |
| `IsStandardRelationship` | boolean | No | — | Standard Relationship |
| `RelationshipCategory` | string | No | — | Business Partner Relationship Category |
| `RelationshipNumber` | string | Yes | — | BP Relationship Number |
| `ValidityEndDate` | string | Yes | — | Validity Date (Valid To) |
| `ValidityStartDate` | string | No | — | Validity Date (Valid From) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BPRelationshipType": {
"type": "string",
"description": "Business partner relationship type"
},
"BusinessPartner1": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartner2": {
"type": "string",
"description": "Business Partner Number"
},
"IsStandardRelationship": {
"type": "boolean",
"description": "Standard Relationship"
},
"RelationshipCategory": {
"type": "string",
"description": "Business Partner Relationship Category"
},
"RelationshipNumber": {
"type": "string",
"description": "BP Relationship Number"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity Date (Valid To)"
},
"ValidityStartDate": {
"type": "string",
"description": "Validity Date (Valid From)"
}
},
"required": [
"PCID",
"BusinessPartner1",
"BusinessPartner2",
"RelationshipNumber",
"ValidityEndDate"
]
}
```
***
## sap\_s4hana\_business\_partner\_create\_business\_partner
Creates a new business partner record.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `AcademicTitle` | string | No | — | Academic Title: Key |
| `AdditionalLastName` | string | No | — | Other Last Name of a Person |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BirthDate` | string | No | — | Date of Birth of Business Partner |
| `BPDataControllerIsNotRequired` | boolean | No | — | BP: Data Controller Not Required |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BusinessPartnerBirthDateStatus` | string | No | — | Date of Birth: Status |
| `BusinessPartnerBirthName` | string | No | — | Name at birth of business partner |
| `BusinessPartnerBirthplaceName` | string | No | — | Birthplace of business partner |
| `BusinessPartnerCategory` | string | No | — | Business Partner Category |
| `BusinessPartnerDeathDate` | string | No | — | Date of death of business partner |
| `BusinessPartnerGrouping` | string | No | — | Business Partner Grouping |
| `BusinessPartnerIDByExtSystem` | string | No | — | Business Partner Number in External System |
| `BusinessPartnerIsBlocked` | boolean | No | — | Central Block for Business Partner |
| `BusinessPartnerOccupation` | string | No | — | Occupation/group |
| `BusinessPartnerPrintFormat` | string | No | — | Business Partner Print Format |
| `BusinessPartnerSupplementName` | string | No | — | Name supplement, e.g. noble title (key) |
| `BusinessPartnerType` | string | No | — | Business Partner Type |
| `BusPartMaritalStatus` | string | No | — | Marital Status of Business Partner |
| `BusPartNationality` | string | No | — | Bus Part Nationality |
| `CorrespondenceLanguage` | string | No | — | Business Partner: Correspondence Language |
| `FirstName` | string | No | — | First Name of Business Partner (Person) |
| `FormOfAddress` | string | No | — | Form-of-Address Key |
| `GenderCodeName` | string | No | — | Gender of Business Partner (Person) |
| `GroupBusinessPartnerName1` | string | No | — | Name 1 (group) |
| `GroupBusinessPartnerName2` | string | No | — | Name 2 (group) |
| `Industry` | string | No | — | The industry value |
| `Initials` | string | No | — | "Middle Initial" or personal initials |
| `InternationalLocationNumber1` | string | No | — | International location number (part 1) |
| `InternationalLocationNumber2` | string | No | — | International location number (Part 2) |
| `InternationalLocationNumber3` | string | No | — | Check digit for the international location number |
| `IsFemale` | boolean | No | — | Selection: Business partner is female |
| `IsMale` | boolean | No | — | Selection: Business partner is male |
| `IsMarkedForArchiving` | boolean | No | — | Central Archiving Flag |
| `IsNaturalPerson` | string | No | — | Business Partner Is a Natural Person Under the Tax Laws |
| `IsSexUnknown` | boolean | No | — | Selection: Sex of business partner is not known |
| `Language` | string | No | — | Business partner: Language |
| `LastName` | string | No | — | Last Name of Business Partner (Person) |
| `LastNamePrefix` | string | No | — | Name Prefix (Key) |
| `LastNameSecondPrefix` | string | No | — | 2nd name prefix (key) |
| `LegalForm` | string | No | — | BP: Legal form of organization |
| `MiddleName` | string | No | — | Middle Name or Second Forename of a Person |
| `NameCountry` | string | No | — | Country/Region for Name Format Rule |
| `NameFormat` | string | No | — | Name format |
| `NaturalPersonEmployerName` | string | No | — | Name of Employer of a Natural Person |
| `OrganizationBPName1` | string | No | — | Name 1 of organization |
| `OrganizationBPName2` | string | No | — | Name 2 of organization |
| `OrganizationBPName3` | string | No | — | Name 3 of organization |
| `OrganizationBPName4` | string | No | — | Name 4 of organization |
| `OrganizationFoundationDate` | string | No | — | Date organization founded |
| `OrganizationLiquidationDate` | string | No | — | Liquidation date of organization |
| `PersonFullName` | string | No | — | Person Full Name |
| `SearchTerm1` | string | No | — | Search Term 1 for Business Partner |
| `SearchTerm2` | string | No | — | Search Term 2 for Business Partner |
| `to_AddressIndependentEmail` | object | No | — | To Address Independent Email |
| `to_AddressIndependentFax` | object | No | — | To Address Independent Fax |
| `to_AddressIndependentMobile` | object | No | — | To Address Independent Mobile |
| `to_AddressIndependentPhone` | object | No | — | To Address Independent Phone |
| `to_AddressIndependentWebsite` | object | No | — | To Address Independent Website |
| `to_BPCreditWorthiness` | object | No | — | To BP Credit Worthiness |
| `to_BPDataController` | object | No | — | To BP Data Controller |
| `to_BPEmployment` | object | No | — | To BP Employment |
| `to_BPFinServicesReporting` | object | No | — | To BP Fin Services Reporting |
| `to_BPFiscalYearInformation` | object | No | — | To BP Fiscal Year Information |
| `to_BPRelationship` | object | No | — | To BP Relationship |
| `to_BuPaIdentification` | object | No | — | To Bu Pa Identification |
| `to_BuPaIndustry` | object | No | — | To Bu Pa Industry |
| `to_BusinessPartner` | object | No | — | To Business Partner |
| `to_BusinessPartnerAddress` | object | No | — | To Business Partner Address |
| `to_BusinessPartnerAlias` | object | No | — | To Business Partner Alias |
| `to_BusinessPartnerBank` | object | No | — | To Business Partner Bank |
| `to_BusinessPartnerContact` | object | No | — | To Business Partner Contact |
| `to_BusinessPartnerIsBank` | object | No | — | To Business Partner Is Bank |
| `to_BusinessPartnerRating` | object | No | — | To Business Partner Rating |
| `to_BusinessPartnerRole` | object | No | — | To Business Partner Role |
| `to_BusinessPartnerTax` | object | No | — | To Business Partner Tax |
| `to_BusPartAddrDepdntTaxNmbr` | object | No | — | To Bus Part Addr Depdnt Tax Nmbr |
| `to_Customer` | object | No | — | To Customer |
| `to_PaymentCard` | object | No | — | To Payment Card |
| `to_Supplier` | object | No | — | To Supplier |
| `TradingPartner` | string | No | — | Company ID of Trading Partner |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"AcademicTitle": {
"type": "string",
"description": "Academic Title: Key"
},
"AdditionalLastName": {
"type": "string",
"description": "Other Last Name of a Person"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BirthDate": {
"type": "string",
"description": "Date of Birth of Business Partner"
},
"BPDataControllerIsNotRequired": {
"type": "boolean",
"description": "BP: Data Controller Not Required"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartnerBirthDateStatus": {
"type": "string",
"description": "Date of Birth: Status"
},
"BusinessPartnerBirthName": {
"type": "string",
"description": "Name at birth of business partner"
},
"BusinessPartnerBirthplaceName": {
"type": "string",
"description": "Birthplace of business partner"
},
"BusinessPartnerCategory": {
"type": "string",
"description": "Business Partner Category"
},
"BusinessPartnerDeathDate": {
"type": "string",
"description": "Date of death of business partner"
},
"BusinessPartnerGrouping": {
"type": "string",
"description": "Business Partner Grouping"
},
"BusinessPartnerIDByExtSystem": {
"type": "string",
"description": "Business Partner Number in External System"
},
"BusinessPartnerIsBlocked": {
"type": "boolean",
"description": "Central Block for Business Partner"
},
"BusinessPartnerOccupation": {
"type": "string",
"description": "Occupation/group"
},
"BusinessPartnerPrintFormat": {
"type": "string",
"description": "Business Partner Print Format"
},
"BusinessPartnerSupplementName": {
"type": "string",
"description": "Name supplement, e.g. noble title (key)"
},
"BusinessPartnerType": {
"type": "string",
"description": "Business Partner Type"
},
"BusPartMaritalStatus": {
"type": "string",
"description": "Marital Status of Business Partner"
},
"BusPartNationality": {
"type": "string",
"description": "Bus Part Nationality"
},
"CorrespondenceLanguage": {
"type": "string",
"description": "Business Partner: Correspondence Language"
},
"FirstName": {
"type": "string",
"description": "First Name of Business Partner (Person)"
},
"FormOfAddress": {
"type": "string",
"description": "Form-of-Address Key"
},
"GenderCodeName": {
"type": "string",
"description": "Gender of Business Partner (Person)"
},
"GroupBusinessPartnerName1": {
"type": "string",
"description": "Name 1 (group)"
},
"GroupBusinessPartnerName2": {
"type": "string",
"description": "Name 2 (group)"
},
"Industry": {
"type": "string",
"description": "The industry value"
},
"Initials": {
"type": "string",
"description": "\"Middle Initial\" or personal initials"
},
"InternationalLocationNumber1": {
"type": "string",
"description": "International location number (part 1)"
},
"InternationalLocationNumber2": {
"type": "string",
"description": "International location number (Part 2)"
},
"InternationalLocationNumber3": {
"type": "string",
"description": "Check digit for the international location number"
},
"IsFemale": {
"type": "boolean",
"description": "Selection: Business partner is female"
},
"IsMale": {
"type": "boolean",
"description": "Selection: Business partner is male"
},
"IsMarkedForArchiving": {
"type": "boolean",
"description": "Central Archiving Flag"
},
"IsNaturalPerson": {
"type": "string",
"description": "Business Partner Is a Natural Person Under the Tax Laws"
},
"IsSexUnknown": {
"type": "boolean",
"description": "Selection: Sex of business partner is not known"
},
"Language": {
"type": "string",
"description": "Business partner: Language"
},
"LastName": {
"type": "string",
"description": "Last Name of Business Partner (Person)"
},
"LastNamePrefix": {
"type": "string",
"description": "Name Prefix (Key)"
},
"LastNameSecondPrefix": {
"type": "string",
"description": "2nd name prefix (key)"
},
"LegalForm": {
"type": "string",
"description": "BP: Legal form of organization"
},
"MiddleName": {
"type": "string",
"description": "Middle Name or Second Forename of a Person"
},
"NameCountry": {
"type": "string",
"description": "Country/Region for Name Format Rule"
},
"NameFormat": {
"type": "string",
"description": "Name format"
},
"NaturalPersonEmployerName": {
"type": "string",
"description": "Name of Employer of a Natural Person"
},
"OrganizationBPName1": {
"type": "string",
"description": "Name 1 of organization"
},
"OrganizationBPName2": {
"type": "string",
"description": "Name 2 of organization"
},
"OrganizationBPName3": {
"type": "string",
"description": "Name 3 of organization"
},
"OrganizationBPName4": {
"type": "string",
"description": "Name 4 of organization"
},
"OrganizationFoundationDate": {
"type": "string",
"description": "Date organization founded"
},
"OrganizationLiquidationDate": {
"type": "string",
"description": "Liquidation date of organization"
},
"PersonFullName": {
"type": "string",
"description": "Person Full Name"
},
"SearchTerm1": {
"type": "string",
"description": "Search Term 1 for Business Partner"
},
"SearchTerm2": {
"type": "string",
"description": "Search Term 2 for Business Partner"
},
"to_AddressIndependentEmail": {
"type": "object",
"description": "To Address Independent Email",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_AddressIndependentFax": {
"type": "object",
"description": "To Address Independent Fax",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_AddressIndependentMobile": {
"type": "object",
"description": "To Address Independent Mobile",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_AddressIndependentPhone": {
"type": "object",
"description": "To Address Independent Phone",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_AddressIndependentWebsite": {
"type": "object",
"description": "To Address Independent Website",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BPCreditWorthiness": {
"description": "To BP Credit Worthiness"
},
"to_BPDataController": {
"type": "object",
"description": "To BP Data Controller",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BPEmployment": {
"type": "object",
"description": "To BP Employment",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BPFinServicesReporting": {
"description": "To BP Fin Services Reporting"
},
"to_BPFiscalYearInformation": {
"type": "object",
"description": "To BP Fiscal Year Information",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BPRelationship": {
"type": "object",
"description": "To BP Relationship",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BuPaIdentification": {
"type": "object",
"description": "To Bu Pa Identification",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BuPaIndustry": {
"type": "object",
"description": "To Bu Pa Industry",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BusinessPartner": {
"description": "To Business Partner"
},
"to_BusinessPartnerAddress": {
"type": "object",
"description": "To Business Partner Address",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BusinessPartnerAlias": {
"type": "object",
"description": "To Business Partner Alias",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BusinessPartnerBank": {
"type": "object",
"description": "To Business Partner Bank",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BusinessPartnerContact": {
"type": "object",
"description": "To Business Partner Contact",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BusinessPartnerIsBank": {
"description": "To Business Partner Is Bank"
},
"to_BusinessPartnerRating": {
"type": "object",
"description": "To Business Partner Rating",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BusinessPartnerRole": {
"type": "object",
"description": "To Business Partner Role",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BusinessPartnerTax": {
"type": "object",
"description": "To Business Partner Tax",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BusPartAddrDepdntTaxNmbr": {
"type": "object",
"description": "To Bus Part Addr Depdnt Tax Nmbr",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_Customer": {
"description": "To Customer"
},
"to_PaymentCard": {
"type": "object",
"description": "To Payment Card",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_Supplier": {
"description": "To Supplier"
},
"TradingPartner": {
"type": "string",
"description": "Company ID of Trading Partner"
}
},
"required": [
"PCID",
"BusinessPartner"
]
}
```
***
## sap\_s4hana\_business\_partner\_create\_business\_partner\_address
Creates a new address data for an existing business partner.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------------ | ------- | -------- | ------- | ------------------------------------------------------------ |
| `AdditionalStreetPrefixName` | string | No | — | Additional Street Prefix Name |
| `AdditionalStreetSuffixName` | string | No | — | Additional Street Suffix Name |
| `AddressID` | string | Yes | — | Address ID |
| `AddressIDByExternalSystem` | string | No | — | Address number in external system |
| `AddressTimeZone` | string | No | — | Address Time Zone |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `Building` | string | No | — | Building (Number or Code) |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `CareOfName` | string | No | — | c/o name |
| `CityCode` | string | No | — | City code for city/street file |
| `CityName` | string | No | — | City Name |
| `CompanyPostalCode` | string | No | — | Company Postal Code (for Large Customers) |
| `Country` | string | No | — | The country value |
| `County` | string | No | — | The county value |
| `CountyCode` | string | No | — | County code for county |
| `DeliveryServiceNumber` | string | No | — | Number of Delivery Service |
| `DeliveryServiceTypeCode` | string | No | — | Type of Delivery Service |
| `District` | string | No | — | The district value |
| `Floor` | string | No | — | Floor in Building |
| `HomeCityName` | string | No | — | City (different from postal city) |
| `HouseNumber` | string | No | — | House Number |
| `HouseNumberSupplementText` | string | No | — | House number supplement |
| `Language` | string | No | — | The language value |
| `POBox` | string | No | — | PO Box |
| `POBoxDeviatingCityName` | string | No | — | PO Box city |
| `POBoxDeviatingCountry` | string | No | — | PO Box of Country/Region |
| `POBoxDeviatingRegion` | string | No | — | Region for PO Box (Country/Region, State, Province, ...) |
| `POBoxIsWithoutNumber` | boolean | No | — | Flag: PO Box Without Number |
| `POBoxLobbyName` | string | No | — | PO Box Lobby Name |
| `POBoxPostalCode` | string | No | — | PO Box Postal Code |
| `PostalCode` | string | No | — | City Postal Code |
| `PrfrdCommMediumType` | string | No | — | Communication Method (Key) (Business Address Services) |
| `Region` | string | No | — | Region (State, Province, County) |
| `RoomNumber` | string | No | — | Room or Apartment Number |
| `StreetName` | string | No | — | Street Name |
| `StreetPrefixName` | string | No | — | Street Prefix Name |
| `StreetSuffixName` | string | No | — | Street Suffix Name |
| `TaxJurisdiction` | string | No | — | Tax Jurisdiction |
| `to_AddressUsage` | object | No | — | To Address Usage |
| `to_BPAddrDepdntIntlLocNumber` | object | No | — | To BP Addr Depdnt Intl Loc Number |
| `to_BPIntlAddressVersion` | object | No | — | To BP Intl Address Version |
| `to_EmailAddress` | object | No | — | To Email Address |
| `to_FaxNumber` | object | No | — | To Fax Number |
| `to_MobilePhoneNumber` | object | No | — | To Mobile Phone Number |
| `to_PhoneNumber` | object | No | — | To Phone Number |
| `to_URLAddress` | object | No | — | To URL Address |
| `TownshipCode` | string | No | — | Township code for Township |
| `TownshipName` | string | No | — | Township Name |
| `TransportZone` | string | No | — | Transportation zone to or from which the goods are delivered |
| `ValidityEndDate` | string | No | — | Validity End of a Business Partner Address |
| `ValidityStartDate` | string | No | — | Validity Start of a Business Partner Address |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"AdditionalStreetPrefixName": {
"type": "string",
"description": "Additional Street Prefix Name"
},
"AdditionalStreetSuffixName": {
"type": "string",
"description": "Additional Street Suffix Name"
},
"AddressID": {
"type": "string",
"description": "Address ID"
},
"AddressIDByExternalSystem": {
"type": "string",
"description": "Address number in external system"
},
"AddressTimeZone": {
"type": "string",
"description": "Address Time Zone"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"Building": {
"type": "string",
"description": "Building (Number or Code)"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"CareOfName": {
"type": "string",
"description": "c/o name"
},
"CityCode": {
"type": "string",
"description": "City code for city/street file"
},
"CityName": {
"type": "string",
"description": "City Name"
},
"CompanyPostalCode": {
"type": "string",
"description": "Company Postal Code (for Large Customers)"
},
"Country": {
"type": "string",
"description": "The country value"
},
"County": {
"type": "string",
"description": "The county value"
},
"CountyCode": {
"type": "string",
"description": "County code for county"
},
"DeliveryServiceNumber": {
"type": "string",
"description": "Number of Delivery Service"
},
"DeliveryServiceTypeCode": {
"type": "string",
"description": "Type of Delivery Service"
},
"District": {
"type": "string",
"description": "The district value"
},
"Floor": {
"type": "string",
"description": "Floor in Building"
},
"HomeCityName": {
"type": "string",
"description": "City (different from postal city)"
},
"HouseNumber": {
"type": "string",
"description": "House Number"
},
"HouseNumberSupplementText": {
"type": "string",
"description": "House number supplement"
},
"Language": {
"type": "string",
"description": "The language value"
},
"POBox": {
"type": "string",
"description": "PO Box"
},
"POBoxDeviatingCityName": {
"type": "string",
"description": "PO Box city"
},
"POBoxDeviatingCountry": {
"type": "string",
"description": "PO Box of Country/Region"
},
"POBoxDeviatingRegion": {
"type": "string",
"description": "Region for PO Box (Country/Region, State, Province, ...)"
},
"POBoxIsWithoutNumber": {
"type": "boolean",
"description": "Flag: PO Box Without Number"
},
"POBoxLobbyName": {
"type": "string",
"description": "PO Box Lobby Name"
},
"POBoxPostalCode": {
"type": "string",
"description": "PO Box Postal Code"
},
"PostalCode": {
"type": "string",
"description": "City Postal Code"
},
"PrfrdCommMediumType": {
"type": "string",
"description": "Communication Method (Key) (Business Address Services)"
},
"Region": {
"type": "string",
"description": "Region (State, Province, County)"
},
"RoomNumber": {
"type": "string",
"description": "Room or Apartment Number"
},
"StreetName": {
"type": "string",
"description": "Street Name"
},
"StreetPrefixName": {
"type": "string",
"description": "Street Prefix Name"
},
"StreetSuffixName": {
"type": "string",
"description": "Street Suffix Name"
},
"TaxJurisdiction": {
"type": "string",
"description": "Tax Jurisdiction"
},
"to_AddressUsage": {
"type": "object",
"description": "To Address Usage",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_BPAddrDepdntIntlLocNumber": {
"description": "To BP Addr Depdnt Intl Loc Number"
},
"to_BPIntlAddressVersion": {
"type": "object",
"description": "To BP Intl Address Version",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_EmailAddress": {
"type": "object",
"description": "To Email Address",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_FaxNumber": {
"type": "object",
"description": "To Fax Number",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_MobilePhoneNumber": {
"type": "object",
"description": "To Mobile Phone Number",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_PhoneNumber": {
"type": "object",
"description": "To Phone Number",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_URLAddress": {
"type": "object",
"description": "To URL Address",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"TownshipCode": {
"type": "string",
"description": "Township code for Township"
},
"TownshipName": {
"type": "string",
"description": "Township Name"
},
"TransportZone": {
"type": "string",
"description": "Transportation zone to or from which the goods are delivered"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity End of a Business Partner Address"
},
"ValidityStartDate": {
"type": "string",
"description": "Validity Start of a Business Partner Address"
}
},
"required": [
"PCID",
"AddressID",
"BusinessPartner"
]
}
```
***
## sap\_s4hana\_business\_partner\_create\_business\_partner\_bank
Creates new business partner bank data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | ----------------------------------------------- |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BankAccount` | string | No | — | Bank Account Number |
| `BankAccountHolderName` | string | No | — | Account Holder Name |
| `BankAccountName` | string | No | — | Name of Bank Account |
| `BankAccountReferenceText` | string | No | — | Reference Details for Bank Details |
| `BankControlKey` | string | No | — | Bank Control Key |
| `BankCountryKey` | string | No | — | Bank Country/Region Key |
| `BankIdentification` | string | Yes | — | Bank Identification |
| `BankNumber` | string | No | — | Bank Number |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `CollectionAuthInd` | boolean | No | — | Indicator: Collection Authorization |
| `IBAN` | string | No | — | IBAN (International Bank Account Number) |
| `IBANValidityStartDate` | string | No | — | Validity Start of IBAN |
| `ValidityEndDate` | string | No | — | Validity End of Business Partner Bank Details |
| `ValidityStartDate` | string | No | — | Validity Start of Business Partner Bank Details |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BankAccount": {
"type": "string",
"description": "Bank Account Number"
},
"BankAccountHolderName": {
"type": "string",
"description": "Account Holder Name"
},
"BankAccountName": {
"type": "string",
"description": "Name of Bank Account"
},
"BankAccountReferenceText": {
"type": "string",
"description": "Reference Details for Bank Details"
},
"BankControlKey": {
"type": "string",
"description": "Bank Control Key"
},
"BankCountryKey": {
"type": "string",
"description": "Bank Country/Region Key"
},
"BankIdentification": {
"type": "string",
"description": "Bank Identification"
},
"BankNumber": {
"type": "string",
"description": "Bank Number"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"CollectionAuthInd": {
"type": "boolean",
"description": "Indicator: Collection Authorization"
},
"IBAN": {
"type": "string",
"description": "IBAN (International Bank Account Number)"
},
"IBANValidityStartDate": {
"type": "string",
"description": "Validity Start of IBAN"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity End of Business Partner Bank Details"
},
"ValidityStartDate": {
"type": "string",
"description": "Validity Start of Business Partner Bank Details"
}
},
"required": [
"PCID",
"BankIdentification",
"BusinessPartner"
]
}
```
***
## sap\_s4hana\_business\_partner\_create\_business\_partner\_contact
Creates new business partner contact relationship data of type 'BUR001'
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | -------------------------------------- |
| `BusinessPartnerCompany` | string | Yes | — | Business Partner Number |
| `BusinessPartnerPerson` | string | Yes | — | Business Partner Number |
| `IsStandardRelationship` | boolean | No | — | Standard Relationship |
| `RelationshipCategory` | string | No | — | Business Partner Relationship Category |
| `RelationshipNumber` | string | Yes | — | BP Relationship Number |
| `to_ContactAddress` | object | No | — | To Contact Address |
| `to_ContactRelationship` | object | No | — | To Contact Relationship |
| `ValidityEndDate` | string | Yes | — | Validity Date (Valid To) |
| `ValidityStartDate` | string | No | — | Validity Date (Valid From) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartnerCompany": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartnerPerson": {
"type": "string",
"description": "Business Partner Number"
},
"IsStandardRelationship": {
"type": "boolean",
"description": "Standard Relationship"
},
"RelationshipCategory": {
"type": "string",
"description": "Business Partner Relationship Category"
},
"RelationshipNumber": {
"type": "string",
"description": "BP Relationship Number"
},
"to_ContactAddress": {
"type": "object",
"description": "To Contact Address",
"properties": {
"results": {
"type": "array",
"items": {
"type": "object"
},
"description": "The results value"
}
}
},
"to_ContactRelationship": {
"description": "To Contact Relationship"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity Date (Valid To)"
},
"ValidityStartDate": {
"type": "string",
"description": "Validity Date (Valid From)"
}
},
"required": [
"PCID",
"BusinessPartnerCompany",
"BusinessPartnerPerson",
"RelationshipNumber",
"ValidityEndDate"
]
}
```
***
## sap\_s4hana\_business\_partner\_create\_business\_partner\_role
Creates a new role for an existing business partner.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | --------------------------- |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BusinessPartnerRole` | string | Yes | — | Business Partner Role |
| `ValidFrom` | string | No | — | Validity Start of a BP Role |
| `ValidTo` | string | No | — | Validity End of a BP Role |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartnerRole": {
"type": "string",
"description": "Business Partner Role"
},
"ValidFrom": {
"type": "string",
"description": "Validity Start of a BP Role"
},
"ValidTo": {
"type": "string",
"description": "Validity End of a BP Role"
}
},
"required": [
"PCID",
"BusinessPartner",
"BusinessPartnerRole"
]
}
```
***
## sap\_s4hana\_business\_partner\_create\_business\_partner\_tax\_number
Creates a new tax number data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | --------------------------- |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BPTaxLongNumber` | string | No | — | Business Partner Tax Number |
| `BPTaxNumber` | string | No | — | Business Partner Tax Number |
| `BPTaxType` | string | Yes | — | BP Tax Type |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BPTaxLongNumber": {
"type": "string",
"description": "Business Partner Tax Number"
},
"BPTaxNumber": {
"type": "string",
"description": "Business Partner Tax Number"
},
"BPTaxType": {
"type": "string",
"description": "BP Tax Type"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
}
},
"required": [
"PCID",
"BPTaxType",
"BusinessPartner"
]
}
```
***
## sap\_s4hana\_business\_partner\_delete\_address
Deletes business partner address record identified by address ID and business partner number.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ----------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `AddressID` | string | Yes | — | Address Number |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"AddressID": {
"type": "string",
"description": "Address Number"
}
},
"required": [
"PCID",
"BusinessPartner",
"AddressID"
]
}
```
***
## sap\_s4hana\_business\_partner\_delete\_bank
Deletes business partner bank data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | ----------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BankIdentification` | string | Yes | — | Bank Details ID |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BankIdentification": {
"type": "string",
"description": "Bank Details ID"
}
},
"required": [
"PCID",
"BusinessPartner",
"BankIdentification"
]
}
```
***
## sap\_s4hana\_business\_partner\_delete\_bprelationship
Removes the relationship assigned to the business partner by using the key fields.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | ------------------------ |
| `RelationshipNumber` | string | Yes | — | BP Relationship Number |
| `BusinessPartner1` | string | Yes | — | Business Partner Number |
| `BusinessPartner2` | string | Yes | — | Business Partner Number |
| `ValidityEndDate` | string | Yes | — | Validity Date (Valid To) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"RelationshipNumber": {
"type": "string",
"description": "BP Relationship Number"
},
"BusinessPartner1": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartner2": {
"type": "string",
"description": "Business Partner Number"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity Date (Valid To)"
}
},
"required": [
"PCID",
"RelationshipNumber",
"BusinessPartner1",
"BusinessPartner2",
"ValidityEndDate"
]
}
```
***
## sap\_s4hana\_business\_partner\_delete\_contact
Removes the contact person relationship assigned to the business partner by using the key fields.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------ | -------- | ------- | ------------------------ |
| `RelationshipNumber` | string | Yes | — | BP Relationship Number |
| `BusinessPartnerCompany` | string | Yes | — | Business Partner Number |
| `BusinessPartnerPerson` | string | Yes | — | Business Partner Number |
| `ValidityEndDate` | string | Yes | — | Validity Date (Valid To) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"RelationshipNumber": {
"type": "string",
"description": "BP Relationship Number"
},
"BusinessPartnerCompany": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartnerPerson": {
"type": "string",
"description": "Business Partner Number"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity Date (Valid To)"
}
},
"required": [
"PCID",
"RelationshipNumber",
"BusinessPartnerCompany",
"BusinessPartnerPerson",
"ValidityEndDate"
]
}
```
***
## sap\_s4hana\_business\_partner\_delete\_tax\_number
Deletes tax number data linked to a business partner.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | ------ | -------- | ------- | ----------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BPTaxType` | string | Yes | — | Tax Number Category |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BPTaxType": {
"type": "string",
"description": "Tax Number Category"
}
},
"required": [
"PCID",
"BusinessPartner",
"BPTaxType"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_address
Retrieves business partner address data by using the key field.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `AddressID` | string | Yes | — | Address Number |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"AddressID": {
"type": "string",
"description": "Address Number"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"AddressID",
"ValidityStartDate",
"ValidityEndDate",
"AuthorizationGroup",
"AddressUUID",
"AdditionalStreetPrefixName",
"AdditionalStreetSuffixName",
"AddressTimeZone",
"CareOfName",
"CityCode",
"CityName",
"CompanyPostalCode",
"Country",
"County",
"DeliveryServiceNumber",
"DeliveryServiceTypeCode",
"District",
"FormOfAddress",
"FullName",
"HomeCityName",
"HouseNumber",
"HouseNumberSupplementText",
"Language",
"POBox",
"POBoxDeviatingCityName",
"POBoxDeviatingCountry",
"POBoxDeviatingRegion",
"POBoxIsWithoutNumber",
"POBoxLobbyName",
"POBoxPostalCode",
"Person",
"PostalCode",
"PrfrdCommMediumType",
"Region",
"StreetName",
"StreetPrefixName",
"StreetSuffixName",
"TaxJurisdiction",
"TransportZone",
"AddressIDByExternalSystem",
"CountyCode",
"TownshipCode",
"TownshipName",
"Building",
"Floor",
"RoomNumber",
"to_AddressUsage",
"to_BPAddrDepdntIntlLocNumber",
"to_BPIntlAddressVersion",
"to_EmailAddress",
"to_FaxNumber",
"to_MobilePhoneNumber",
"to_PhoneNumber",
"to_URLAddress"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_AddressUsage",
"to_BPAddrDepdntIntlLocNumber",
"to_BPIntlAddressVersion",
"to_EmailAddress",
"to_FaxNumber",
"to_MobilePhoneNumber",
"to_PhoneNumber",
"to_URLAddress"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID",
"BusinessPartner",
"AddressID"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_bank
Retrieves business partner bank data by using key fields.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BankIdentification` | string | Yes | — | Bank Details ID |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BankIdentification": {
"type": "string",
"description": "Bank Details ID"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BankIdentification",
"BankCountryKey",
"BankName",
"BankNumber",
"SWIFTCode",
"BankControlKey",
"BankAccountHolderName",
"BankAccountName",
"ValidityStartDate",
"ValidityEndDate",
"IBAN",
"IBANValidityStartDate",
"BankAccount",
"BankAccountReferenceText",
"CollectionAuthInd",
"CityName",
"AuthorizationGroup"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
}
},
"required": [
"PCID",
"BusinessPartner",
"BankIdentification"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_bprelationship
Retrieves business partner relationship data by using key fields.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `RelationshipNumber` | string | Yes | — | BP Relationship Number |
| `BusinessPartner1` | string | Yes | — | Business Partner Number |
| `BusinessPartner2` | string | Yes | — | Business Partner Number |
| `ValidityEndDate` | string | Yes | — | Validity Date (Valid To) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"RelationshipNumber": {
"type": "string",
"description": "BP Relationship Number"
},
"BusinessPartner1": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartner2": {
"type": "string",
"description": "Business Partner Number"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity Date (Valid To)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RelationshipNumber",
"BusinessPartner1",
"BusinessPartner2",
"ValidityEndDate",
"ValidityStartDate",
"IsStandardRelationship",
"RelationshipCategory",
"BPRelationshipType",
"CreatedByUser",
"CreationDate",
"CreationTime",
"LastChangedByUser",
"LastChangeDate",
"LastChangeTime"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
}
},
"required": [
"PCID",
"RelationshipNumber",
"BusinessPartner1",
"BusinessPartner2",
"ValidityEndDate"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_business\_partner
Retrieves business partner data by using business partner number.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"Customer",
"Supplier",
"AcademicTitle",
"AuthorizationGroup",
"BusinessPartnerCategory",
"BusinessPartnerFullName",
"BusinessPartnerGrouping",
"BusinessPartnerName",
"BusinessPartnerUUID",
"CorrespondenceLanguage",
"CreatedByUser",
"CreationDate",
"CreationTime",
"FirstName",
"FormOfAddress",
"Industry",
"InternationalLocationNumber1",
"InternationalLocationNumber2",
"IsFemale",
"IsMale",
"IsNaturalPerson",
"IsSexUnknown",
"GenderCodeName",
"Language",
"LastChangeDate",
"LastChangeTime",
"LastChangedByUser",
"LastName",
"LegalForm",
"OrganizationBPName1",
"OrganizationBPName2",
"OrganizationBPName3",
"OrganizationBPName4",
"OrganizationFoundationDate",
"OrganizationLiquidationDate",
"SearchTerm1",
"SearchTerm2",
"AdditionalLastName",
"BirthDate",
"BusinessPartnerBirthDateStatus",
"BusinessPartnerBirthplaceName",
"BusinessPartnerDeathDate",
"BusinessPartnerIsBlocked",
"BusinessPartnerType",
"ETag",
"GroupBusinessPartnerName1",
"GroupBusinessPartnerName2",
"IndependentAddressID",
"InternationalLocationNumber3",
"MiddleName",
"NameCountry",
"NameFormat",
"PersonFullName",
"PersonNumber",
"IsMarkedForArchiving",
"BusinessPartnerIDByExtSystem",
"BusinessPartnerPrintFormat",
"BusinessPartnerOccupation",
"BusPartMaritalStatus",
"BusPartNationality",
"BusinessPartnerBirthName",
"BusinessPartnerSupplementName",
"NaturalPersonEmployerName",
"LastNamePrefix",
"LastNameSecondPrefix",
"Initials",
"BPDataControllerIsNotRequired",
"TradingPartner",
"to_AddressIndependentEmail",
"to_AddressIndependentFax",
"to_AddressIndependentMobile",
"to_AddressIndependentPhone",
"to_AddressIndependentWebsite",
"to_BPCreditWorthiness",
"to_BPDataController",
"to_BPEmployment",
"to_BPFinServicesReporting",
"to_BPFiscalYearInformation",
"to_BPRelationship",
"to_BuPaIdentification",
"to_BuPaIndustry",
"to_BusinessPartner",
"to_BusinessPartnerAddress",
"to_BusinessPartnerAlias",
"to_BusinessPartnerBank",
"to_BusinessPartnerContact",
"to_BusinessPartnerIsBank",
"to_BusinessPartnerRating",
"to_BusinessPartnerRole",
"to_BusinessPartnerTax",
"to_BusPartAddrDepdntTaxNmbr",
"to_Customer",
"to_PaymentCard",
"to_Supplier"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_AddressIndependentEmail",
"to_AddressIndependentFax",
"to_AddressIndependentMobile",
"to_AddressIndependentPhone",
"to_AddressIndependentWebsite",
"to_BPCreditWorthiness",
"to_BPDataController",
"to_BPEmployment",
"to_BPFinServicesReporting",
"to_BPFiscalYearInformation",
"to_BPRelationship",
"to_BuPaIdentification",
"to_BuPaIndustry",
"to_BusinessPartner",
"to_BusinessPartnerAddress",
"to_BusinessPartnerAlias",
"to_BusinessPartnerBank",
"to_BusinessPartnerContact",
"to_BusinessPartnerIsBank",
"to_BusinessPartnerRating",
"to_BusinessPartnerRole",
"to_BusinessPartnerTax",
"to_BusPartAddrDepdntTaxNmbr",
"to_Customer",
"to_PaymentCard",
"to_Supplier"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID",
"BusinessPartner"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_contact
Retrieves business partner contact data by using key fields.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `RelationshipNumber` | string | Yes | — | BP Relationship Number |
| `BusinessPartnerCompany` | string | Yes | — | Business Partner Number |
| `BusinessPartnerPerson` | string | Yes | — | Business Partner Number |
| `ValidityEndDate` | string | Yes | — | Validity Date (Valid To) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"RelationshipNumber": {
"type": "string",
"description": "BP Relationship Number"
},
"BusinessPartnerCompany": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartnerPerson": {
"type": "string",
"description": "Business Partner Number"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity Date (Valid To)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RelationshipNumber",
"BusinessPartnerCompany",
"BusinessPartnerPerson",
"ValidityEndDate",
"ValidityStartDate",
"IsStandardRelationship",
"RelationshipCategory",
"to_ContactAddress",
"to_ContactRelationship"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_ContactAddress",
"to_ContactRelationship"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID",
"RelationshipNumber",
"BusinessPartnerCompany",
"BusinessPartnerPerson",
"ValidityEndDate"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_customer
Retrieves customer data by using customer number.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `Customer` | string | Yes | — | Customer Number |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Customer": {
"type": "string",
"description": "Customer Number"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Customer",
"AuthorizationGroup",
"BillingIsBlockedForCustomer",
"CreatedByUser",
"CreationDate",
"CustomerAccountGroup",
"CustomerClassification",
"CustomerFullName",
"BPCustomerFullName",
"CustomerName",
"BPCustomerName",
"DeliveryIsBlocked",
"FreeDefinedAttribute01",
"FreeDefinedAttribute02",
"FreeDefinedAttribute03",
"FreeDefinedAttribute04",
"FreeDefinedAttribute05",
"FreeDefinedAttribute06",
"FreeDefinedAttribute07",
"FreeDefinedAttribute08",
"FreeDefinedAttribute09",
"FreeDefinedAttribute10",
"NFPartnerIsNaturalPerson",
"OrderIsBlockedForCustomer",
"PostingIsBlocked",
"Supplier",
"CustomerCorporateGroup",
"FiscalAddress",
"Industry",
"IndustryCode1",
"IndustryCode2",
"IndustryCode3",
"IndustryCode4",
"IndustryCode5",
"InternationalLocationNumber1",
"InternationalLocationNumber2",
"InternationalLocationNumber3",
"NielsenRegion",
"PaymentReason",
"ResponsibleType",
"TaxNumber1",
"TaxNumber2",
"TaxNumber3",
"TaxNumber4",
"TaxNumber5",
"TaxNumberType",
"VATRegistration",
"DeletionIndicator",
"ExpressTrainStationName",
"TrainStationName",
"CityCode",
"County",
"BR_ICMSTaxPayerType",
"to_CustAddrDepdntExtIdentifier",
"to_CustAddrDepdntInformation",
"to_CustomerCompany",
"to_CustomerSalesArea",
"to_CustomerTaxGrouping",
"to_CustomerText",
"to_CustomerUnloadingPoint",
"to_CustUnldgPtAddrDepdntInfo"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_CustAddrDepdntExtIdentifier",
"to_CustAddrDepdntInformation",
"to_CustomerCompany",
"to_CustomerSalesArea",
"to_CustomerTaxGrouping",
"to_CustomerText",
"to_CustomerUnloadingPoint",
"to_CustUnldgPtAddrDepdntInfo"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID",
"Customer"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_role
Retrieves business partner role data using the key fields.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BusinessPartnerRole` | string | Yes | — | BP Role |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartnerRole": {
"type": "string",
"description": "BP Role"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BusinessPartnerRole",
"ValidFrom",
"ValidTo",
"AuthorizationGroup"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
}
},
"required": [
"PCID",
"BusinessPartner",
"BusinessPartnerRole"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_supplier
Retrieves supplier general data by using supplier number.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `Supplier` | string | Yes | — | Account Number of Supplier |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Supplier": {
"type": "string",
"description": "Account Number of Supplier"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Supplier",
"AlternativePayeeAccountNumber",
"AuthorizationGroup",
"BusinessPartnerPanNumber",
"CreatedByUser",
"CreationDate",
"Customer",
"PaymentIsBlockedForSupplier",
"PostingIsBlocked",
"PurchasingIsBlocked",
"SupplierAccountGroup",
"SupplierFullName",
"SupplierName",
"VATRegistration",
"BirthDate",
"ConcatenatedInternationalLocNo",
"DeletionIndicator",
"FiscalAddress",
"Industry",
"InternationalLocationNumber1",
"InternationalLocationNumber2",
"InternationalLocationNumber3",
"IsNaturalPerson",
"PaymentReason",
"ResponsibleType",
"SuplrQltyInProcmtCertfnValidTo",
"SuplrQualityManagementSystem",
"SupplierCorporateGroup",
"SupplierProcurementBlock",
"TaxNumber1",
"TaxNumber2",
"TaxNumber3",
"TaxNumber4",
"TaxNumber5",
"TaxNumberResponsible",
"TaxNumberType",
"SuplrProofOfDelivRlvtCode",
"BR_TaxIsSplit",
"DataExchangeInstructionKey",
"JP_SuplrAmtInCapitalAmount",
"JP_SupplierCapitalAmountCrcy",
"to_SupplierCompany",
"to_SupplierPurchasingOrg",
"to_SupplierText"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_SupplierCompany",
"to_SupplierPurchasingOrg",
"to_SupplierText"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID",
"Supplier"
]
}
```
***
## sap\_s4hana\_business\_partner\_get\_tax\_number
Retrieves business partner tax number data by using key fields.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------- | --------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BPTaxType` | string | Yes | — | Tax Number Category |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BPTaxType": {
"type": "string",
"description": "Tax Number Category"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BPTaxType",
"BPTaxNumber",
"BPTaxLongNumber",
"AuthorizationGroup"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
}
},
"required": [
"PCID",
"BusinessPartner",
"BPTaxType"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_bprelationship
Retrieves business partner relationship data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RelationshipNumber",
"RelationshipNumber desc",
"BusinessPartner1",
"BusinessPartner1 desc",
"BusinessPartner2",
"BusinessPartner2 desc",
"ValidityEndDate",
"ValidityEndDate desc",
"ValidityStartDate",
"ValidityStartDate desc",
"IsStandardRelationship",
"IsStandardRelationship desc",
"RelationshipCategory",
"RelationshipCategory desc",
"BPRelationshipType",
"BPRelationshipType desc",
"CreatedByUser",
"CreatedByUser desc",
"CreationDate",
"CreationDate desc",
"CreationTime",
"CreationTime desc",
"LastChangedByUser",
"LastChangedByUser desc",
"LastChangeDate",
"LastChangeDate desc",
"LastChangeTime",
"LastChangeTime desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RelationshipNumber",
"BusinessPartner1",
"BusinessPartner2",
"ValidityEndDate",
"ValidityStartDate",
"IsStandardRelationship",
"RelationshipCategory",
"BPRelationshipType",
"CreatedByUser",
"CreationDate",
"CreationTime",
"LastChangedByUser",
"LastChangeDate",
"LastChangeTime"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_business\_partner
Retrieves business partner general data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BusinessPartner desc",
"Customer",
"Customer desc",
"Supplier",
"Supplier desc",
"AcademicTitle",
"AcademicTitle desc",
"AuthorizationGroup",
"AuthorizationGroup desc",
"BusinessPartnerCategory",
"BusinessPartnerCategory desc",
"BusinessPartnerFullName",
"BusinessPartnerFullName desc",
"BusinessPartnerGrouping",
"BusinessPartnerGrouping desc",
"BusinessPartnerName",
"BusinessPartnerName desc",
"BusinessPartnerUUID",
"BusinessPartnerUUID desc",
"CorrespondenceLanguage",
"CorrespondenceLanguage desc",
"CreatedByUser",
"CreatedByUser desc",
"CreationDate",
"CreationDate desc",
"CreationTime",
"CreationTime desc",
"FirstName",
"FirstName desc",
"FormOfAddress",
"FormOfAddress desc",
"Industry",
"Industry desc",
"InternationalLocationNumber1",
"InternationalLocationNumber1 desc",
"InternationalLocationNumber2",
"InternationalLocationNumber2 desc",
"IsFemale",
"IsFemale desc",
"IsMale",
"IsMale desc",
"IsNaturalPerson",
"IsNaturalPerson desc",
"IsSexUnknown",
"IsSexUnknown desc",
"GenderCodeName",
"GenderCodeName desc",
"Language",
"Language desc",
"LastChangeDate",
"LastChangeDate desc",
"LastChangeTime",
"LastChangeTime desc",
"LastChangedByUser",
"LastChangedByUser desc",
"LastName",
"LastName desc",
"LegalForm",
"LegalForm desc",
"OrganizationBPName1",
"OrganizationBPName1 desc",
"OrganizationBPName2",
"OrganizationBPName2 desc",
"OrganizationBPName3",
"OrganizationBPName3 desc",
"OrganizationBPName4",
"OrganizationBPName4 desc",
"OrganizationFoundationDate",
"OrganizationFoundationDate desc",
"OrganizationLiquidationDate",
"OrganizationLiquidationDate desc",
"SearchTerm1",
"SearchTerm1 desc",
"SearchTerm2",
"SearchTerm2 desc",
"AdditionalLastName",
"AdditionalLastName desc",
"BirthDate",
"BirthDate desc",
"BusinessPartnerBirthDateStatus",
"BusinessPartnerBirthDateStatus desc",
"BusinessPartnerBirthplaceName",
"BusinessPartnerBirthplaceName desc",
"BusinessPartnerDeathDate",
"BusinessPartnerDeathDate desc",
"BusinessPartnerIsBlocked",
"BusinessPartnerIsBlocked desc",
"BusinessPartnerType",
"BusinessPartnerType desc",
"ETag",
"ETag desc",
"GroupBusinessPartnerName1",
"GroupBusinessPartnerName1 desc",
"GroupBusinessPartnerName2",
"GroupBusinessPartnerName2 desc",
"IndependentAddressID",
"IndependentAddressID desc",
"InternationalLocationNumber3",
"InternationalLocationNumber3 desc",
"MiddleName",
"MiddleName desc",
"NameCountry",
"NameCountry desc",
"NameFormat",
"NameFormat desc",
"PersonFullName",
"PersonFullName desc",
"PersonNumber",
"PersonNumber desc",
"IsMarkedForArchiving",
"IsMarkedForArchiving desc",
"BusinessPartnerIDByExtSystem",
"BusinessPartnerIDByExtSystem desc",
"BusinessPartnerPrintFormat",
"BusinessPartnerPrintFormat desc",
"BusinessPartnerOccupation",
"BusinessPartnerOccupation desc",
"BusPartMaritalStatus",
"BusPartMaritalStatus desc",
"BusPartNationality",
"BusPartNationality desc",
"BusinessPartnerBirthName",
"BusinessPartnerBirthName desc",
"BusinessPartnerSupplementName",
"BusinessPartnerSupplementName desc",
"NaturalPersonEmployerName",
"NaturalPersonEmployerName desc",
"LastNamePrefix",
"LastNamePrefix desc",
"LastNameSecondPrefix",
"LastNameSecondPrefix desc",
"Initials",
"Initials desc",
"BPDataControllerIsNotRequired",
"BPDataControllerIsNotRequired desc",
"TradingPartner",
"TradingPartner desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"Customer",
"Supplier",
"AcademicTitle",
"AuthorizationGroup",
"BusinessPartnerCategory",
"BusinessPartnerFullName",
"BusinessPartnerGrouping",
"BusinessPartnerName",
"BusinessPartnerUUID",
"CorrespondenceLanguage",
"CreatedByUser",
"CreationDate",
"CreationTime",
"FirstName",
"FormOfAddress",
"Industry",
"InternationalLocationNumber1",
"InternationalLocationNumber2",
"IsFemale",
"IsMale",
"IsNaturalPerson",
"IsSexUnknown",
"GenderCodeName",
"Language",
"LastChangeDate",
"LastChangeTime",
"LastChangedByUser",
"LastName",
"LegalForm",
"OrganizationBPName1",
"OrganizationBPName2",
"OrganizationBPName3",
"OrganizationBPName4",
"OrganizationFoundationDate",
"OrganizationLiquidationDate",
"SearchTerm1",
"SearchTerm2",
"AdditionalLastName",
"BirthDate",
"BusinessPartnerBirthDateStatus",
"BusinessPartnerBirthplaceName",
"BusinessPartnerDeathDate",
"BusinessPartnerIsBlocked",
"BusinessPartnerType",
"ETag",
"GroupBusinessPartnerName1",
"GroupBusinessPartnerName2",
"IndependentAddressID",
"InternationalLocationNumber3",
"MiddleName",
"NameCountry",
"NameFormat",
"PersonFullName",
"PersonNumber",
"IsMarkedForArchiving",
"BusinessPartnerIDByExtSystem",
"BusinessPartnerPrintFormat",
"BusinessPartnerOccupation",
"BusPartMaritalStatus",
"BusPartNationality",
"BusinessPartnerBirthName",
"BusinessPartnerSupplementName",
"NaturalPersonEmployerName",
"LastNamePrefix",
"LastNameSecondPrefix",
"Initials",
"BPDataControllerIsNotRequired",
"TradingPartner",
"to_AddressIndependentEmail",
"to_AddressIndependentFax",
"to_AddressIndependentMobile",
"to_AddressIndependentPhone",
"to_AddressIndependentWebsite",
"to_BPCreditWorthiness",
"to_BPDataController",
"to_BPEmployment",
"to_BPFinServicesReporting",
"to_BPFiscalYearInformation",
"to_BPRelationship",
"to_BuPaIdentification",
"to_BuPaIndustry",
"to_BusinessPartner",
"to_BusinessPartnerAddress",
"to_BusinessPartnerAlias",
"to_BusinessPartnerBank",
"to_BusinessPartnerContact",
"to_BusinessPartnerIsBank",
"to_BusinessPartnerRating",
"to_BusinessPartnerRole",
"to_BusinessPartnerTax",
"to_BusPartAddrDepdntTaxNmbr",
"to_Customer",
"to_PaymentCard",
"to_Supplier"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_AddressIndependentEmail",
"to_AddressIndependentFax",
"to_AddressIndependentMobile",
"to_AddressIndependentPhone",
"to_AddressIndependentWebsite",
"to_BPCreditWorthiness",
"to_BPDataController",
"to_BPEmployment",
"to_BPFinServicesReporting",
"to_BPFiscalYearInformation",
"to_BPRelationship",
"to_BuPaIdentification",
"to_BuPaIndustry",
"to_BusinessPartner",
"to_BusinessPartnerAddress",
"to_BusinessPartnerAlias",
"to_BusinessPartnerBank",
"to_BusinessPartnerContact",
"to_BusinessPartnerIsBank",
"to_BusinessPartnerRating",
"to_BusinessPartnerRole",
"to_BusinessPartnerTax",
"to_BusPartAddrDepdntTaxNmbr",
"to_Customer",
"to_PaymentCard",
"to_Supplier"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_business\_partner\_address
Retrieves business partner address data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BusinessPartner desc",
"AddressID",
"AddressID desc",
"ValidityStartDate",
"ValidityStartDate desc",
"ValidityEndDate",
"ValidityEndDate desc",
"AuthorizationGroup",
"AuthorizationGroup desc",
"AddressUUID",
"AddressUUID desc",
"AdditionalStreetPrefixName",
"AdditionalStreetPrefixName desc",
"AdditionalStreetSuffixName",
"AdditionalStreetSuffixName desc",
"AddressTimeZone",
"AddressTimeZone desc",
"CareOfName",
"CareOfName desc",
"CityCode",
"CityCode desc",
"CityName",
"CityName desc",
"CompanyPostalCode",
"CompanyPostalCode desc",
"Country",
"Country desc",
"County",
"County desc",
"DeliveryServiceNumber",
"DeliveryServiceNumber desc",
"DeliveryServiceTypeCode",
"DeliveryServiceTypeCode desc",
"District",
"District desc",
"FormOfAddress",
"FormOfAddress desc",
"FullName",
"FullName desc",
"HomeCityName",
"HomeCityName desc",
"HouseNumber",
"HouseNumber desc",
"HouseNumberSupplementText",
"HouseNumberSupplementText desc",
"Language",
"Language desc",
"POBox",
"POBox desc",
"POBoxDeviatingCityName",
"POBoxDeviatingCityName desc",
"POBoxDeviatingCountry",
"POBoxDeviatingCountry desc",
"POBoxDeviatingRegion",
"POBoxDeviatingRegion desc",
"POBoxIsWithoutNumber",
"POBoxIsWithoutNumber desc",
"POBoxLobbyName",
"POBoxLobbyName desc",
"POBoxPostalCode",
"POBoxPostalCode desc",
"Person",
"Person desc",
"PostalCode",
"PostalCode desc",
"PrfrdCommMediumType",
"PrfrdCommMediumType desc",
"Region",
"Region desc",
"StreetName",
"StreetName desc",
"StreetPrefixName",
"StreetPrefixName desc",
"StreetSuffixName",
"StreetSuffixName desc",
"TaxJurisdiction",
"TaxJurisdiction desc",
"TransportZone",
"TransportZone desc",
"AddressIDByExternalSystem",
"AddressIDByExternalSystem desc",
"CountyCode",
"CountyCode desc",
"TownshipCode",
"TownshipCode desc",
"TownshipName",
"TownshipName desc",
"Building",
"Building desc",
"Floor",
"Floor desc",
"RoomNumber",
"RoomNumber desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"AddressID",
"ValidityStartDate",
"ValidityEndDate",
"AuthorizationGroup",
"AddressUUID",
"AdditionalStreetPrefixName",
"AdditionalStreetSuffixName",
"AddressTimeZone",
"CareOfName",
"CityCode",
"CityName",
"CompanyPostalCode",
"Country",
"County",
"DeliveryServiceNumber",
"DeliveryServiceTypeCode",
"District",
"FormOfAddress",
"FullName",
"HomeCityName",
"HouseNumber",
"HouseNumberSupplementText",
"Language",
"POBox",
"POBoxDeviatingCityName",
"POBoxDeviatingCountry",
"POBoxDeviatingRegion",
"POBoxIsWithoutNumber",
"POBoxLobbyName",
"POBoxPostalCode",
"Person",
"PostalCode",
"PrfrdCommMediumType",
"Region",
"StreetName",
"StreetPrefixName",
"StreetSuffixName",
"TaxJurisdiction",
"TransportZone",
"AddressIDByExternalSystem",
"CountyCode",
"TownshipCode",
"TownshipName",
"Building",
"Floor",
"RoomNumber",
"to_AddressUsage",
"to_BPAddrDepdntIntlLocNumber",
"to_BPIntlAddressVersion",
"to_EmailAddress",
"to_FaxNumber",
"to_MobilePhoneNumber",
"to_PhoneNumber",
"to_URLAddress"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_AddressUsage",
"to_BPAddrDepdntIntlLocNumber",
"to_BPIntlAddressVersion",
"to_EmailAddress",
"to_FaxNumber",
"to_MobilePhoneNumber",
"to_PhoneNumber",
"to_URLAddress"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_business\_partner\_bank
Retrieves business partner bank data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BusinessPartner desc",
"BankIdentification",
"BankIdentification desc",
"BankCountryKey",
"BankCountryKey desc",
"BankName",
"BankName desc",
"BankNumber",
"BankNumber desc",
"SWIFTCode",
"SWIFTCode desc",
"BankControlKey",
"BankControlKey desc",
"BankAccountHolderName",
"BankAccountHolderName desc",
"BankAccountName",
"BankAccountName desc",
"ValidityStartDate",
"ValidityStartDate desc",
"ValidityEndDate",
"ValidityEndDate desc",
"IBAN",
"IBAN desc",
"IBANValidityStartDate",
"IBANValidityStartDate desc",
"BankAccount",
"BankAccount desc",
"BankAccountReferenceText",
"BankAccountReferenceText desc",
"CollectionAuthInd",
"CollectionAuthInd desc",
"CityName",
"CityName desc",
"AuthorizationGroup",
"AuthorizationGroup desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BankIdentification",
"BankCountryKey",
"BankName",
"BankNumber",
"SWIFTCode",
"BankControlKey",
"BankAccountHolderName",
"BankAccountName",
"ValidityStartDate",
"ValidityEndDate",
"IBAN",
"IBANValidityStartDate",
"BankAccount",
"BankAccountReferenceText",
"CollectionAuthInd",
"CityName",
"AuthorizationGroup"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_business\_partner\_contact
Retrieves business partner contact data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RelationshipNumber",
"RelationshipNumber desc",
"BusinessPartnerCompany",
"BusinessPartnerCompany desc",
"BusinessPartnerPerson",
"BusinessPartnerPerson desc",
"ValidityEndDate",
"ValidityEndDate desc",
"ValidityStartDate",
"ValidityStartDate desc",
"IsStandardRelationship",
"IsStandardRelationship desc",
"RelationshipCategory",
"RelationshipCategory desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RelationshipNumber",
"BusinessPartnerCompany",
"BusinessPartnerPerson",
"ValidityEndDate",
"ValidityStartDate",
"IsStandardRelationship",
"RelationshipCategory",
"to_ContactAddress",
"to_ContactRelationship"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_ContactAddress",
"to_ContactRelationship"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_business\_partner\_role
Retrieves business partner role data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BusinessPartner desc",
"BusinessPartnerRole",
"BusinessPartnerRole desc",
"ValidFrom",
"ValidFrom desc",
"ValidTo",
"ValidTo desc",
"AuthorizationGroup",
"AuthorizationGroup desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BusinessPartnerRole",
"ValidFrom",
"ValidTo",
"AuthorizationGroup"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_business\_partner\_tax\_number
Retrieves business partner tax number data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BusinessPartner desc",
"BPTaxType",
"BPTaxType desc",
"BPTaxNumber",
"BPTaxNumber desc",
"BPTaxLongNumber",
"BPTaxLongNumber desc",
"AuthorizationGroup",
"AuthorizationGroup desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"BusinessPartner",
"BPTaxType",
"BPTaxNumber",
"BPTaxLongNumber",
"AuthorizationGroup"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_customer
Retrieves customer general data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Customer",
"Customer desc",
"AuthorizationGroup",
"AuthorizationGroup desc",
"BillingIsBlockedForCustomer",
"BillingIsBlockedForCustomer desc",
"CreatedByUser",
"CreatedByUser desc",
"CreationDate",
"CreationDate desc",
"CustomerAccountGroup",
"CustomerAccountGroup desc",
"CustomerClassification",
"CustomerClassification desc",
"CustomerFullName",
"CustomerFullName desc",
"BPCustomerFullName",
"BPCustomerFullName desc",
"CustomerName",
"CustomerName desc",
"BPCustomerName",
"BPCustomerName desc",
"DeliveryIsBlocked",
"DeliveryIsBlocked desc",
"FreeDefinedAttribute01",
"FreeDefinedAttribute01 desc",
"FreeDefinedAttribute02",
"FreeDefinedAttribute02 desc",
"FreeDefinedAttribute03",
"FreeDefinedAttribute03 desc",
"FreeDefinedAttribute04",
"FreeDefinedAttribute04 desc",
"FreeDefinedAttribute05",
"FreeDefinedAttribute05 desc",
"FreeDefinedAttribute06",
"FreeDefinedAttribute06 desc",
"FreeDefinedAttribute07",
"FreeDefinedAttribute07 desc",
"FreeDefinedAttribute08",
"FreeDefinedAttribute08 desc",
"FreeDefinedAttribute09",
"FreeDefinedAttribute09 desc",
"FreeDefinedAttribute10",
"FreeDefinedAttribute10 desc",
"NFPartnerIsNaturalPerson",
"NFPartnerIsNaturalPerson desc",
"OrderIsBlockedForCustomer",
"OrderIsBlockedForCustomer desc",
"PostingIsBlocked",
"PostingIsBlocked desc",
"Supplier",
"Supplier desc",
"CustomerCorporateGroup",
"CustomerCorporateGroup desc",
"FiscalAddress",
"FiscalAddress desc",
"Industry",
"Industry desc",
"IndustryCode1",
"IndustryCode1 desc",
"IndustryCode2",
"IndustryCode2 desc",
"IndustryCode3",
"IndustryCode3 desc",
"IndustryCode4",
"IndustryCode4 desc",
"IndustryCode5",
"IndustryCode5 desc",
"InternationalLocationNumber1",
"InternationalLocationNumber1 desc",
"InternationalLocationNumber2",
"InternationalLocationNumber2 desc",
"InternationalLocationNumber3",
"InternationalLocationNumber3 desc",
"NielsenRegion",
"NielsenRegion desc",
"PaymentReason",
"PaymentReason desc",
"ResponsibleType",
"ResponsibleType desc",
"TaxNumber1",
"TaxNumber1 desc",
"TaxNumber2",
"TaxNumber2 desc",
"TaxNumber3",
"TaxNumber3 desc",
"TaxNumber4",
"TaxNumber4 desc",
"TaxNumber5",
"TaxNumber5 desc",
"TaxNumberType",
"TaxNumberType desc",
"VATRegistration",
"VATRegistration desc",
"DeletionIndicator",
"DeletionIndicator desc",
"ExpressTrainStationName",
"ExpressTrainStationName desc",
"TrainStationName",
"TrainStationName desc",
"CityCode",
"CityCode desc",
"County",
"County desc",
"BR_ICMSTaxPayerType",
"BR_ICMSTaxPayerType desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Customer",
"AuthorizationGroup",
"BillingIsBlockedForCustomer",
"CreatedByUser",
"CreationDate",
"CustomerAccountGroup",
"CustomerClassification",
"CustomerFullName",
"BPCustomerFullName",
"CustomerName",
"BPCustomerName",
"DeliveryIsBlocked",
"FreeDefinedAttribute01",
"FreeDefinedAttribute02",
"FreeDefinedAttribute03",
"FreeDefinedAttribute04",
"FreeDefinedAttribute05",
"FreeDefinedAttribute06",
"FreeDefinedAttribute07",
"FreeDefinedAttribute08",
"FreeDefinedAttribute09",
"FreeDefinedAttribute10",
"NFPartnerIsNaturalPerson",
"OrderIsBlockedForCustomer",
"PostingIsBlocked",
"Supplier",
"CustomerCorporateGroup",
"FiscalAddress",
"Industry",
"IndustryCode1",
"IndustryCode2",
"IndustryCode3",
"IndustryCode4",
"IndustryCode5",
"InternationalLocationNumber1",
"InternationalLocationNumber2",
"InternationalLocationNumber3",
"NielsenRegion",
"PaymentReason",
"ResponsibleType",
"TaxNumber1",
"TaxNumber2",
"TaxNumber3",
"TaxNumber4",
"TaxNumber5",
"TaxNumberType",
"VATRegistration",
"DeletionIndicator",
"ExpressTrainStationName",
"TrainStationName",
"CityCode",
"County",
"BR_ICMSTaxPayerType",
"to_CustAddrDepdntExtIdentifier",
"to_CustAddrDepdntInformation",
"to_CustomerCompany",
"to_CustomerSalesArea",
"to_CustomerTaxGrouping",
"to_CustomerText",
"to_CustomerUnloadingPoint",
"to_CustUnldgPtAddrDepdntInfo"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_CustAddrDepdntExtIdentifier",
"to_CustAddrDepdntInformation",
"to_CustomerCompany",
"to_CustomerSalesArea",
"to_CustomerTaxGrouping",
"to_CustomerText",
"to_CustomerUnloadingPoint",
"to_CustUnldgPtAddrDepdntInfo"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_list\_supplier
Retrieves supplier general data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------- | --------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `$top` | integer | No | — | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66) |
| `$skip` | integer | No | — | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$filter` | string | No | — | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64) |
| `$inlinecount` | string | No | — | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67) |
| `$orderby` | string\[] | No | — | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65) |
| `$select` | string\[] | No | — | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68) |
| `$expand` | string\[] | No | — | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"$top": {
"type": "integer",
"description": "Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)"
},
"$skip": {
"type": "integer",
"description": "Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$filter": {
"type": "string",
"description": "Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)"
},
"$inlinecount": {
"type": "string",
"description": "Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)",
"enum": [
"allpages",
"none"
]
},
"$orderby": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Supplier",
"Supplier desc",
"AlternativePayeeAccountNumber",
"AlternativePayeeAccountNumber desc",
"AuthorizationGroup",
"AuthorizationGroup desc",
"BusinessPartnerPanNumber",
"BusinessPartnerPanNumber desc",
"CreatedByUser",
"CreatedByUser desc",
"CreationDate",
"CreationDate desc",
"Customer",
"Customer desc",
"PaymentIsBlockedForSupplier",
"PaymentIsBlockedForSupplier desc",
"PostingIsBlocked",
"PostingIsBlocked desc",
"PurchasingIsBlocked",
"PurchasingIsBlocked desc",
"SupplierAccountGroup",
"SupplierAccountGroup desc",
"SupplierFullName",
"SupplierFullName desc",
"SupplierName",
"SupplierName desc",
"VATRegistration",
"VATRegistration desc",
"BirthDate",
"BirthDate desc",
"ConcatenatedInternationalLocNo",
"ConcatenatedInternationalLocNo desc",
"DeletionIndicator",
"DeletionIndicator desc",
"FiscalAddress",
"FiscalAddress desc",
"Industry",
"Industry desc",
"InternationalLocationNumber1",
"InternationalLocationNumber1 desc",
"InternationalLocationNumber2",
"InternationalLocationNumber2 desc",
"InternationalLocationNumber3",
"InternationalLocationNumber3 desc",
"IsNaturalPerson",
"IsNaturalPerson desc",
"PaymentReason",
"PaymentReason desc",
"ResponsibleType",
"ResponsibleType desc",
"SuplrQltyInProcmtCertfnValidTo",
"SuplrQltyInProcmtCertfnValidTo desc",
"SuplrQualityManagementSystem",
"SuplrQualityManagementSystem desc",
"SupplierCorporateGroup",
"SupplierCorporateGroup desc",
"SupplierProcurementBlock",
"SupplierProcurementBlock desc",
"TaxNumber1",
"TaxNumber1 desc",
"TaxNumber2",
"TaxNumber2 desc",
"TaxNumber3",
"TaxNumber3 desc",
"TaxNumber4",
"TaxNumber4 desc",
"TaxNumber5",
"TaxNumber5 desc",
"TaxNumberResponsible",
"TaxNumberResponsible desc",
"TaxNumberType",
"TaxNumberType desc",
"SuplrProofOfDelivRlvtCode",
"SuplrProofOfDelivRlvtCode desc",
"BR_TaxIsSplit",
"BR_TaxIsSplit desc",
"DataExchangeInstructionKey",
"DataExchangeInstructionKey desc",
"JP_SuplrAmtInCapitalAmount",
"JP_SuplrAmtInCapitalAmount desc",
"JP_SupplierCapitalAmountCrcy",
"JP_SupplierCapitalAmountCrcy desc"
]
},
"description": "Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)"
},
"$select": {
"type": "array",
"items": {
"type": "string",
"enum": [
"Supplier",
"AlternativePayeeAccountNumber",
"AuthorizationGroup",
"BusinessPartnerPanNumber",
"CreatedByUser",
"CreationDate",
"Customer",
"PaymentIsBlockedForSupplier",
"PostingIsBlocked",
"PurchasingIsBlocked",
"SupplierAccountGroup",
"SupplierFullName",
"SupplierName",
"VATRegistration",
"BirthDate",
"ConcatenatedInternationalLocNo",
"DeletionIndicator",
"FiscalAddress",
"Industry",
"InternationalLocationNumber1",
"InternationalLocationNumber2",
"InternationalLocationNumber3",
"IsNaturalPerson",
"PaymentReason",
"ResponsibleType",
"SuplrQltyInProcmtCertfnValidTo",
"SuplrQualityManagementSystem",
"SupplierCorporateGroup",
"SupplierProcurementBlock",
"TaxNumber1",
"TaxNumber2",
"TaxNumber3",
"TaxNumber4",
"TaxNumber5",
"TaxNumberResponsible",
"TaxNumberType",
"SuplrProofOfDelivRlvtCode",
"BR_TaxIsSplit",
"DataExchangeInstructionKey",
"JP_SuplrAmtInCapitalAmount",
"JP_SupplierCapitalAmountCrcy",
"to_SupplierCompany",
"to_SupplierPurchasingOrg",
"to_SupplierText"
]
},
"description": "Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)"
},
"$expand": {
"type": "array",
"items": {
"type": "string",
"enum": [
"to_SupplierCompany",
"to_SupplierPurchasingOrg",
"to_SupplierText"
]
},
"description": "Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)"
}
},
"required": [
"PCID"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_bprelationship
Updates business partner relationship data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | -------------------------------------- |
| `RelationshipNumber` | string | Yes | — | BP Relationship Number |
| `BusinessPartner1` | string | Yes | — | Business Partner Number |
| `BusinessPartner2` | string | Yes | — | Business Partner Number |
| `ValidityEndDate` | string | Yes | — | Validity Date (Valid To) |
| `BPRelationshipType` | string | No | — | Business partner relationship type |
| `IsStandardRelationship` | boolean | No | — | Standard Relationship |
| `RelationshipCategory` | string | No | — | Business Partner Relationship Category |
| `ValidityStartDate` | string | No | — | Validity Date (Valid From) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"RelationshipNumber": {
"type": "string",
"description": "BP Relationship Number"
},
"BusinessPartner1": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartner2": {
"type": "string",
"description": "Business Partner Number"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity Date (Valid To)"
},
"BPRelationshipType": {
"type": "string",
"description": "Business partner relationship type"
},
"IsStandardRelationship": {
"type": "boolean",
"description": "Standard Relationship"
},
"RelationshipCategory": {
"type": "string",
"description": "Business Partner Relationship Category"
},
"ValidityStartDate": {
"type": "string",
"description": "Validity Date (Valid From)"
}
},
"required": [
"PCID",
"RelationshipNumber",
"BusinessPartner1",
"BusinessPartner2",
"ValidityEndDate"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_business\_partner
Updates business partner general data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `AcademicTitle` | string | No | — | Academic Title: Key |
| `AdditionalLastName` | string | No | — | Other Last Name of a Person |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BirthDate` | string | No | — | Date of Birth of Business Partner |
| `BPDataControllerIsNotRequired` | boolean | No | — | BP: Data Controller Not Required |
| `BusinessPartnerBirthDateStatus` | string | No | — | Date of Birth: Status |
| `BusinessPartnerBirthName` | string | No | — | Name at birth of business partner |
| `BusinessPartnerBirthplaceName` | string | No | — | Birthplace of business partner |
| `BusinessPartnerCategory` | string | No | — | Business Partner Category |
| `BusinessPartnerDeathDate` | string | No | — | Date of death of business partner |
| `BusinessPartnerGrouping` | string | No | — | Business Partner Grouping |
| `BusinessPartnerIDByExtSystem` | string | No | — | Business Partner Number in External System |
| `BusinessPartnerIsBlocked` | boolean | No | — | Central Block for Business Partner |
| `BusinessPartnerOccupation` | string | No | — | Occupation/group |
| `BusinessPartnerPrintFormat` | string | No | — | Business Partner Print Format |
| `BusinessPartnerSupplementName` | string | No | — | Name supplement, e.g. noble title (key) |
| `BusinessPartnerType` | string | No | — | Business Partner Type |
| `BusPartMaritalStatus` | string | No | — | Marital Status of Business Partner |
| `BusPartNationality` | string | No | — | Bus Part Nationality |
| `CorrespondenceLanguage` | string | No | — | Business Partner: Correspondence Language |
| `FirstName` | string | No | — | First Name of Business Partner (Person) |
| `FormOfAddress` | string | No | — | Form-of-Address Key |
| `GenderCodeName` | string | No | — | Gender of Business Partner (Person) |
| `GroupBusinessPartnerName1` | string | No | — | Name 1 (group) |
| `GroupBusinessPartnerName2` | string | No | — | Name 2 (group) |
| `Industry` | string | No | — | The industry value |
| `Initials` | string | No | — | "Middle Initial" or personal initials |
| `InternationalLocationNumber1` | string | No | — | International location number (part 1) |
| `InternationalLocationNumber2` | string | No | — | International location number (Part 2) |
| `InternationalLocationNumber3` | string | No | — | Check digit for the international location number |
| `IsFemale` | boolean | No | — | Selection: Business partner is female |
| `IsMale` | boolean | No | — | Selection: Business partner is male |
| `IsMarkedForArchiving` | boolean | No | — | Central Archiving Flag |
| `IsNaturalPerson` | string | No | — | Business Partner Is a Natural Person Under the Tax Laws |
| `IsSexUnknown` | boolean | No | — | Selection: Sex of business partner is not known |
| `Language` | string | No | — | Business partner: Language |
| `LastName` | string | No | — | Last Name of Business Partner (Person) |
| `LastNamePrefix` | string | No | — | Name Prefix (Key) |
| `LastNameSecondPrefix` | string | No | — | 2nd name prefix (key) |
| `LegalForm` | string | No | — | BP: Legal form of organization |
| `MiddleName` | string | No | — | Middle Name or Second Forename of a Person |
| `NameCountry` | string | No | — | Country/Region for Name Format Rule |
| `NameFormat` | string | No | — | Name format |
| `NaturalPersonEmployerName` | string | No | — | Name of Employer of a Natural Person |
| `OrganizationBPName1` | string | No | — | Name 1 of organization |
| `OrganizationBPName2` | string | No | — | Name 2 of organization |
| `OrganizationBPName3` | string | No | — | Name 3 of organization |
| `OrganizationBPName4` | string | No | — | Name 4 of organization |
| `OrganizationFoundationDate` | string | No | — | Date organization founded |
| `OrganizationLiquidationDate` | string | No | — | Liquidation date of organization |
| `PersonFullName` | string | No | — | Person Full Name |
| `SearchTerm1` | string | No | — | Search Term 1 for Business Partner |
| `SearchTerm2` | string | No | — | Search Term 2 for Business Partner |
| `TradingPartner` | string | No | — | Company ID of Trading Partner |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"AcademicTitle": {
"type": "string",
"description": "Academic Title: Key"
},
"AdditionalLastName": {
"type": "string",
"description": "Other Last Name of a Person"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BirthDate": {
"type": "string",
"description": "Date of Birth of Business Partner"
},
"BPDataControllerIsNotRequired": {
"type": "boolean",
"description": "BP: Data Controller Not Required"
},
"BusinessPartnerBirthDateStatus": {
"type": "string",
"description": "Date of Birth: Status"
},
"BusinessPartnerBirthName": {
"type": "string",
"description": "Name at birth of business partner"
},
"BusinessPartnerBirthplaceName": {
"type": "string",
"description": "Birthplace of business partner"
},
"BusinessPartnerCategory": {
"type": "string",
"description": "Business Partner Category"
},
"BusinessPartnerDeathDate": {
"type": "string",
"description": "Date of death of business partner"
},
"BusinessPartnerGrouping": {
"type": "string",
"description": "Business Partner Grouping"
},
"BusinessPartnerIDByExtSystem": {
"type": "string",
"description": "Business Partner Number in External System"
},
"BusinessPartnerIsBlocked": {
"type": "boolean",
"description": "Central Block for Business Partner"
},
"BusinessPartnerOccupation": {
"type": "string",
"description": "Occupation/group"
},
"BusinessPartnerPrintFormat": {
"type": "string",
"description": "Business Partner Print Format"
},
"BusinessPartnerSupplementName": {
"type": "string",
"description": "Name supplement, e.g. noble title (key)"
},
"BusinessPartnerType": {
"type": "string",
"description": "Business Partner Type"
},
"BusPartMaritalStatus": {
"type": "string",
"description": "Marital Status of Business Partner"
},
"BusPartNationality": {
"type": "string",
"description": "Bus Part Nationality"
},
"CorrespondenceLanguage": {
"type": "string",
"description": "Business Partner: Correspondence Language"
},
"FirstName": {
"type": "string",
"description": "First Name of Business Partner (Person)"
},
"FormOfAddress": {
"type": "string",
"description": "Form-of-Address Key"
},
"GenderCodeName": {
"type": "string",
"description": "Gender of Business Partner (Person)"
},
"GroupBusinessPartnerName1": {
"type": "string",
"description": "Name 1 (group)"
},
"GroupBusinessPartnerName2": {
"type": "string",
"description": "Name 2 (group)"
},
"Industry": {
"type": "string",
"description": "The industry value"
},
"Initials": {
"type": "string",
"description": "\"Middle Initial\" or personal initials"
},
"InternationalLocationNumber1": {
"type": "string",
"description": "International location number (part 1)"
},
"InternationalLocationNumber2": {
"type": "string",
"description": "International location number (Part 2)"
},
"InternationalLocationNumber3": {
"type": "string",
"description": "Check digit for the international location number"
},
"IsFemale": {
"type": "boolean",
"description": "Selection: Business partner is female"
},
"IsMale": {
"type": "boolean",
"description": "Selection: Business partner is male"
},
"IsMarkedForArchiving": {
"type": "boolean",
"description": "Central Archiving Flag"
},
"IsNaturalPerson": {
"type": "string",
"description": "Business Partner Is a Natural Person Under the Tax Laws"
},
"IsSexUnknown": {
"type": "boolean",
"description": "Selection: Sex of business partner is not known"
},
"Language": {
"type": "string",
"description": "Business partner: Language"
},
"LastName": {
"type": "string",
"description": "Last Name of Business Partner (Person)"
},
"LastNamePrefix": {
"type": "string",
"description": "Name Prefix (Key)"
},
"LastNameSecondPrefix": {
"type": "string",
"description": "2nd name prefix (key)"
},
"LegalForm": {
"type": "string",
"description": "BP: Legal form of organization"
},
"MiddleName": {
"type": "string",
"description": "Middle Name or Second Forename of a Person"
},
"NameCountry": {
"type": "string",
"description": "Country/Region for Name Format Rule"
},
"NameFormat": {
"type": "string",
"description": "Name format"
},
"NaturalPersonEmployerName": {
"type": "string",
"description": "Name of Employer of a Natural Person"
},
"OrganizationBPName1": {
"type": "string",
"description": "Name 1 of organization"
},
"OrganizationBPName2": {
"type": "string",
"description": "Name 2 of organization"
},
"OrganizationBPName3": {
"type": "string",
"description": "Name 3 of organization"
},
"OrganizationBPName4": {
"type": "string",
"description": "Name 4 of organization"
},
"OrganizationFoundationDate": {
"type": "string",
"description": "Date organization founded"
},
"OrganizationLiquidationDate": {
"type": "string",
"description": "Liquidation date of organization"
},
"PersonFullName": {
"type": "string",
"description": "Person Full Name"
},
"SearchTerm1": {
"type": "string",
"description": "Search Term 1 for Business Partner"
},
"SearchTerm2": {
"type": "string",
"description": "Search Term 2 for Business Partner"
},
"TradingPartner": {
"type": "string",
"description": "Company ID of Trading Partner"
}
},
"required": [
"PCID",
"BusinessPartner"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_business\_partner\_address
Updates business partner address data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ---------------------------- | ------- | -------- | ------- | ------------------------------------------------------------ |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `AddressID` | string | Yes | — | Address Number |
| `AdditionalStreetPrefixName` | string | No | — | Additional Street Prefix Name |
| `AdditionalStreetSuffixName` | string | No | — | Additional Street Suffix Name |
| `AddressIDByExternalSystem` | string | No | — | Address number in external system |
| `AddressTimeZone` | string | No | — | Address Time Zone |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `Building` | string | No | — | Building (Number or Code) |
| `CareOfName` | string | No | — | c/o name |
| `CityCode` | string | No | — | City code for city/street file |
| `CityName` | string | No | — | City Name |
| `CompanyPostalCode` | string | No | — | Company Postal Code (for Large Customers) |
| `Country` | string | No | — | The country value |
| `County` | string | No | — | The county value |
| `CountyCode` | string | No | — | County code for county |
| `DeliveryServiceNumber` | string | No | — | Number of Delivery Service |
| `DeliveryServiceTypeCode` | string | No | — | Type of Delivery Service |
| `District` | string | No | — | The district value |
| `Floor` | string | No | — | Floor in Building |
| `HomeCityName` | string | No | — | City (different from postal city) |
| `HouseNumber` | string | No | — | House Number |
| `HouseNumberSupplementText` | string | No | — | House number supplement |
| `Language` | string | No | — | The language value |
| `POBox` | string | No | — | PO Box |
| `POBoxDeviatingCityName` | string | No | — | PO Box city |
| `POBoxDeviatingCountry` | string | No | — | PO Box of Country/Region |
| `POBoxDeviatingRegion` | string | No | — | Region for PO Box (Country/Region, State, Province, ...) |
| `POBoxIsWithoutNumber` | boolean | No | — | Flag: PO Box Without Number |
| `POBoxLobbyName` | string | No | — | PO Box Lobby Name |
| `POBoxPostalCode` | string | No | — | PO Box Postal Code |
| `PostalCode` | string | No | — | City Postal Code |
| `PrfrdCommMediumType` | string | No | — | Communication Method (Key) (Business Address Services) |
| `Region` | string | No | — | Region (State, Province, County) |
| `RoomNumber` | string | No | — | Room or Apartment Number |
| `StreetName` | string | No | — | Street Name |
| `StreetPrefixName` | string | No | — | Street Prefix Name |
| `StreetSuffixName` | string | No | — | Street Suffix Name |
| `TaxJurisdiction` | string | No | — | Tax Jurisdiction |
| `TownshipCode` | string | No | — | Township code for Township |
| `TownshipName` | string | No | — | Township Name |
| `TransportZone` | string | No | — | Transportation zone to or from which the goods are delivered |
| `ValidityEndDate` | string | No | — | Validity End of a Business Partner Address |
| `ValidityStartDate` | string | No | — | Validity Start of a Business Partner Address |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"AddressID": {
"type": "string",
"description": "Address Number"
},
"AdditionalStreetPrefixName": {
"type": "string",
"description": "Additional Street Prefix Name"
},
"AdditionalStreetSuffixName": {
"type": "string",
"description": "Additional Street Suffix Name"
},
"AddressIDByExternalSystem": {
"type": "string",
"description": "Address number in external system"
},
"AddressTimeZone": {
"type": "string",
"description": "Address Time Zone"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"Building": {
"type": "string",
"description": "Building (Number or Code)"
},
"CareOfName": {
"type": "string",
"description": "c/o name"
},
"CityCode": {
"type": "string",
"description": "City code for city/street file"
},
"CityName": {
"type": "string",
"description": "City Name"
},
"CompanyPostalCode": {
"type": "string",
"description": "Company Postal Code (for Large Customers)"
},
"Country": {
"type": "string",
"description": "The country value"
},
"County": {
"type": "string",
"description": "The county value"
},
"CountyCode": {
"type": "string",
"description": "County code for county"
},
"DeliveryServiceNumber": {
"type": "string",
"description": "Number of Delivery Service"
},
"DeliveryServiceTypeCode": {
"type": "string",
"description": "Type of Delivery Service"
},
"District": {
"type": "string",
"description": "The district value"
},
"Floor": {
"type": "string",
"description": "Floor in Building"
},
"HomeCityName": {
"type": "string",
"description": "City (different from postal city)"
},
"HouseNumber": {
"type": "string",
"description": "House Number"
},
"HouseNumberSupplementText": {
"type": "string",
"description": "House number supplement"
},
"Language": {
"type": "string",
"description": "The language value"
},
"POBox": {
"type": "string",
"description": "PO Box"
},
"POBoxDeviatingCityName": {
"type": "string",
"description": "PO Box city"
},
"POBoxDeviatingCountry": {
"type": "string",
"description": "PO Box of Country/Region"
},
"POBoxDeviatingRegion": {
"type": "string",
"description": "Region for PO Box (Country/Region, State, Province, ...)"
},
"POBoxIsWithoutNumber": {
"type": "boolean",
"description": "Flag: PO Box Without Number"
},
"POBoxLobbyName": {
"type": "string",
"description": "PO Box Lobby Name"
},
"POBoxPostalCode": {
"type": "string",
"description": "PO Box Postal Code"
},
"PostalCode": {
"type": "string",
"description": "City Postal Code"
},
"PrfrdCommMediumType": {
"type": "string",
"description": "Communication Method (Key) (Business Address Services)"
},
"Region": {
"type": "string",
"description": "Region (State, Province, County)"
},
"RoomNumber": {
"type": "string",
"description": "Room or Apartment Number"
},
"StreetName": {
"type": "string",
"description": "Street Name"
},
"StreetPrefixName": {
"type": "string",
"description": "Street Prefix Name"
},
"StreetSuffixName": {
"type": "string",
"description": "Street Suffix Name"
},
"TaxJurisdiction": {
"type": "string",
"description": "Tax Jurisdiction"
},
"TownshipCode": {
"type": "string",
"description": "Township code for Township"
},
"TownshipName": {
"type": "string",
"description": "Township Name"
},
"TransportZone": {
"type": "string",
"description": "Transportation zone to or from which the goods are delivered"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity End of a Business Partner Address"
},
"ValidityStartDate": {
"type": "string",
"description": "Validity Start of a Business Partner Address"
}
},
"required": [
"PCID",
"BusinessPartner",
"AddressID"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_business\_partner\_bank
Updates business partner bank data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------- | ------- | -------- | ------- | ----------------------------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BankIdentification` | string | Yes | — | Bank Details ID |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BankAccount` | string | No | — | Bank Account Number |
| `BankAccountHolderName` | string | No | — | Account Holder Name |
| `BankAccountName` | string | No | — | Name of Bank Account |
| `BankAccountReferenceText` | string | No | — | Reference Details for Bank Details |
| `BankControlKey` | string | No | — | Bank Control Key |
| `BankCountryKey` | string | No | — | Bank Country/Region Key |
| `BankNumber` | string | No | — | Bank Number |
| `CollectionAuthInd` | boolean | No | — | Indicator: Collection Authorization |
| `IBAN` | string | No | — | IBAN (International Bank Account Number) |
| `IBANValidityStartDate` | string | No | — | Validity Start of IBAN |
| `ValidityEndDate` | string | No | — | Validity End of Business Partner Bank Details |
| `ValidityStartDate` | string | No | — | Validity Start of Business Partner Bank Details |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BankIdentification": {
"type": "string",
"description": "Bank Details ID"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BankAccount": {
"type": "string",
"description": "Bank Account Number"
},
"BankAccountHolderName": {
"type": "string",
"description": "Account Holder Name"
},
"BankAccountName": {
"type": "string",
"description": "Name of Bank Account"
},
"BankAccountReferenceText": {
"type": "string",
"description": "Reference Details for Bank Details"
},
"BankControlKey": {
"type": "string",
"description": "Bank Control Key"
},
"BankCountryKey": {
"type": "string",
"description": "Bank Country/Region Key"
},
"BankNumber": {
"type": "string",
"description": "Bank Number"
},
"CollectionAuthInd": {
"type": "boolean",
"description": "Indicator: Collection Authorization"
},
"IBAN": {
"type": "string",
"description": "IBAN (International Bank Account Number)"
},
"IBANValidityStartDate": {
"type": "string",
"description": "Validity Start of IBAN"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity End of Business Partner Bank Details"
},
"ValidityStartDate": {
"type": "string",
"description": "Validity Start of Business Partner Bank Details"
}
},
"required": [
"PCID",
"BusinessPartner",
"BankIdentification"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_business\_partner\_contact
Updates business partner contact data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ------------------------ | ------- | -------- | ------- | -------------------------------------- |
| `RelationshipNumber` | string | Yes | — | BP Relationship Number |
| `BusinessPartnerCompany` | string | Yes | — | Business Partner Number |
| `BusinessPartnerPerson` | string | Yes | — | Business Partner Number |
| `ValidityEndDate` | string | Yes | — | Validity Date (Valid To) |
| `IsStandardRelationship` | boolean | No | — | Standard Relationship |
| `RelationshipCategory` | string | No | — | Business Partner Relationship Category |
| `ValidityStartDate` | string | No | — | Validity Date (Valid From) |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"RelationshipNumber": {
"type": "string",
"description": "BP Relationship Number"
},
"BusinessPartnerCompany": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartnerPerson": {
"type": "string",
"description": "Business Partner Number"
},
"ValidityEndDate": {
"type": "string",
"description": "Validity Date (Valid To)"
},
"IsStandardRelationship": {
"type": "boolean",
"description": "Standard Relationship"
},
"RelationshipCategory": {
"type": "string",
"description": "Business Partner Relationship Category"
},
"ValidityStartDate": {
"type": "string",
"description": "Validity Date (Valid From)"
}
},
"required": [
"PCID",
"RelationshipNumber",
"BusinessPartnerCompany",
"BusinessPartnerPerson",
"ValidityEndDate"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_business\_partner\_role
Updates role data fields.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| --------------------- | ------ | -------- | ------- | --------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BusinessPartnerRole` | string | Yes | — | BP Role |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `ValidFrom` | string | No | — | Validity Start of a BP Role |
| `ValidTo` | string | No | — | Validity End of a BP Role |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BusinessPartnerRole": {
"type": "string",
"description": "BP Role"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"ValidFrom": {
"type": "string",
"description": "Validity Start of a BP Role"
},
"ValidTo": {
"type": "string",
"description": "Validity End of a BP Role"
}
},
"required": [
"PCID",
"BusinessPartner",
"BusinessPartnerRole"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_business\_partner\_tax\_number
Updates tax number data linked to a business partner.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------- | ------ | -------- | ------- | --------------------------- |
| `BusinessPartner` | string | Yes | — | Business Partner Number |
| `BPTaxType` | string | Yes | — | Tax Number Category |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BPTaxLongNumber` | string | No | — | Business Partner Tax Number |
| `BPTaxNumber` | string | No | — | Business Partner Tax Number |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"BusinessPartner": {
"type": "string",
"description": "Business Partner Number"
},
"BPTaxType": {
"type": "string",
"description": "Tax Number Category"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BPTaxLongNumber": {
"type": "string",
"description": "Business Partner Tax Number"
},
"BPTaxNumber": {
"type": "string",
"description": "Business Partner Tax Number"
}
},
"required": [
"PCID",
"BusinessPartner",
"BPTaxType"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_customer
Updates customer general data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| ----------------------------- | ------- | -------- | ------- | ----------------------------------------------------------- |
| `Customer` | string | Yes | — | Customer Number |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BillingIsBlockedForCustomer` | string | No | — | Central billing block for customer |
| `BR_ICMSTaxPayerType` | string | No | — | BR ICMS Tax Payer Type |
| `CityCode` | string | No | — | City Code |
| `County` | string | No | — | The county value |
| `CustomerAccountGroup` | string | No | — | Customer Account Group |
| `CustomerClassification` | string | No | — | Customer Classification |
| `CustomerCorporateGroup` | string | No | — | Customer Corporate Group |
| `DeletionIndicator` | boolean | No | — | Central Deletion Flag for Master Record |
| `DeliveryIsBlocked` | string | No | — | Central delivery block for the customer |
| `ExpressTrainStationName` | string | No | — | Express train station |
| `FiscalAddress` | string | No | — | Account number of the master record with the fiscal address |
| `FreeDefinedAttribute01` | string | No | — | Free Defined Attribute01 |
| `FreeDefinedAttribute02` | string | No | — | Free Defined Attribute02 |
| `FreeDefinedAttribute03` | string | No | — | Free Defined Attribute03 |
| `FreeDefinedAttribute04` | string | No | — | Free Defined Attribute04 |
| `FreeDefinedAttribute05` | string | No | — | Free Defined Attribute05 |
| `FreeDefinedAttribute06` | string | No | — | Free Defined Attribute06 |
| `FreeDefinedAttribute07` | string | No | — | Free Defined Attribute07 |
| `FreeDefinedAttribute08` | string | No | — | Free Defined Attribute08 |
| `FreeDefinedAttribute09` | string | No | — | Free Defined Attribute09 |
| `FreeDefinedAttribute10` | string | No | — | Free Defined Attribute10 |
| `IndustryCode1` | string | No | — | Industry Code1 |
| `IndustryCode2` | string | No | — | Industry Code2 |
| `IndustryCode3` | string | No | — | Industry Code3 |
| `IndustryCode4` | string | No | — | Industry Code4 |
| `IndustryCode5` | string | No | — | Industry Code5 |
| `NielsenRegion` | string | No | — | Nielsen ID |
| `OrderIsBlockedForCustomer` | string | No | — | Central order block for customer |
| `PaymentReason` | string | No | — | Payment Reason |
| `PostingIsBlocked` | boolean | No | — | Central Posting Block |
| `ResponsibleType` | string | No | — | Responsible Type |
| `Supplier` | string | No | — | Account Number of Supplier |
| `TaxNumberType` | string | No | — | Tax Number Type |
| `TrainStationName` | string | No | — | Train Station Name |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Customer": {
"type": "string",
"description": "Customer Number"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BillingIsBlockedForCustomer": {
"type": "string",
"description": "Central billing block for customer"
},
"BR_ICMSTaxPayerType": {
"type": "string",
"description": "BR ICMS Tax Payer Type"
},
"CityCode": {
"type": "string",
"description": "City Code"
},
"County": {
"type": "string",
"description": "The county value"
},
"CustomerAccountGroup": {
"type": "string",
"description": "Customer Account Group"
},
"CustomerClassification": {
"type": "string",
"description": "Customer Classification"
},
"CustomerCorporateGroup": {
"type": "string",
"description": "Customer Corporate Group"
},
"DeletionIndicator": {
"type": "boolean",
"description": "Central Deletion Flag for Master Record"
},
"DeliveryIsBlocked": {
"type": "string",
"description": "Central delivery block for the customer"
},
"ExpressTrainStationName": {
"type": "string",
"description": "Express train station"
},
"FiscalAddress": {
"type": "string",
"description": "Account number of the master record with the fiscal address"
},
"FreeDefinedAttribute01": {
"type": "string",
"description": "Free Defined Attribute01"
},
"FreeDefinedAttribute02": {
"type": "string",
"description": "Free Defined Attribute02"
},
"FreeDefinedAttribute03": {
"type": "string",
"description": "Free Defined Attribute03"
},
"FreeDefinedAttribute04": {
"type": "string",
"description": "Free Defined Attribute04"
},
"FreeDefinedAttribute05": {
"type": "string",
"description": "Free Defined Attribute05"
},
"FreeDefinedAttribute06": {
"type": "string",
"description": "Free Defined Attribute06"
},
"FreeDefinedAttribute07": {
"type": "string",
"description": "Free Defined Attribute07"
},
"FreeDefinedAttribute08": {
"type": "string",
"description": "Free Defined Attribute08"
},
"FreeDefinedAttribute09": {
"type": "string",
"description": "Free Defined Attribute09"
},
"FreeDefinedAttribute10": {
"type": "string",
"description": "Free Defined Attribute10"
},
"IndustryCode1": {
"type": "string",
"description": "Industry Code1"
},
"IndustryCode2": {
"type": "string",
"description": "Industry Code2"
},
"IndustryCode3": {
"type": "string",
"description": "Industry Code3"
},
"IndustryCode4": {
"type": "string",
"description": "Industry Code4"
},
"IndustryCode5": {
"type": "string",
"description": "Industry Code5"
},
"NielsenRegion": {
"type": "string",
"description": "Nielsen ID"
},
"OrderIsBlockedForCustomer": {
"type": "string",
"description": "Central order block for customer"
},
"PaymentReason": {
"type": "string",
"description": "Payment Reason"
},
"PostingIsBlocked": {
"type": "boolean",
"description": "Central Posting Block"
},
"ResponsibleType": {
"type": "string",
"description": "Responsible Type"
},
"Supplier": {
"type": "string",
"description": "Account Number of Supplier"
},
"TaxNumberType": {
"type": "string",
"description": "Tax Number Type"
},
"TrainStationName": {
"type": "string",
"description": "Train Station Name"
}
},
"required": [
"PCID",
"Customer"
]
}
```
***
## sap\_s4hana\_business\_partner\_update\_supplier
Updates supplier general data.
**Parameters:**
| Parameter | Type | Required | Default | Description |
| -------------------------------- | ------- | -------- | ------- | ------------------------------------------------------- |
| `Supplier` | string | Yes | — | Account Number of Supplier |
| `AlternativePayeeAccountNumber` | string | No | — | Account Number of the Alternative Payee |
| `AuthorizationGroup` | string | No | — | Authorization Group |
| `BirthDate` | string | No | — | Date of Birth of the Person Subject to Withholding Tax |
| `BR_TaxIsSplit` | boolean | No | — | Tax Split |
| `BusinessPartnerPanNumber` | string | No | — | Permanent Account Number |
| `Customer` | string | No | — | Customer Number |
| `DataExchangeInstructionKey` | string | No | — | Instruction Key for Data Medium Exchange |
| `DeletionIndicator` | boolean | No | — | Central Deletion Flag for Master Record |
| `FiscalAddress` | string | No | — | Account number of the master record with fiscal address |
| `JP_SuplrAmtInCapitalAmount` | string | No | — | JP Suplr Amt In Capital Amount |
| `JP_SupplierCapitalAmountCrcy` | string | No | — | JP Supplier Capital Amount Crcy |
| `PaymentIsBlockedForSupplier` | boolean | No | — | Payment Block |
| `PaymentReason` | string | No | — | Payment Reason |
| `PostingIsBlocked` | boolean | No | — | Central Posting Block |
| `PurchasingIsBlocked` | boolean | No | — | Centrally imposed purchasing block |
| `ResponsibleType` | string | No | — | Responsible Type |
| `SuplrProofOfDelivRlvtCode` | string | No | — | Supplier indicator relevant for proof of delivery |
| `SuplrQltyInProcmtCertfnValidTo` | string | No | — | Validity Date of Certification |
| `SuplrQualityManagementSystem` | string | No | — | Actual QM System of Supplier |
| `SupplierAccountGroup` | string | No | — | Supplier Account Group |
| `SupplierCorporateGroup` | string | No | — | Supplier Corporate Group |
| `SupplierProcurementBlock` | string | No | — | Function That Will Be Blocked |
| `TaxNumberResponsible` | string | No | — | Tax Number at Responsible Tax Authority |
| `TaxNumberType` | string | No | — | Tax Number Type |
```json theme={null}
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID for the authenticated connection"
},
"Supplier": {
"type": "string",
"description": "Account Number of Supplier"
},
"AlternativePayeeAccountNumber": {
"type": "string",
"description": "Account Number of the Alternative Payee"
},
"AuthorizationGroup": {
"type": "string",
"description": "Authorization Group"
},
"BirthDate": {
"type": "string",
"description": "Date of Birth of the Person Subject to Withholding Tax"
},
"BR_TaxIsSplit": {
"type": "boolean",
"description": "Tax Split"
},
"BusinessPartnerPanNumber": {
"type": "string",
"description": "Permanent Account Number"
},
"Customer": {
"type": "string",
"description": "Customer Number"
},
"DataExchangeInstructionKey": {
"type": "string",
"description": "Instruction Key for Data Medium Exchange"
},
"DeletionIndicator": {
"type": "boolean",
"description": "Central Deletion Flag for Master Record"
},
"FiscalAddress": {
"type": "string",
"description": "Account number of the master record with fiscal address"
},
"JP_SuplrAmtInCapitalAmount": {
"type": "string",
"description": "JP Suplr Amt In Capital Amount"
},
"JP_SupplierCapitalAmountCrcy": {
"type": "string",
"description": "JP Supplier Capital Amount Crcy"
},
"PaymentIsBlockedForSupplier": {
"type": "boolean",
"description": "Payment Block"
},
"PaymentReason": {
"type": "string",
"description": "Payment Reason"
},
"PostingIsBlocked": {
"type": "boolean",
"description": "Central Posting Block"
},
"PurchasingIsBlocked": {
"type": "boolean",
"description": "Centrally imposed purchasing block"
},
"ResponsibleType": {
"type": "string",
"description": "Responsible Type"
},
"SuplrProofOfDelivRlvtCode": {
"type": "string",
"description": "Supplier indicator relevant for proof of delivery"
},
"SuplrQltyInProcmtCertfnValidTo": {
"type": "string",
"description": "Validity Date of Certification"
},
"SuplrQualityManagementSystem": {
"type": "string",
"description": "Actual QM System of Supplier"
},
"SupplierAccountGroup": {
"type": "string",
"description": "Supplier Account Group"
},
"SupplierCorporateGroup": {
"type": "string",
"description": "Supplier Corporate Group"
},
"SupplierProcurementBlock": {
"type": "string",
"description": "Function That Will Be Blocked"
},
"TaxNumberResponsible": {
"type": "string",
"description": "Tax Number at Responsible Tax Authority"
},
"TaxNumberType": {
"type": "string",
"description": "Tax Number Type"
}
},
"required": [
"PCID",
"Supplier"
]
}
```