Skip to content

Latest commit

 

History

History
507 lines (359 loc) · 26.4 KB

File metadata and controls

507 lines (359 loc) · 26.4 KB

BeLenka\SAP\BusinessPartner\BPInternationalAddressVersionApi

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
aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeDelete() DELETE /A_BPIntlAddressVersion(BusinessPartner='{BusinessPartner}',AddressID='{AddressID}',AddressRepresentationCode='{AddressRepresentationCode}') Removes the international address version assigned to the business partner by using the key fields.
aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeGet() GET /A_BPIntlAddressVersion(BusinessPartner='{BusinessPartner}',AddressID='{AddressID}',AddressRepresentationCode='{AddressRepresentationCode}') Retrieves business partner international address versions by key fields.
aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodePatch() PATCH /A_BPIntlAddressVersion(BusinessPartner='{BusinessPartner}',AddressID='{AddressID}',AddressRepresentationCode='{AddressRepresentationCode}') Updates a business partner international address version.
aBPIntlAddressVersionGet() GET /A_BPIntlAddressVersion Retrieves business partner international address versions.
aBPIntlAddressVersionPost() POST /A_BPIntlAddressVersion Creates a new business partner international address version.
aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionGet() GET /A_BusinessPartnerAddress(BusinessPartner='{BusinessPartner}',AddressID='{AddressID}')/to_BPIntlAddressVersion Get entities from related to_BPIntlAddressVersion
aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionPost() POST /A_BusinessPartnerAddress(BusinessPartner='{BusinessPartner}',AddressID='{AddressID}')/to_BPIntlAddressVersion Add new entity to related to_BPIntlAddressVersion

aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeDelete()

aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeDelete($business_partner, $address_id, $address_representation_code)

Removes the international address version assigned to the business partner by using the key fields.

Deletes a business partner international address version by BusinessPartner, AddressID and AddressRepresentationCode.

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\BPInternationalAddressVersionApi(
    // 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
$address_id = 'address_id_example'; // string | Address Number
$address_representation_code = 'address_representation_code_example'; // string | Version ID for International Addresses

try {
    $apiInstance->aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeDelete($business_partner, $address_id, $address_representation_code);
} catch (Exception $e) {
    echo 'Exception when calling BPInternationalAddressVersionApi->aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
address_id string Address Number
address_representation_code string Version ID for International Addresses

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]

aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeGet()

aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeGet($business_partner, $address_id, $address_representation_code, $select): \BeLenka\SAP\BusinessPartner\Model\ABPIntlAddressVersionType

Retrieves business partner international address versions by key fields.

Retrieves a business partner international address version by BusinessPartner, AddressID and AddressRepresentationCode.

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\BPInternationalAddressVersionApi(
    // 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
$address_id = 'address_id_example'; // string | Address Number
$address_representation_code = 'address_representation_code_example'; // string | Version ID for International Addresses
$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->aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeGet($business_partner, $address_id, $address_representation_code, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BPInternationalAddressVersionApi->aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodeGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
address_id string Address Number
address_representation_code string Version ID for International Addresses
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\ABPIntlAddressVersionType

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]

aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodePatch()

aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodePatch($business_partner, $address_id, $address_representation_code, $modified_abp_intl_address_version_type)

Updates a business partner international address version.

Updates a business partner international address version by BusinessPartner, AddressID and AddressRepresentationCode.

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\BPInternationalAddressVersionApi(
    // 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
$address_id = 'address_id_example'; // string | Address Number
$address_representation_code = 'address_representation_code_example'; // string | Version ID for International Addresses
$modified_abp_intl_address_version_type = new \BeLenka\SAP\BusinessPartner\Model\ModifiedABPIntlAddressVersionType(); // \BeLenka\SAP\BusinessPartner\Model\ModifiedABPIntlAddressVersionType | New property values

try {
    $apiInstance->aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodePatch($business_partner, $address_id, $address_representation_code, $modified_abp_intl_address_version_type);
} catch (Exception $e) {
    echo 'Exception when calling BPInternationalAddressVersionApi->aBPIntlAddressVersionBusinessPartnerBusinessPartnerAddressIDAddressIDAddressRepresentationCodeAddressRepresentationCodePatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
address_id string Address Number
address_representation_code string Version ID for International Addresses
modified_abp_intl_address_version_type \BeLenka\SAP\BusinessPartner\Model\ModifiedABPIntlAddressVersionType 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]

aBPIntlAddressVersionGet()

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

Retrieves business partner international address versions.

Retrieves business partner international address versions of all the available records 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\BPInternationalAddressVersionApi(
    // 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->aBPIntlAddressVersionGet($top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BPInternationalAddressVersionApi->aBPIntlAddressVersionGet: ', $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\Wrapper18

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]

aBPIntlAddressVersionPost()

aBPIntlAddressVersionPost($apibusinesspartnerabp_intl_address_version_type_create): \BeLenka\SAP\BusinessPartner\Model\ABPIntlAddressVersionType

Creates a new business partner international address version.

Creates a new international address version for 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\BPInternationalAddressVersionApi(
    // 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
);
$apibusinesspartnerabp_intl_address_version_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABPIntlAddressVersionTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABPIntlAddressVersionTypeCreate | New entity

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

Parameters

Name Type Description Notes
apibusinesspartnerabp_intl_address_version_type_create \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABPIntlAddressVersionTypeCreate New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\ABPIntlAddressVersionType

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]

aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionGet()

aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionGet($business_partner, $address_id, $top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\BusinessPartner\Model\Wrapper18

Get entities from related to_BPIntlAddressVersion

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\BPInternationalAddressVersionApi(
    // 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
$address_id = 'address_id_example'; // string | Address 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->aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionGet($business_partner, $address_id, $top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BPInternationalAddressVersionApi->aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
address_id string Address 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\Wrapper18

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]

aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionPost()

aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionPost($business_partner, $address_id, $apibusinesspartnerabp_intl_address_version_type_create): \BeLenka\SAP\BusinessPartner\Model\ABPIntlAddressVersionType

Add new entity to related to_BPIntlAddressVersion

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\BPInternationalAddressVersionApi(
    // 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
$address_id = 'address_id_example'; // string | Address Number
$apibusinesspartnerabp_intl_address_version_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABPIntlAddressVersionTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABPIntlAddressVersionTypeCreate | New entity

try {
    $result = $apiInstance->aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionPost($business_partner, $address_id, $apibusinesspartnerabp_intl_address_version_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BPInternationalAddressVersionApi->aBusinessPartnerAddressBusinessPartnerBusinessPartnerAddressIDAddressIDToBPIntlAddressVersionPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
address_id string Address Number
apibusinesspartnerabp_intl_address_version_type_create \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABPIntlAddressVersionTypeCreate New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\ABPIntlAddressVersionType

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]