Seacommerce\Unit4\Multivers\Sdk

Unofficial SDK for the UNIT4 Multivers WebApi version 1.10.0 (by Seacommerce).

• API version: 1.10.0
• Package version: 110.0.6

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/Seacommerce/multivers-sdk-php.git"
    }
  ],
  "require": {
    "seacommerce/multivers-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/Seacommerce\Unit4\Multivers\Sdk/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure OAuth2 access token for authorization: production
$config = Seacommerce\Unit4\Multivers\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
// Configure OAuth2 access token for authorization: sandbox
$config = Seacommerce\Unit4\Multivers\Sdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

$apiInstance = new Seacommerce\Unit4\Multivers\Sdk\Api\ContactInfoApi(
    // 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
);
$database = 'database_example'; // string | 
$organizationId = 'organizationId_example'; // string | 
$contactId = 'contactId_example'; // string | 

try {
    $result = $apiInstance->getContactInfoByOrganizationIdAndByContactId($database, $organizationId, $contactId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContactInfoApi->getContactInfoByOrganizationIdAndByContactId: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://sandbox.api.online.unit4.nl/v110

Class	Method	HTTP request	Description
ContactInfoApi	getContactInfoByOrganizationIdAndByContactId	GET /api/{database}/ContactInfo/{organizationId}/{contactId}	Gets the specified ContactInfo.
ContactInfoListApi	getContactInfoListByEmailAndByName	GET /api/{database}/ContactInfoList/{email}/{name}	Gets a list of ContactInfo that matches the specified criteria
ContactInfoListApi	getContactInfoListByOrganizationId	GET /api/{database}/ContactInfoList/{organizationId}	Gets a list of ContactInfo that matches the specified criteria
CustomFieldDefinitionInfoListApi	getCustomFieldDefinitionInfoListByEntities	GET /api/{database}/CustomFieldDefinitionInfoList/{entities}	Gets a list of CustomFieldDefinitionInfo that matches the specified criteria
CustomTableApi	getCustomTableByTableName	GET /api/{database}/CustomTable/{tableName}	Gets the specified CustomTable.
CustomTableApi	updateCustomTableByTableName	PUT /api/{database}/CustomTable/{tableName}	Updates the specified CustomTable
CustomTableInfoListApi	getCustomTableInfoList	GET /api/{database}/CustomTableInfoList	Gets a list of CustomTable that matches the specified criteria
CustomerApi	createCustomer	POST /api/{database}/Customer	Creates a new Customer with the specified values
CustomerApi	deleteCustomer	DELETE /api/{database}/Customer/{customerId}	Deletes the specified Customer
CustomerApi	deleteCustomerAndOrganization	DELETE /api/{database}/Customer/CustomerAndOrganization/{customerId}	Deletes the specified Customer
CustomerApi	getCustomer	GET /api/{database}/Customer/{customerId}	Gets the specified Customer.
CustomerApi	updateCustomer	PUT /api/{database}/Customer/{customerId}	Updates the specified Customer
CustomerGroupInfoApi	getCustomerGroupInfoByCustomerGroupId	GET /api/{database}/CustomerGroupInfo/{customerGroupId}	Gets the specified CustomerGroupInfo.
CustomerGroupInfoListApi	getCustomerGroupInfoList	GET /api/{database}/CustomerGroupInfoList	Gets a list of CustomerGroupInfo that matches the specified criteria
CustomerGroupNVLApi	getCustomerGroupNVL	GET /api/{database}/CustomerGroupNVL	Gets a name value list of CustomerGroupNVL that matches the specified criteria
CustomerInfoApi	getCustomerInfoByCustomerId	GET /api/{database}/CustomerInfo/{customerId}	Gets the specified CustomerInfo.
CustomerInfoListApi	getCustomerInfoList	GET /api/{database}/CustomerInfoList	Gets a list of CustomerInfo that matches the specified criteria
CustomerInvoiceApi	createCustomerInvoice	POST /api/{database}/CustomerInvoice	Creates a new CustomerInvoice with the specified values
CustomerInvoiceApi	deleteCustomerInvoiceByInvoiceId	DELETE /api/{database}/CustomerInvoice/{invoiceId}	Deletes the specified CustomerInvoice
CustomerInvoiceApi	getCustomerInvoiceByInvoiceId	GET /api/{database}/CustomerInvoice/{invoiceId}	Gets the specified CustomerInvoice.
CustomerInvoiceApi	updateCustomerInvoiceByInvoiceId	PUT /api/{database}/CustomerInvoice/{invoiceId}	Updates the specified CustomerInvoice
CustomerInvoiceInfoApi	getCustomerInvoiceInfoByInvoiceId	GET /api/{database}/CustomerInvoiceInfo/{invoiceId}	Gets the specified CustomerInvoiceInfo.
CustomerInvoiceInfoApi	getCustomerInvoiceInfoOnlyHeader	GET /api/{database}/CustomerInvoiceInfo/OnlyHeader/{invoiceId}	Gets the specified CustomerInvoiceInfo.
CustomerNVLApi	getCustomerNVL	GET /api/{database}/CustomerNVL	Gets a name value list of CustomerNVL that matches the specified criteria
CustomerPersonNVLApi	getCustomerPersonNVLByCustomerId	GET /api/{database}/CustomerPersonNVL/{customerId}	Gets a name value list of CustomerPersonNVL that matches the specified criteria
OrderApi	createOrder	POST /api/{database}/Order	Creates a new Order with the specified values
OrderApi	deleteOrder	DELETE /api/{database}/Order/{orderId}	Deletes the specified Order
OrderApi	getOrder	GET /api/{database}/Order/{orderId}	Gets the specified Order.
OrderApi	updateOrder	PUT /api/{database}/Order/{orderId}	Updates the specified Order
OrderChargeVatTypeNVLApi	getOrderChargeVatTypeNVL	GET /api/{database}/OrderChargeVatTypeNVL	Gets a name value list of OrderChargeVatTypeNVL that matches the specified criteria
OrderInfoApi	getOrderInfoByInvoiceId	GET /api/{database}/OrderInfo/ByInvoiceId/{invoiceId}	Gets the specified OrderInfo.
OrderInfoApi	getOrderInfoByOrderId	GET /api/{database}/OrderInfo/{orderId}	Gets the specified OrderInfo.
OrderInfoListApi	getOrderInfoListByCustomerId	GET /api/{database}/OrderInfoList/{customerId}	Gets a list of OrderInfo that matches the specified criteria
OrderInfoListApi	getOrderInfoListByCustomerIdAndByFiscalYear	GET /api/{database}/OrderInfoList/{customerId}/{fiscalYear}	Gets a list of OrderInfo that matches the specified criteria
OrderInfoListApi	getOrderInfoListByCustomerIdAndByMinDateAndByMaxDateAndByMinPriceAndByMaxPriceAndByFiscalYearAndByOnlyOpen	GET /api/{database}/OrderInfoList/{customerId}/{minDate}/{maxDate}/{minPrice}/{maxPrice}/{fiscalYear}/{onlyOpen}	Gets a list of OrderInfo that matches the specified criteria
OrderInfoListApi	getOrderInfoListByProjectId	GET /api/{database}/OrderInfoList/ByProjectId/{projectId}	Gets a list of OrderInfo that matches the specified criteria
OrderInfoListApi	getOrderInfoListOpenOrders	GET /api/{database}/OrderInfoList/OpenOrders	Gets a list of OrderInfo that matches the specified criteria
OrderInfoListApi	getOrderInfoListOrdersForInvoice	GET /api/{database}/OrderInfoList/OrdersForInvoice/{invoiceId}	Gets a list of OrderInfo that matches the specified criteria
OrderInfoListApi	getOrderInfoListOrdersReadyToPrintInvoice	GET /api/{database}/OrderInfoList/OrdersReadyToPrintInvoice	Gets a list of OrderInfo that matches the specified criteria
OrderLineTypeNVLApi	getOrderLineTypeNVL	GET /api/{database}/OrderLineTypeNVL	Gets a name value list of OrderLineTypeNVL that matches the specified criteria
OrderStateNVLApi	getOrderStateNVL	GET /api/{database}/OrderStateNVL	Gets a name value list of OrderStateNVL that matches the specified criteria
OrderTypeNVLApi	getOrderTypeNVL	GET /api/{database}/OrderTypeNVL	Gets a name value list of OrderTypeNVL that matches the specified criteria
PricelistNVLApi	getPricelistNVL	GET /api/{database}/PricelistNVL	Gets a name value list of PricelistNVL that matches the specified criteria
ProductApi	createProduct	POST /api/{database}/Product	Creates a new Product with the specified values
ProductApi	deleteProduct	DELETE /api/{database}/Product/{productId}	Deletes the specified Product
ProductApi	getProduct	GET /api/{database}/Product/{productId}	Gets the specified Product.
ProductApi	updateProduct	PUT /api/{database}/Product/{productId}	Updates the specified Product
ProductDiscountGroupNVLApi	getProductDiscountGroupNVL	GET /api/{database}/ProductDiscountGroupNVL	Gets a name value list of ProductDiscountGroupNVL that matches the specified criteria
ProductGroupApi	createProductGroup	POST /api/{database}/ProductGroup	Creates a new ProductGroup with the specified values
ProductGroupApi	deleteProductGroup	DELETE /api/{database}/ProductGroup/{productGroupId}	Deletes the specified ProductGroup
ProductGroupApi	getProductGroup	GET /api/{database}/ProductGroup/{productGroupId}	Gets the specified ProductGroup.
ProductGroupApi	updateProductGroup	PUT /api/{database}/ProductGroup/{productGroupId}	Updates the specified ProductGroup
ProductGroupNVLApi	getProductGroupNVL	GET /api/{database}/ProductGroupNVL	Gets a name value list of ProductGroupNVL that matches the specified criteria
ProductInfoApi	getProductInfoByProductId	GET /api/{database}/ProductInfo/{productId}	Gets the specified ProductInfo.
ProductInfoListApi	getProductInfoList	GET /api/{database}/ProductInfoList	Gets a list of ProductInfo that matches the specified criteria
ProductNVLApi	getProductNVL	GET /api/{database}/ProductNVL	Gets a name value list of ProductNVL that matches the specified criteria
ProductTypeNVLApi	getProductTypeNVL	GET /api/{database}/ProductTypeNVL	Gets a name value list of ProductTypeNVL that matches the specified criteria
VatCodeInfoListApi	getVatCodeInfoList	GET /api/{database}/VatCodeInfoList	Gets a list of VatCodeInfo that matches the specified criteria
VatCodeNVLApi	getVatCodeNVL	GET /api/{database}/VatCodeNVL	Gets a name value list of VatCodeNVL that matches the specified criteria

Documentation For Models

• Address
• Component
• ContactInfo
• CustomFieldDefinitionInfo
• CustomTable
• CustomTableRow
• Customer
• CustomerGroupInfo
• CustomerInfo
• CustomerInvoice
• CustomerInvoiceInfo
• CustomerInvoiceLine
• CustomerInvoiceLineInfo
• CustomerInvoicePaymentInfo
• DocumentLink
• Order
• OrderInfo
• OrderLine
• OrderLineInfo
• OrderVatLineInfo
• Product
• ProductDescription
• ProductGroup
• ProductGroupRelation
• ProductInfo
• ProductSupplier
• Stock
• SubAdminSpec
• SubAdminSpecEntry
• VatCodeInfo
• VatCodePercentageInfo
• VatTransactionLine

Documentation For Authorization

production

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://api.online.unit4.nl/v110/OAuth/Authorize
• Scopes:
• http://UNIT4.Multivers.API/Web/WebApi/*: Grants access to the entire api.

sandbox

• Type: OAuth
• Flow: accessCode
• Authorization URL: https://sandbox.api.online.unit4.nl/v110/OAuth/Authorize
• Scopes:
• http://UNIT4.Multivers.API/Web/WebApi/*: Grants access to the entire api.

Author