Skip to content

Latest commit

 

History

History
297 lines (214 loc) · 16.9 KB

File metadata and controls

297 lines (214 loc) · 16.9 KB

BeLenka\SAP\BillingDocumentRCG2\HeaderPartnerApi

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

Method HTTP request Description
aBillingDocumentBillingDocumentToPartnerGet() GET /A_BillingDocument('{BillingDocument}')/to_Partner Reads the header business partners of a specific billing document.
aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionGet() GET /A_BillingDocumentPartner(BillingDocument='{BillingDocument}',PartnerFunction='{PartnerFunction}') Reads the header business partners of a specific billing document and with a specific partner function.
aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionToBillingDocumentGet() GET /A_BillingDocumentPartner(BillingDocument='{BillingDocument}',PartnerFunction='{PartnerFunction}')/to_BillingDocument Reads the billing document header for a specific header partner function.
aBillingDocumentPartnerGet() GET /A_BillingDocumentPartner Reads the header business partners of all billing documents.

aBillingDocumentBillingDocumentToPartnerGet()

aBillingDocumentBillingDocumentToPartnerGet($billing_document, $top, $skip, $filter, $inlinecount, $orderby, $select, $expand): \BeLenka\SAP\BillingDocumentRCG2\Model\Wrapper2

Reads the header business partners of a specific billing document.

Reads the business partner data from the header of a specific billing document, which the consumer specifies by passing the billing document number. Includes fields such as partner function, customer, contact person, and more.

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentRCG2\Api\HeaderPartnerApi(
    // 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
);
$billing_document = 'billing_document_example'; // string | Billing Document
$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)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)

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

Parameters

Name Type Description Notes
billing_document string Billing Document
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]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\BillingDocumentRCG2\Model\Wrapper2

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionGet()

aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionGet($billing_document, $partner_function, $select, $expand): \BeLenka\SAP\BillingDocumentRCG2\Model\ABillingDocumentPartnerType

Reads the header business partners of a specific billing document and with a specific partner function.

Reads header-level business partners with a specific partner function of a specific billing document. Includes fields such as partner function, customer, contact person, and more. Consumers must specify the billing document number and partner function.

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentRCG2\Api\HeaderPartnerApi(
    // 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
);
$billing_document = 'billing_document_example'; // string | Billing Document
$partner_function = 'partner_function_example'; // string | Partner Function
$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)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)

try {
    $result = $apiInstance->aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionGet($billing_document, $partner_function, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HeaderPartnerApi->aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
billing_document string Billing Document
partner_function string Partner Function
select string[] Select properties to be returned, see Select [optional]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\BillingDocumentRCG2\Model\ABillingDocumentPartnerType

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionToBillingDocumentGet()

aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionToBillingDocumentGet($billing_document, $partner_function, $select, $expand): \BeLenka\SAP\BillingDocumentRCG2\Model\ABillingDocumentType

Reads the billing document header for a specific header partner function.

Reads the billing document header fields for a specific header-level partner function. Includes fields such as the document number, billing date, total amount, billing type, and more. Consumers must pass the following key fields: billing document number and partner function.

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentRCG2\Api\HeaderPartnerApi(
    // 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
);
$billing_document = 'billing_document_example'; // string | Billing Document
$partner_function = 'partner_function_example'; // string | Partner Function
$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)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)

try {
    $result = $apiInstance->aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionToBillingDocumentGet($billing_document, $partner_function, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HeaderPartnerApi->aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionToBillingDocumentGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
billing_document string Billing Document
partner_function string Partner Function
select string[] Select properties to be returned, see Select [optional]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\BillingDocumentRCG2\Model\ABillingDocumentType

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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

aBillingDocumentPartnerGet()

aBillingDocumentPartnerGet($top, $skip, $filter, $inlinecount, $orderby, $select, $expand): \BeLenka\SAP\BillingDocumentRCG2\Model\Wrapper2

Reads the header business partners of all billing documents.

Reads business partner data from the headers of all billing documents in the system. Includes fields such as partner function, customer, contact person, and more.

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentRCG2\Api\HeaderPartnerApi(
    // 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)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=63)

try {
    $result = $apiInstance->aBillingDocumentPartnerGet($top, $skip, $filter, $inlinecount, $orderby, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling HeaderPartnerApi->aBillingDocumentPartnerGet: ', $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]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\BillingDocumentRCG2\Model\Wrapper2

Authorization

BasicAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

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