Skip to content

Latest commit

 

History

History
507 lines (357 loc) · 25.4 KB

File metadata and controls

507 lines (357 loc) · 25.4 KB

BeLenka\SAP\BusinessPartner\IdentificationApi

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
aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberDelete() DELETE /A_BuPaIdentification(BusinessPartner='{BusinessPartner}',BPIdentificationType='{BPIdentificationType}',BPIdentificationNumber='{BPIdentificationNumber}') Deletes business partner identification data.
aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberGet() GET /A_BuPaIdentification(BusinessPartner='{BusinessPartner}',BPIdentificationType='{BPIdentificationType}',BPIdentificationNumber='{BPIdentificationNumber}') Retrieves business partner identification data by using key fields.
aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberPatch() PATCH /A_BuPaIdentification(BusinessPartner='{BusinessPartner}',BPIdentificationType='{BPIdentificationType}',BPIdentificationNumber='{BPIdentificationNumber}') Updates business partner identification data.
aBuPaIdentificationGet() GET /A_BuPaIdentification Retrieves business partner identification data.
aBuPaIdentificationPost() POST /A_BuPaIdentification Creates new business partner identification data.
aBusinessPartnerBusinessPartnerToBuPaIdentificationGet() GET /A_BusinessPartner('{BusinessPartner}')/to_BuPaIdentification Retrieves business partner identification data.
aBusinessPartnerBusinessPartnerToBuPaIdentificationPost() POST /A_BusinessPartner('{BusinessPartner}')/to_BuPaIdentification Creates new business partner identification data.

aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberDelete()

aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberDelete($business_partner, $bp_identification_type, $bp_identification_number)

Deletes business partner identification data.

Deletes business partner identification data by using business partner number, identification type, and identification 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\IdentificationApi(
    // 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_identification_type = 'bp_identification_type_example'; // string | Identification Type
$bp_identification_number = 'bp_identification_number_example'; // string | Identification Number

try {
    $apiInstance->aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberDelete($business_partner, $bp_identification_type, $bp_identification_number);
} catch (Exception $e) {
    echo 'Exception when calling IdentificationApi->aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
bp_identification_type string Identification Type
bp_identification_number string Identification Number

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]

aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberGet()

aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberGet($business_partner, $bp_identification_type, $bp_identification_number, $select): \BeLenka\SAP\BusinessPartner\Model\ABuPaIdentificationType

Retrieves business partner identification data by using key fields.

Retrieves business partner identification data using business partner number, identification type, and identification 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\IdentificationApi(
    // 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_identification_type = 'bp_identification_type_example'; // string | Identification Type
$bp_identification_number = 'bp_identification_number_example'; // string | Identification Number
$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->aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberGet($business_partner, $bp_identification_type, $bp_identification_number, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IdentificationApi->aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
bp_identification_type string Identification Type
bp_identification_number string Identification Number
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\ABuPaIdentificationType

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]

aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberPatch()

aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberPatch($business_partner, $bp_identification_type, $bp_identification_number, $modified_abu_pa_identification_type)

Updates business partner identification data.

Updates business partner identification data by using business partner number, identification type, and identification 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\IdentificationApi(
    // 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_identification_type = 'bp_identification_type_example'; // string | Identification Type
$bp_identification_number = 'bp_identification_number_example'; // string | Identification Number
$modified_abu_pa_identification_type = new \BeLenka\SAP\BusinessPartner\Model\ModifiedABuPaIdentificationType(); // \BeLenka\SAP\BusinessPartner\Model\ModifiedABuPaIdentificationType | New property values

try {
    $apiInstance->aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberPatch($business_partner, $bp_identification_type, $bp_identification_number, $modified_abu_pa_identification_type);
} catch (Exception $e) {
    echo 'Exception when calling IdentificationApi->aBuPaIdentificationBusinessPartnerBusinessPartnerBPIdentificationTypeBPIdentificationTypeBPIdentificationNumberBPIdentificationNumberPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
business_partner string Business Partner Number
bp_identification_type string Identification Type
bp_identification_number string Identification Number
modified_abu_pa_identification_type \BeLenka\SAP\BusinessPartner\Model\ModifiedABuPaIdentificationType 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]

aBuPaIdentificationGet()

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

Retrieves business partner identification data.

Retrieves business partner identification data fields of all the records 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\IdentificationApi(
    // 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->aBuPaIdentificationGet($top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IdentificationApi->aBuPaIdentificationGet: ', $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\Wrapper21

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]

aBuPaIdentificationPost()

aBuPaIdentificationPost($apibusinesspartnerabu_pa_identification_type_create): \BeLenka\SAP\BusinessPartner\Model\ABuPaIdentificationType

Creates new business partner identification data.

Creates new identification data record linked to 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\IdentificationApi(
    // 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
);
$apibusinesspartnerabu_pa_identification_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABuPaIdentificationTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABuPaIdentificationTypeCreate | New entity

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

Parameters

Name Type Description Notes
apibusinesspartnerabu_pa_identification_type_create \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABuPaIdentificationTypeCreate New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\ABuPaIdentificationType

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]

aBusinessPartnerBusinessPartnerToBuPaIdentificationGet()

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

Retrieves business partner identification data.

Retrieves business partner identification data fields of all the records 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\IdentificationApi(
    // 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->aBusinessPartnerBusinessPartnerToBuPaIdentificationGet($business_partner, $top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling IdentificationApi->aBusinessPartnerBusinessPartnerToBuPaIdentificationGet: ', $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\Wrapper21

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]

aBusinessPartnerBusinessPartnerToBuPaIdentificationPost()

aBusinessPartnerBusinessPartnerToBuPaIdentificationPost($business_partner, $apibusinesspartnerabu_pa_identification_type_create): \BeLenka\SAP\BusinessPartner\Model\ABuPaIdentificationType

Creates new business partner identification data.

Creates new identification data record linked to 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\IdentificationApi(
    // 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
$apibusinesspartnerabu_pa_identification_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABuPaIdentificationTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERABuPaIdentificationTypeCreate | New entity

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

Parameters

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

Return type

\BeLenka\SAP\BusinessPartner\Model\ABuPaIdentificationType

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]