OpenAPIClient-php

PowerOffice Go API.

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

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

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/spysystem/poweroffice-go.git"
    }
  ],
  "require": {
    "spysystem/poweroffice-go": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/OpenAPIClient-php/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 HTTP basic authorization: BasicAuth
$config = PowerOfficeGo\Configuration::getDefaultConfiguration()
    ->setUsername('YOUR_USERNAME')
    ->setPassword('YOUR_PASSWORD');

$apiInstance = new PowerOfficeGo\Api\AuthenticateApi(
    // 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
);
$grant_type = 'grant_type_example'; // string | 
$refresh_token = 'refresh_token_example'; // string | 

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

?>

Documentation for API Endpoints

All URIs are relative to https://api-demo.poweroffice.net

Class	Method	HTTP request	Description
AuthenticateApi	getAccessToken	POST /OAuth/Token	Get Access Token
ContactsApi	createOrUpdateContactGroup	POST /ContactGroup	Create or Update Contact Group
ContactsApi	createOrUpdateCustomer	POST /Customer	Create or Update Customer
ContactsApi	createOrUpdateSupplier	POST /Supplier	Create or Update Supplier
ContactsApi	getContactGroup	GET /ContactGroup/{id}	Get Contact Group
ContactsApi	getCustomer	GET /Customer/{id}	Get Customer
ContactsApi	getSupplier	GET /Supplier/{id}	Get Supplier
ContactsApi	searchContactGroups	GET /ContactGroup	Search Contact Groups
ContactsApi	searchCustomers	GET /Customer	Search Customers
ContactsApi	searchSuppliers	GET /Supplier	Search Suppliers
LedgerApi	getCustomerLedger	GET /Reporting/CustomerLedger/{matchId}	Get Customer Ledgers
LedgerApi	searchCustomerLedger	GET /Reporting/CustomerLedger	Search CustomerLedgers
LedgerApi	searchGeneralLedgerAccount	GET /GeneralLedgerAccount	Search GeneralLedgerAccount
LedgerApi	searchVatCode	GET /VatCode	Search Vat Code
VoucherApi	createOrUpdateBankJournalVoucher	POST /Voucher/BankJournalVoucher	Create or Update BankJournalVoucher
VoucherApi	createOrUpdateIncomingInvoiceVoucher	POST /Voucher/IncomingInvoiceVoucher	Create or Update Incoming Invoice Voucher
VoucherApi	createOrUpdateManualJournalVoucher	POST /Voucher/ManualJournalVoucher	Create or Update ManualJournalVoucher
VoucherApi	createOrUpdateOutgoingInvoiceVoucher	POST /Voucher/OutgoingInvoiceVoucher	Create or Update Outgoing Invoice Voucher
VoucherApi	getBankJournalVoucher	GET /Voucher/BankJournalVoucher/{id}	Get BankJournalVoucher
VoucherApi	getIncomingInvoiceVoucher	GET /Voucher/IncomingInvoiceVoucher/{id}	Get Incoming Invoice Voucher
VoucherApi	getManualJournalVoucher	GET /Voucher/ManualJournalVoucher/{id}	Get ManualJournalVoucher
VoucherApi	getOutgoingInvoiceVoucher	GET /Voucher/OutgoingInvoiceVoucher/{id}	Get Outgoing Invoice Voucher
VoucherApi	searchBankJournalVoucher	GET /Voucher/BankJournalVoucher	Search Bank Journal Vouchers
VoucherApi	searchIncomingInvoiceVoucher	GET /Voucher/IncomingInvoiceVoucher	Search Incoming Invoice Vouchers
VoucherApi	searchManualJournalVoucher	GET /Voucher/ManualJournalVoucher	Search Manual Journal Vouchers
VoucherApi	searchOutgoingInvoiceVoucher	GET /Voucher/OutgoingInvoiceVoucher	Search Outgoing Invoice Vouchers

Documentation For Models

• Authentication
• AuthenticationResponse
• BankJournalVoucher
• BankJournalVoucherLine
• BaseResponse
• ContactGroup
• Customer
• CustomerLedgerEntry
• GeneralLedgerAccount
• GetBankJournalVoucherResponse
• GetContactGroupResponse
• GetCustomerLedgerEntryResponse
• GetCustomerResponse
• GetIncomingInvoiceVoucherResponse
• GetManualJournalVoucherResponse
• GetOutgoingInvoiceVoucherResponse
• GetSupplierResponse
• IncomingInvoiceVoucher
• IncomingInvoiceVoucherLine
• MailAddress
• ManualJournalVoucher
• ManualJournalVoucherLine
• OutgoingInvoiceVoucher
• OutgoingInvoiceVoucherLine
• SearchBankJournalVoucherResponse
• SearchContactGroupResponse
• SearchCustomerLedgerEntryResponse
• SearchCustomerResponse
• SearchGeneralLedgerAccountResponse
• SearchIncomingInvoiceVoucherResponse
• SearchManualJournalVoucherResponse
• SearchOutgoingInvoiceVoucherResponse
• SearchSupplierResponse
• SearchVatCodeResponse
• Supplier
• Validation
• VatCode

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication

oAuth

• Type: OAuth
• Flow: application
• Authorization URL:
• Scopes:
• write: allows modifying resources
• read: allows reading resources

Author