OpenAPIClient-php

This service enables you to retrieve and create material documents, for example, to post a goods receipt for a purchase order or to document the transfer of materials between two storage locations. Additionally, the service allows you to cancel existing material documents or single items. It can be consumed by external systems and user interfaces.

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\MaterialDocument\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\MaterialDocument\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\MaterialDocument\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_MATERIAL_DOCUMENT_SRV

Class	Method	HTTP request	Description
BatchRequestsApi	batchPost	POST /$batch	Send a group of requests
DocumentHeaderApi	aMaterialDocumentHeaderGet	GET /A_MaterialDocumentHeader	Reads information on material document header level
DocumentHeaderApi	aMaterialDocumentHeaderMaterialDocumentYearMaterialDocumentYearMaterialDocumentMaterialDocumentGet	GET /A_MaterialDocumentHeader(MaterialDocumentYear='{MaterialDocumentYear}',MaterialDocument='{MaterialDocument}')	Reads information for a specific material document header
DocumentHeaderApi	aMaterialDocumentHeaderMaterialDocumentYearMaterialDocumentYearMaterialDocumentMaterialDocumentToMaterialDocumentItemGet	GET /A_MaterialDocumentHeader(MaterialDocumentYear='{MaterialDocumentYear}',MaterialDocument='{MaterialDocument}')/to_MaterialDocumentItem	Reads information for a specific material document header and material document items
DocumentHeaderApi	aMaterialDocumentHeaderPost	POST /A_MaterialDocumentHeader	Creates a material document
DocumentHeaderApi	aMaterialDocumentItemMaterialDocumentYearMaterialDocumentYearMaterialDocumentMaterialDocumentMaterialDocumentItemMaterialDocumentItemToMaterialDocumentHeaderGet	GET /A_MaterialDocumentItem(MaterialDocumentYear='{MaterialDocumentYear}',MaterialDocument='{MaterialDocument}',MaterialDocumentItem='{MaterialDocumentItem}')/to_MaterialDocumentHeader	Reads information on material document item and header level for a specific material document item
DocumentHeaderApi	cancelPost	POST /Cancel	Cancels a material document
DocumentItemsApi	aMaterialDocumentHeaderMaterialDocumentYearMaterialDocumentYearMaterialDocumentMaterialDocumentToMaterialDocumentItemGet	GET /A_MaterialDocumentHeader(MaterialDocumentYear='{MaterialDocumentYear}',MaterialDocument='{MaterialDocument}')/to_MaterialDocumentItem	Reads information for a specific material document header and material document items
DocumentItemsApi	aMaterialDocumentItemGet	GET /A_MaterialDocumentItem	Reads information on material document items level
DocumentItemsApi	aMaterialDocumentItemMaterialDocumentYearMaterialDocumentYearMaterialDocumentMaterialDocumentMaterialDocumentItemMaterialDocumentItemGet	GET /A_MaterialDocumentItem(MaterialDocumentYear='{MaterialDocumentYear}',MaterialDocument='{MaterialDocument}',MaterialDocumentItem='{MaterialDocumentItem}')	Reads information on material document items level for a specific material document
DocumentItemsApi	aMaterialDocumentItemMaterialDocumentYearMaterialDocumentYearMaterialDocumentMaterialDocumentMaterialDocumentItemMaterialDocumentItemToMaterialDocumentHeaderGet	GET /A_MaterialDocumentItem(MaterialDocumentYear='{MaterialDocumentYear}',MaterialDocument='{MaterialDocument}',MaterialDocumentItem='{MaterialDocumentItem}')/to_MaterialDocumentHeader	Reads information on material document item and header level for a specific material document item
DocumentItemsApi	aMaterialDocumentItemMaterialDocumentYearMaterialDocumentYearMaterialDocumentMaterialDocumentMaterialDocumentItemMaterialDocumentItemToSerialNumbersGet	GET /A_MaterialDocumentItem(MaterialDocumentYear='{MaterialDocumentYear}',MaterialDocument='{MaterialDocument}',MaterialDocumentItem='{MaterialDocumentItem}')/to_SerialNumbers	Reads information on serial numbers for a specific material document item
DocumentItemsApi	cancelItemPost	POST /CancelItem	Cancels a material document item
SerialNumbersApi	aMaterialDocumentItemMaterialDocumentYearMaterialDocumentYearMaterialDocumentMaterialDocumentMaterialDocumentItemMaterialDocumentItemToSerialNumbersGet	GET /A_MaterialDocumentItem(MaterialDocumentYear='{MaterialDocumentYear}',MaterialDocument='{MaterialDocument}',MaterialDocumentItem='{MaterialDocumentItem}')/to_SerialNumbers	Reads information on serial numbers for a specific material document item
SerialNumbersApi	aSerialNumberMaterialDocumentGet	GET /A_SerialNumberMaterialDocument	Reads information of serial numbers on material document items level
SerialNumbersApi	aSerialNumberMaterialDocumentMaterialMaterialSerialNumberSerialNumberMaterialDocumentMaterialDocumentMaterialDocumentItemMaterialDocumentItemMaterialDocumentYearMaterialDocumentYearGet	GET /A_SerialNumberMaterialDocument(Material='{Material}',SerialNumber='{SerialNumber}',MaterialDocument='{MaterialDocument}',MaterialDocumentItem='{MaterialDocumentItem}',MaterialDocumentYear='{MaterialDocumentYear}')	Reads information of serial number on material document item level for a specific material document, item, year and material

Models

• AMaterialDocumentHeaderType
• AMaterialDocumentItemType
• APIMATERIALDOCUMENTSRVAMaterialDocumentHeaderType
• APIMATERIALDOCUMENTSRVAMaterialDocumentHeaderTypeCreate
• APIMATERIALDOCUMENTSRVAMaterialDocumentHeaderTypeCreateToMaterialDocumentItem
• APIMATERIALDOCUMENTSRVAMaterialDocumentHeaderTypeToMaterialDocumentItem
• APIMATERIALDOCUMENTSRVAMaterialDocumentHeaderTypeUpdate
• APIMATERIALDOCUMENTSRVAMaterialDocumentItemType
• APIMATERIALDOCUMENTSRVAMaterialDocumentItemTypeCreate
• APIMATERIALDOCUMENTSRVAMaterialDocumentItemTypeCreateToSerialNumbers
• APIMATERIALDOCUMENTSRVAMaterialDocumentItemTypeToSerialNumbers
• APIMATERIALDOCUMENTSRVAMaterialDocumentItemTypeUpdate
• APIMATERIALDOCUMENTSRVASerialNumberMaterialDocumentType
• APIMATERIALDOCUMENTSRVASerialNumberMaterialDocumentTypeCreate
• APIMATERIALDOCUMENTSRVASerialNumberMaterialDocumentTypeUpdate
• ASerialNumberMaterialDocumentType
• CollectionOfAMaterialDocumentHeaderType
• CollectionOfAMaterialDocumentItemType
• CollectionOfASerialNumberMaterialDocumentType
• Error
• ErrorError
• ErrorErrorMessage
• Wrapper
• Wrapper1
• Wrapper2

Authorization

Authentication schemes defined for the API:

OAuth2Auth

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://{host}:{port}
• Scopes:
  • API_MATERIAL_DOCUMENT_SRV_0001:

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.3.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen