Skip to content

Latest commit

 

History

History
499 lines (363 loc) · 27.3 KB

ItemsApi.md

File metadata and controls

499 lines (363 loc) · 27.3 KB

BeLenka\SAP\BillingDocumentODV4\ItemsApi

All URIs are relative to https://:/sap/opu/odata4/sap/api_billingdocument/srvd_a2x/sap/billingdocument/0001, except if the operation defines another base path.

Method HTTP request Description
billingDocumentBillingDocumentItemGet() GET /BillingDocument/{BillingDocument}/_Item Get entities from related _Item
billingDocumentItemBillingDocumentBillingDocumentItemBillingDocumentGet() GET /BillingDocumentItem/{BillingDocument}/{BillingDocumentItem}/_BillingDocument Get related _BillingDocument
billingDocumentItemBillingDocumentBillingDocumentItemGet() GET /BillingDocumentItem/{BillingDocument}/{BillingDocumentItem} Get entity from BillingDocumentItem by key
billingDocumentItemBillingDocumentBillingDocumentItemItemPartnerGet() GET /BillingDocumentItem/{BillingDocument}/{BillingDocumentItem}/_ItemPartner Get entities from related _ItemPartner
billingDocumentItemBillingDocumentBillingDocumentItemPatch() PATCH /BillingDocumentItem/{BillingDocument}/{BillingDocumentItem} Update entity in BillingDocumentItem
billingDocumentItemGet() GET /BillingDocumentItem Get entities from BillingDocumentItem
billingDocumentItemPartnerBillingDocumentBillingDocumentItemPartnerFunctionItemGet() GET /BillingDocumentItemPartner/{BillingDocument}/{BillingDocumentItem}/{PartnerFunction}/_Item Get related _Item

billingDocumentBillingDocumentItemGet()

billingDocumentBillingDocumentItemGet($billing_document, $top, $skip, $filter, $count, $orderby, $select, $expand): \BeLenka\SAP\BillingDocumentODV4\Model\CollectionOfBillingDocumentItemType

Get entities from related _Item

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentODV4\Api\ItemsApi(
    // 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](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)
$count = True; // bool | Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

try {
    $result = $apiInstance->billingDocumentBillingDocumentItemGet($billing_document, $top, $skip, $filter, $count, $orderby, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->billingDocumentBillingDocumentItemGet: ', $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]
count bool Include count of items, see Count [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\BillingDocumentODV4\Model\CollectionOfBillingDocumentItemType

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]

billingDocumentItemBillingDocumentBillingDocumentItemBillingDocumentGet()

billingDocumentItemBillingDocumentBillingDocumentItemBillingDocumentGet($billing_document, $billing_document_item, $select, $expand): \BeLenka\SAP\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentType

Get related _BillingDocument

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentODV4\Api\ItemsApi(
    // 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
$billing_document_item = 'billing_document_item_example'; // string | Billing Item
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

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

Parameters

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

Return type

\BeLenka\SAP\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentType

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]

billingDocumentItemBillingDocumentBillingDocumentItemGet()

billingDocumentItemBillingDocumentBillingDocumentItemGet($billing_document, $billing_document_item, $select, $expand): \BeLenka\SAP\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentItemType

Get entity from BillingDocumentItem by key

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentODV4\Api\ItemsApi(
    // 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
$billing_document_item = 'billing_document_item_example'; // string | Billing Item
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

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

Parameters

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

Return type

\BeLenka\SAP\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentItemType

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]

billingDocumentItemBillingDocumentBillingDocumentItemItemPartnerGet()

billingDocumentItemBillingDocumentBillingDocumentItemItemPartnerGet($billing_document, $billing_document_item, $top, $skip, $filter, $count, $orderby, $select, $expand): \BeLenka\SAP\BillingDocumentODV4\Model\CollectionOfBillingDocumentItemPartnerType

Get entities from related _ItemPartner

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentODV4\Api\ItemsApi(
    // 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
$billing_document_item = 'billing_document_item_example'; // string | Billing Item
$top = 50; // int | Show only the first n items, see [Paging - Top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)
$count = True; // bool | Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

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

Parameters

Name Type Description Notes
billing_document string Billing Document
billing_document_item string Billing Item
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]
count bool Include count of items, see Count [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\BillingDocumentODV4\Model\CollectionOfBillingDocumentItemPartnerType

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]

billingDocumentItemBillingDocumentBillingDocumentItemPatch()

billingDocumentItemBillingDocumentBillingDocumentItemPatch($billing_document, $billing_document_item, $com_sap_gateway_srvd_a2x_api_billingdocument_v0001_billing_document_item_type_update)

Update entity in BillingDocumentItem

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentODV4\Api\ItemsApi(
    // 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
$billing_document_item = 'billing_document_item_example'; // string | Billing Item
$com_sap_gateway_srvd_a2x_api_billingdocument_v0001_billing_document_item_type_update = new \BeLenka\SAP\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentItemTypeUpdate(); // \BeLenka\SAP\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentItemTypeUpdate | New property values

try {
    $apiInstance->billingDocumentItemBillingDocumentBillingDocumentItemPatch($billing_document, $billing_document_item, $com_sap_gateway_srvd_a2x_api_billingdocument_v0001_billing_document_item_type_update);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->billingDocumentItemBillingDocumentBillingDocumentItemPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
billing_document string Billing Document
billing_document_item string Billing Item
com_sap_gateway_srvd_a2x_api_billingdocument_v0001_billing_document_item_type_update \BeLenka\SAP\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentItemTypeUpdate New property values

Return type

void (empty response body)

Authorization

BasicAuth

HTTP request headers

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

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

billingDocumentItemGet()

billingDocumentItemGet($top, $skip, $filter, $count, $orderby, $select, $expand): \BeLenka\SAP\BillingDocumentODV4\Model\CollectionOfBillingDocumentItemType

Get entities from BillingDocumentItem

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentODV4\Api\ItemsApi(
    // 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](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)
$count = True; // bool | Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

try {
    $result = $apiInstance->billingDocumentItemGet($top, $skip, $filter, $count, $orderby, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemsApi->billingDocumentItemGet: ', $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]
count bool Include count of items, see Count [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\BillingDocumentODV4\Model\CollectionOfBillingDocumentItemType

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]

billingDocumentItemPartnerBillingDocumentBillingDocumentItemPartnerFunctionItemGet()

billingDocumentItemPartnerBillingDocumentBillingDocumentItemPartnerFunctionItemGet($billing_document, $billing_document_item, $partner_function, $select, $expand): \BeLenka\SAP\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentItemType

Get related _Item

Example

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


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


$apiInstance = new BeLenka\SAP\BillingDocumentODV4\Api\ItemsApi(
    // 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
$billing_document_item = 'billing_document_item_example'; // string | Billing Item
$partner_function = 'partner_function_example'; // string | Partner Function
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

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

Parameters

Name Type Description Notes
billing_document string Billing Document
billing_document_item string Billing Item
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\BillingDocumentODV4\Model\ComSapGatewaySrvdA2xApiBillingdocumentV0001BillingDocumentItemType

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]