Skip to content

be-lenka/sap_billing-document-rcg2

BranchesTags

Repository files navigation

OpenAPIClient-php

Consumers of this inbound service can read and cancel billing documents inside your system by sending OData requests. In addition, they can request entire billing documents in PDF format. The service makes billing document data available through its header, item, business partner, and pricing element entities.

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?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\BatchRequestsApi(
    // 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
);

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

API Endpoints

All URIs are relative to https://:/sap/opu/odata/sap/API_BILLING_DOCUMENT_SRV

Class Method HTTP request Description
BatchRequestsApi batchPost POST /$batch Send a group of requests
BillingDocumentHeaderApi aBillingDocumentBillingDocumentGet GET /A_BillingDocument('{BillingDocument}') Reads the header of a specific billing document.
BillingDocumentHeaderApi aBillingDocumentBillingDocumentToItemGet GET /A_BillingDocument('{BillingDocument}')/to_Item Reads all items of a specific billing document.
BillingDocumentHeaderApi aBillingDocumentBillingDocumentToPartnerGet GET /A_BillingDocument('{BillingDocument}')/to_Partner Reads the header business partners of a specific billing document.
BillingDocumentHeaderApi aBillingDocumentBillingDocumentToPricingElementGet GET /A_BillingDocument('{BillingDocument}')/to_PricingElement Reads the header pricing elements of a specific billing document.
BillingDocumentHeaderApi aBillingDocumentBillingDocumentToTextGet GET /A_BillingDocument('{BillingDocument}')/to_Text Reads the header texts of a specific billing document.
BillingDocumentHeaderApi aBillingDocumentGet GET /A_BillingDocument Reads all billing document headers.
BillingDocumentHeaderApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemToBillingDocumentGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}')/to_BillingDocument Reads the billing document header for a specific item.
BillingDocumentHeaderApi aBillingDocumentItemPartnerBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPartnerFunctionPartnerFunctionToBillingDocumentGet GET /A_BillingDocumentItemPartner(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PartnerFunction='{PartnerFunction}')/to_BillingDocument Reads the billing document header for a specific item partner function.
BillingDocumentHeaderApi aBillingDocumentItemPrcgElmntBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToBillingDocumentGet GET /A_BillingDocumentItemPrcgElmnt(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_BillingDocument Reads the billing document header for a specific item and pricing element.
BillingDocumentHeaderApi aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionToBillingDocumentGet GET /A_BillingDocumentPartner(BillingDocument='{BillingDocument}',PartnerFunction='{PartnerFunction}')/to_BillingDocument Reads the billing document header for a specific header partner function.
BillingDocumentHeaderApi aBillingDocumentPrcgElmntBillingDocumentBillingDocumentPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToBillingDocumentGet GET /A_BillingDocumentPrcgElmnt(BillingDocument='{BillingDocument}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_BillingDocument Reads the billing document header for a specific header pricing element.
BillingDocumentHeaderApi cancelPost POST /Cancel Cancels one specific billing document.
BillingDocumentHeaderApi getPDFGet GET /GetPDF Retrieves a specific billing document in PDF format.
BillingDocumentItemApi aBillingDocumentBillingDocumentToItemGet GET /A_BillingDocument('{BillingDocument}')/to_Item Reads all items of a specific billing document.
BillingDocumentItemApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}') Reads a specific billing document item.
BillingDocumentItemApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemToBillingDocumentGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}')/to_BillingDocument Reads the billing document header for a specific item.
BillingDocumentItemApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemToItemTextGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}')/to_ItemText Reads the item texts of a specific billing document.
BillingDocumentItemApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemToPartnerGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}')/to_Partner Reads the item business partners of a specific billing document item.
BillingDocumentItemApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemToPricingElementGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}')/to_PricingElement Reads the item pricing elements of a specific billing document item.
BillingDocumentItemApi aBillingDocumentItemGet GET /A_BillingDocumentItem Reads all billing document Items.
BillingDocumentItemApi aBillingDocumentItemPartnerBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPartnerFunctionPartnerFunctionToBillingDocumentItemGet GET /A_BillingDocumentItemPartner(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PartnerFunction='{PartnerFunction}')/to_BillingDocumentItem Reads a billing document item for a specific item partner function.
BillingDocumentItemApi aBillingDocumentItemPrcgElmntBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToBillingDocumentItemGet GET /A_BillingDocumentItemPrcgElmnt(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_BillingDocumentItem Reads a billing document item for a specific item and item-level pricing element.
HeaderPartnerApi aBillingDocumentBillingDocumentToPartnerGet GET /A_BillingDocument('{BillingDocument}')/to_Partner Reads the header business partners of a specific billing document.
HeaderPartnerApi aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionGet GET /A_BillingDocumentPartner(BillingDocument='{BillingDocument}',PartnerFunction='{PartnerFunction}') Reads the header business partners of a specific billing document and with a specific partner function.
HeaderPartnerApi aBillingDocumentPartnerBillingDocumentBillingDocumentPartnerFunctionPartnerFunctionToBillingDocumentGet GET /A_BillingDocumentPartner(BillingDocument='{BillingDocument}',PartnerFunction='{PartnerFunction}')/to_BillingDocument Reads the billing document header for a specific header partner function.
HeaderPartnerApi aBillingDocumentPartnerGet GET /A_BillingDocumentPartner Reads the header business partners of all billing documents.
HeaderPricingElementApi aBillingDocumentBillingDocumentToPricingElementGet GET /A_BillingDocument('{BillingDocument}')/to_PricingElement Reads the header pricing elements of a specific billing document.
HeaderPricingElementApi aBillingDocumentPrcgElmntBillingDocumentBillingDocumentPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterGet GET /A_BillingDocumentPrcgElmnt(BillingDocument='{BillingDocument}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}') Reads the header pricing elements of a specific billing document and specific pricing element.
HeaderPricingElementApi aBillingDocumentPrcgElmntBillingDocumentBillingDocumentPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToBillingDocumentGet GET /A_BillingDocumentPrcgElmnt(BillingDocument='{BillingDocument}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_BillingDocument Reads the billing document header for a specific header pricing element.
HeaderPricingElementApi aBillingDocumentPrcgElmntGet GET /A_BillingDocumentPrcgElmnt Reads header pricing elements of all billing documents.
HeaderTextApi aBillingDocumentBillingDocumentToTextGet GET /A_BillingDocument('{BillingDocument}')/to_Text Reads the header texts of a specific billing document.
HeaderTextApi aBillingDocumentTextBillingDocumentBillingDocumentLanguageLanguageLongTextIDLongTextIDGet GET /A_BillingDocumentText(BillingDocument='{BillingDocument}',Language='{Language}',LongTextID='{LongTextID}') Reads the header texts of a specific billing document for a specific language and long text ID.
HeaderTextApi aBillingDocumentTextGet GET /A_BillingDocumentText Reads the header texts of all billing documents.
ItemPartnerApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemToPartnerGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}')/to_Partner Reads the item business partners of a specific billing document item.
ItemPartnerApi aBillingDocumentItemPartnerBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPartnerFunctionPartnerFunctionGet GET /A_BillingDocumentItemPartner(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PartnerFunction='{PartnerFunction}') Reads item business partners of an item and with a specific partner function in a specific billing document.
ItemPartnerApi aBillingDocumentItemPartnerBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPartnerFunctionPartnerFunctionToBillingDocumentGet GET /A_BillingDocumentItemPartner(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PartnerFunction='{PartnerFunction}')/to_BillingDocument Reads the billing document header for a specific item partner function.
ItemPartnerApi aBillingDocumentItemPartnerBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPartnerFunctionPartnerFunctionToBillingDocumentItemGet GET /A_BillingDocumentItemPartner(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PartnerFunction='{PartnerFunction}')/to_BillingDocumentItem Reads a billing document item for a specific item partner function.
ItemPartnerApi aBillingDocumentItemPartnerGet GET /A_BillingDocumentItemPartner Reads item business partners for all billing documents.
ItemPricingElementApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemToPricingElementGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}')/to_PricingElement Reads the item pricing elements of a specific billing document item.
ItemPricingElementApi aBillingDocumentItemPrcgElmntBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterGet GET /A_BillingDocumentItemPrcgElmnt(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}') Reads the item pricing elements for a specific item and item pricing element.
ItemPricingElementApi aBillingDocumentItemPrcgElmntBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToBillingDocumentGet GET /A_BillingDocumentItemPrcgElmnt(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_BillingDocument Reads the billing document header for a specific item and pricing element.
ItemPricingElementApi aBillingDocumentItemPrcgElmntBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemPricingProcedureStepPricingProcedureStepPricingProcedureCounterPricingProcedureCounterToBillingDocumentItemGet GET /A_BillingDocumentItemPrcgElmnt(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',PricingProcedureStep='{PricingProcedureStep}',PricingProcedureCounter='{PricingProcedureCounter}')/to_BillingDocumentItem Reads a billing document item for a specific item and item-level pricing element.
ItemPricingElementApi aBillingDocumentItemPrcgElmntGet GET /A_BillingDocumentItemPrcgElmnt Reads item pricing elements of all billing documents.
ItemTextApi aBillingDocumentItemBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemToItemTextGet GET /A_BillingDocumentItem(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}')/to_ItemText Reads the item texts of a specific billing document.
ItemTextApi aBillingDocumentItemTextBillingDocumentBillingDocumentBillingDocumentItemBillingDocumentItemLanguageLanguageLongTextIDLongTextIDGet GET /A_BillingDocumentItemText(BillingDocument='{BillingDocument}',BillingDocumentItem='{BillingDocumentItem}',Language='{Language}',LongTextID='{LongTextID}') Reads item texts for a specific language and long text ID.
ItemTextApi aBillingDocumentItemTextGet GET /A_BillingDocumentItemText Reads item texts of all billing documents.

Models

Authorization

Authentication schemes defined for the API:

BasicAuth

  • Type: HTTP basic authentication

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 1.1.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

0 stars

Watchers

1 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

 
 
 

Contributors

Languages