BeLenka\SAP\BusinessPartner\AdditionalNamesApi

All URIs are relative to https://:/sap/opu/odata/sap/API_BUSINESS_PARTNER, except if the operation defines another base path.

Method	HTTP request	Description
aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberDelete()	DELETE /A_BusinessPartnerAlias(BusinessPartner='{BusinessPartner}',BPAliasPositionNumber='{BPAliasPositionNumber}')	Deletes a business partner alias.
aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberGet()	GET /A_BusinessPartnerAlias(BusinessPartner='{BusinessPartner}',BPAliasPositionNumber='{BPAliasPositionNumber}')	Retrieves business partner aliases.
aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberPatch()	PATCH /A_BusinessPartnerAlias(BusinessPartner='{BusinessPartner}',BPAliasPositionNumber='{BPAliasPositionNumber}')	Updates a business partner alias.
aBusinessPartnerAliasGet()	GET /A_BusinessPartnerAlias	Retrieves business partner aliases.
aBusinessPartnerAliasPost()	POST /A_BusinessPartnerAlias	Creates business partner aliases.
aBusinessPartnerBusinessPartnerToBusinessPartnerAliasGet()	GET /A_BusinessPartner('{BusinessPartner}')/to_BusinessPartnerAlias	Retrieves business partner aliases.
aBusinessPartnerBusinessPartnerToBusinessPartnerAliasPost()	POST /A_BusinessPartner('{BusinessPartner}')/to_BusinessPartnerAlias	Creates business partner aliases.

`aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberDelete()`

aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberDelete($business_partner, $bp_alias_position_number)

Deletes a business partner alias.

Deletes a business partner alias identified by business partner number and alias position number.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\AdditionalNamesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_partner = 'business_partner_example'; // string | Business Partner Number
$bp_alias_position_number = 'bp_alias_position_number_example'; // string | Items with Business Partner Name/Alias

try {
    $apiInstance->aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberDelete($business_partner, $bp_alias_position_number);
} catch (Exception $e) {
    echo 'Exception when calling AdditionalNamesApi->aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_partner	string	Business Partner Number
bp_alias_position_number	string	Items with Business Partner Name/Alias

Return type

void (empty response body)

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberGet()`

aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberGet($business_partner, $bp_alias_position_number, $select): \BeLenka\SAP\BusinessPartner\Model\ABusinessPartnerAliasType

Retrieves business partner aliases.

Retrieves business partner aliases of all the available records linked to business partners in the system.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\AdditionalNamesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_partner = 'business_partner_example'; // string | Business Partner Number
$bp_alias_position_number = 'bp_alias_position_number_example'; // string | Items with Business Partner Name/Alias
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberGet($business_partner, $bp_alias_position_number, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdditionalNamesApi->aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_partner	string	Business Partner Number
bp_alias_position_number	string	Items with Business Partner Name/Alias
select	string[]	Select properties to be returned, see Select	[optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\ABusinessPartnerAliasType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberPatch()`

aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberPatch($business_partner, $bp_alias_position_number, $modified_a_business_partner_alias_type)

Updates a business partner alias.

Updates a business partner alias identified by business partner number and alias position number.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\AdditionalNamesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_partner = 'business_partner_example'; // string | Business Partner Number
$bp_alias_position_number = 'bp_alias_position_number_example'; // string | Items with Business Partner Name/Alias
$modified_a_business_partner_alias_type = new \BeLenka\SAP\BusinessPartner\Model\ModifiedABusinessPartnerAliasType(); // \BeLenka\SAP\BusinessPartner\Model\ModifiedABusinessPartnerAliasType | New property values

try {
    $apiInstance->aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberPatch($business_partner, $bp_alias_position_number, $modified_a_business_partner_alias_type);
} catch (Exception $e) {
    echo 'Exception when calling AdditionalNamesApi->aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description
business_partner	string	Business Partner Number
bp_alias_position_number	string	Items with Business Partner Name/Alias
modified_a_business_partner_alias_type	\BeLenka\SAP\BusinessPartner\Model\ModifiedABusinessPartnerAliasType	New property values

Return type

void (empty response body)

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`aBusinessPartnerAliasGet()`

aBusinessPartnerAliasGet($top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\BusinessPartner\Model\Wrapper25

Retrieves business partner aliases.

Retrieves business partner aliases of all the available records linked to business partners in the system.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\AdditionalNamesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$top = 50; // int | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)
$inlinecount = 'inlinecount_example'; // string | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aBusinessPartnerAliasGet($top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdditionalNamesApi->aBusinessPartnerAliasGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
top	int	Show only the first n items, see Paging - Top	[optional]
skip	int	Skip the first n items, see Paging - Skip	[optional]
filter	string	Filter items by property values, see Filtering	[optional]
inlinecount	string	Include count of items, see Inlinecount	[optional]
orderby	string[]	Order items by property values, see Sorting	[optional]
select	string[]	Select properties to be returned, see Select	[optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\Wrapper25

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`aBusinessPartnerAliasPost()`

aBusinessPartnerAliasPost($apibusinesspartnera_business_partner_alias_type_create): \BeLenka\SAP\BusinessPartner\Model\ABusinessPartnerAliasType

Creates business partner aliases.

Creates business partner aliases linked to an existing business partner.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\AdditionalNamesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$apibusinesspartnera_business_partner_alias_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABusinessPartnerAliasTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABusinessPartnerAliasTypeCreate | New entity

try {
    $result = $apiInstance->aBusinessPartnerAliasPost($apibusinesspartnera_business_partner_alias_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdditionalNamesApi->aBusinessPartnerAliasPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
apibusinesspartnera_business_partner_alias_type_create	\BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABusinessPartnerAliasTypeCreate	New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\ABusinessPartnerAliasType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`aBusinessPartnerBusinessPartnerToBusinessPartnerAliasGet()`

aBusinessPartnerBusinessPartnerToBusinessPartnerAliasGet($business_partner, $top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\BusinessPartner\Model\Wrapper25

Retrieves business partner aliases.

Retrieves business partner aliases of all the available records linked to business partners in the system.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\AdditionalNamesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_partner = 'business_partner_example'; // string | Business Partner Number
$top = 50; // int | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)
$inlinecount = 'inlinecount_example'; // string | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aBusinessPartnerBusinessPartnerToBusinessPartnerAliasGet($business_partner, $top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdditionalNamesApi->aBusinessPartnerBusinessPartnerToBusinessPartnerAliasGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_partner	string	Business Partner Number
top	int	Show only the first n items, see Paging - Top	[optional]
skip	int	Skip the first n items, see Paging - Skip	[optional]
filter	string	Filter items by property values, see Filtering	[optional]
inlinecount	string	Include count of items, see Inlinecount	[optional]
orderby	string[]	Order items by property values, see Sorting	[optional]
select	string[]	Select properties to be returned, see Select	[optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\Wrapper25

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`aBusinessPartnerBusinessPartnerToBusinessPartnerAliasPost()`

aBusinessPartnerBusinessPartnerToBusinessPartnerAliasPost($business_partner, $apibusinesspartnera_business_partner_alias_type_create): \BeLenka\SAP\BusinessPartner\Model\ABusinessPartnerAliasType

Creates business partner aliases.

Creates business partner aliases linked to an existing business partner.

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\BusinessPartner\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\AdditionalNamesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$business_partner = 'business_partner_example'; // string | Business Partner Number
$apibusinesspartnera_business_partner_alias_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABusinessPartnerAliasTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABusinessPartnerAliasTypeCreate | New entity

try {
    $result = $apiInstance->aBusinessPartnerBusinessPartnerToBusinessPartnerAliasPost($business_partner, $apibusinesspartnera_business_partner_alias_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AdditionalNamesApi->aBusinessPartnerBusinessPartnerToBusinessPartnerAliasPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
business_partner	string	Business Partner Number
apibusinesspartnera_business_partner_alias_type_create	\BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABusinessPartnerAliasTypeCreate	New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\ABusinessPartnerAliasType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

AdditionalNamesApi.md

Latest commit

History

AdditionalNamesApi.md

File metadata and controls

BeLenka\SAP\BusinessPartner\AdditionalNamesApi

aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberDelete()

Example

Parameters

Return type

Authorization

HTTP request headers

aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberGet()

Example

Parameters

Return type

Authorization

HTTP request headers

aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberPatch()

Example

Parameters

Return type

Authorization

HTTP request headers

aBusinessPartnerAliasGet()

Example

Parameters

Return type

Authorization

HTTP request headers

aBusinessPartnerAliasPost()

Example

Parameters

Return type

Authorization

HTTP request headers

aBusinessPartnerBusinessPartnerToBusinessPartnerAliasGet()

Example

Parameters

Return type

Authorization

HTTP request headers

aBusinessPartnerBusinessPartnerToBusinessPartnerAliasPost()

Example

Parameters

Return type

Authorization

HTTP request headers

`aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberDelete()`

`aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberGet()`

`aBusinessPartnerAliasBusinessPartnerBusinessPartnerBPAliasPositionNumberBPAliasPositionNumberPatch()`

`aBusinessPartnerAliasGet()`

`aBusinessPartnerAliasPost()`

`aBusinessPartnerBusinessPartnerToBusinessPartnerAliasGet()`

`aBusinessPartnerBusinessPartnerToBusinessPartnerAliasPost()`