spinen/connectwise-finance-php-client

Spinen's PHP ConnectWise Client for Finance API generated by Swagger Code Generator.

dev-master 2017-09-06 18:29 UTC

Requires

• php: >=5.6
• ext-curl: *
• ext-json: *
• ext-mbstring: *

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.6

mit

• Spinen
• Swagger and contributors

• api
• client
• sdk
• spinen
• connectwise

README

ConnectWise Finance API

This PHP package is automatically generated by the Swagger Codegen project:

• API version: 1.0.0
• Package version: 3.0.0-beta
• Build package: io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.6.0 and later

Installation & Usage

Composer

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

composer require spinen/connectwise-finance-php-client

Or modify your composer.json file:

{
    "require": {
        "spinen/connectwise-finance-php-client": "^3.0.0-beta"
    }
}

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/connectwise-finance-php-client/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
Spinen\ConnectWise\Clients\Finance\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Spinen\ConnectWise\Clients\Finance\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Spinen\ConnectWise\Clients\Finance\Api\AccountingBatchesApi();
$conditions = "conditions_example"; // string | 

try {
    $result = $api_instance->financeAccountingBatchesCountGet($conditions);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AccountingBatchesApi->financeAccountingBatchesCountGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api-na.myconnectwise.net/v4_6_release/apis/3.0

Class	Method	HTTP request	Description
AccountingBatchesApi	financeAccountingBatchesCountGet	GET /finance/accounting/batches/count
AccountingBatchesApi	financeAccountingBatchesGet	GET /finance/accounting/batches
AccountingBatchesApi	financeAccountingBatchesIdDelete	DELETE /finance/accounting/batches/{id}
AccountingBatchesApi	financeAccountingBatchesIdExportPost	POST /finance/accounting/batches/{id}/export
AccountingBatchesApi	financeAccountingBatchesIdGet	GET /finance/accounting/batches/{id}
AccountingBatchesApi	financeAccountingBatchesPost	POST /finance/accounting/batches
AccountingBatchesApi	financeAccountingExportPost	POST /finance/accounting/export
AccountingUnpostedExpensesApi	financeAccountingUnpostedexpensesCountGet	GET /finance/accounting/unpostedexpenses/count
AccountingUnpostedExpensesApi	financeAccountingUnpostedexpensesGet	GET /finance/accounting/unpostedexpenses
AccountingUnpostedExpensesApi	financeAccountingUnpostedexpensesIdGet	GET /finance/accounting/unpostedexpenses/{id}
AccountingUnpostedProcurementsApi	financeAccountingUnpostedprocurementCountGet	GET /finance/accounting/unpostedprocurement/count
AccountingUnpostedProcurementsApi	financeAccountingUnpostedprocurementGet	GET /finance/accounting/unpostedprocurement
AccountingUnpostedProcurementsApi	financeAccountingUnpostedprocurementIdGet	GET /finance/accounting/unpostedprocurement/{id}
AccountingUnpostedinvoicesApi	financeAccountingUnpostedinvoicesCountGet	GET /finance/accounting/unpostedinvoices/count
AccountingUnpostedinvoicesApi	financeAccountingUnpostedinvoicesGet	GET /finance/accounting/unpostedinvoices
AccountingUnpostedinvoicesApi	financeAccountingUnpostedinvoicesIdGet	GET /finance/accounting/unpostedinvoices/{id}
AgreementAdditionsApi	financeAgreementsIdAdditionsAdditionIdDelete	DELETE /finance/agreements/{id}/additions/{additionId}
AgreementAdditionsApi	financeAgreementsIdAdditionsAdditionIdGet	GET /finance/agreements/{id}/additions/{additionId}
AgreementAdditionsApi	financeAgreementsIdAdditionsAdditionIdPatch	PATCH /finance/agreements/{id}/additions/{additionId}
AgreementAdditionsApi	financeAgreementsIdAdditionsAdditionIdPut	PUT /finance/agreements/{id}/additions/{additionId}
AgreementAdditionsApi	financeAgreementsIdAdditionsCountGet	GET /finance/agreements/{id}/additions/count
AgreementAdditionsApi	financeAgreementsIdAdditionsGet	GET /finance/agreements/{id}/additions
AgreementAdditionsApi	financeAgreementsIdAdditionsPost	POST /finance/agreements/{id}/additions
AgreementAdjustmentsApi	financeAgreementsIdAdjustmentsAdjustmentIdDelete	DELETE /finance/agreements/{id}/adjustments/{adjustmentId}
AgreementAdjustmentsApi	financeAgreementsIdAdjustmentsAdjustmentIdGet	GET /finance/agreements/{id}/adjustments/{adjustmentId}
AgreementAdjustmentsApi	financeAgreementsIdAdjustmentsAdjustmentIdPatch	PATCH /finance/agreements/{id}/adjustments/{adjustmentId}
AgreementAdjustmentsApi	financeAgreementsIdAdjustmentsAdjustmentIdPut	PUT /finance/agreements/{id}/adjustments/{adjustmentId}
AgreementAdjustmentsApi	financeAgreementsIdAdjustmentsCountGet	GET /finance/agreements/{id}/adjustments/count
AgreementAdjustmentsApi	financeAgreementsIdAdjustmentsGet	GET /finance/agreements/{id}/adjustments
AgreementAdjustmentsApi	financeAgreementsIdAdjustmentsPost	POST /finance/agreements/{id}/adjustments
AgreementBoardDefaultsApi	financeAgreementsIdBoardDefaultsBoardDefaultIdDelete	DELETE /finance/agreements/{id}/boardDefaults/{boardDefaultId}
AgreementBoardDefaultsApi	financeAgreementsIdBoardDefaultsBoardDefaultIdGet	GET /finance/agreements/{id}/boardDefaults/{boardDefaultId}
AgreementBoardDefaultsApi	financeAgreementsIdBoardDefaultsBoardDefaultIdPatch	PATCH /finance/agreements/{id}/boardDefaults/{boardDefaultId}
AgreementBoardDefaultsApi	financeAgreementsIdBoardDefaultsBoardDefaultIdPut	PUT /finance/agreements/{id}/boardDefaults/{boardDefaultId}
AgreementBoardDefaultsApi	financeAgreementsIdBoardDefaultsCountGet	GET /finance/agreements/{id}/boardDefaults/count
AgreementBoardDefaultsApi	financeAgreementsIdBoardDefaultsGet	GET /finance/agreements/{id}/boardDefaults
AgreementBoardDefaultsApi	financeAgreementsIdBoardDefaultsPost	POST /finance/agreements/{id}/boardDefaults
AgreementSitesApi	financeAgreementsIdSitesCountGet	GET /finance/agreements/{id}/sites/count
AgreementSitesApi	financeAgreementsIdSitesGet	GET /finance/agreements/{id}/sites
AgreementSitesApi	financeAgreementsIdSitesPost	POST /finance/agreements/{id}/sites
AgreementSitesApi	financeAgreementsIdSitesSiteIdDelete	DELETE /finance/agreements/{id}/sites/{siteId}
AgreementSitesApi	financeAgreementsIdSitesSiteIdGet	GET /finance/agreements/{id}/sites/{siteId}
AgreementSitesApi	financeAgreementsIdSitesSiteIdPatch	PATCH /finance/agreements/{id}/sites/{siteId}
AgreementSitesApi	financeAgreementsIdSitesSiteIdPut	PUT /finance/agreements/{id}/sites/{siteId}
AgreementTypesApi	financeAgreementsTypesCountGet	GET /finance/agreements/types/count
AgreementTypesApi	financeAgreementsTypesGet	GET /finance/agreements/types
AgreementTypesApi	financeAgreementsTypesIdDelete	DELETE /finance/agreements/types/{id}
AgreementTypesApi	financeAgreementsTypesIdGet	GET /finance/agreements/types/{id}
AgreementTypesApi	financeAgreementsTypesIdPatch	PATCH /finance/agreements/types/{id}
AgreementTypesApi	financeAgreementsTypesIdPut	PUT /finance/agreements/types/{id}
AgreementTypesApi	financeAgreementsTypesPost	POST /finance/agreements/types
AgreementWorkRoleExclusionsApi	financeAgreementsIdWorkRoleExclusionsCountGet	GET /finance/agreements/{id}/workRoleExclusions/count
AgreementWorkRoleExclusionsApi	financeAgreementsIdWorkRoleExclusionsGet	GET /finance/agreements/{id}/workRoleExclusions
AgreementWorkRoleExclusionsApi	financeAgreementsIdWorkRoleExclusionsPost	POST /finance/agreements/{id}/workRoleExclusions
AgreementWorkRoleExclusionsApi	financeAgreementsIdWorkRoleExclusionsWorkRoleExclusionIdDelete	DELETE /finance/agreements/{id}/workRoleExclusions/{workRoleExclusionId}
AgreementWorkRolesApi	financeAgreementsIdWorkrolesCountGet	GET /finance/agreements/{id}/workroles/count
AgreementWorkRolesApi	financeAgreementsIdWorkrolesGet	GET /finance/agreements/{id}/workroles
AgreementWorkRolesApi	financeAgreementsIdWorkrolesPost	POST /finance/agreements/{id}/workroles
AgreementWorkRolesApi	financeAgreementsIdWorkrolesWorkRoleIdDelete	DELETE /finance/agreements/{id}/workroles/{workRoleId}
AgreementWorkRolesApi	financeAgreementsIdWorkrolesWorkRoleIdGet	GET /finance/agreements/{id}/workroles/{workRoleId}
AgreementWorkRolesApi	financeAgreementsIdWorkrolesWorkRoleIdPatch	PATCH /finance/agreements/{id}/workroles/{workRoleId}
AgreementWorkRolesApi	financeAgreementsIdWorkrolesWorkRoleIdPut	PUT /finance/agreements/{id}/workroles/{workRoleId}
AgreementWorkTypeExclusionsApi	financeAgreementsIdWorkTypeExclusionsCountGet	GET /finance/agreements/{id}/workTypeExclusions/count
AgreementWorkTypeExclusionsApi	financeAgreementsIdWorkTypeExclusionsGet	GET /finance/agreements/{id}/workTypeExclusions
AgreementWorkTypeExclusionsApi	financeAgreementsIdWorkTypeExclusionsPost	POST /finance/agreements/{id}/workTypeExclusions
AgreementWorkTypeExclusionsApi	financeAgreementsIdWorkTypeExclusionsWorkTypeExclusionIdDelete	DELETE /finance/agreements/{id}/workTypeExclusions/{workTypeExclusionId}
AgreementWorkTypesApi	financeAgreementsIdWorktypesCountGet	GET /finance/agreements/{id}/worktypes/count
AgreementWorkTypesApi	financeAgreementsIdWorktypesGet	GET /finance/agreements/{id}/worktypes
AgreementWorkTypesApi	financeAgreementsIdWorktypesPost	POST /finance/agreements/{id}/worktypes
AgreementWorkTypesApi	financeAgreementsIdWorktypesWorktypeIdDelete	DELETE /finance/agreements/{id}/worktypes/{worktypeId}
AgreementWorkTypesApi	financeAgreementsIdWorktypesWorktypeIdGet	GET /finance/agreements/{id}/worktypes/{worktypeId}
AgreementWorkTypesApi	financeAgreementsIdWorktypesWorktypeIdPatch	PATCH /finance/agreements/{id}/worktypes/{worktypeId}
AgreementWorkTypesApi	financeAgreementsIdWorktypesWorktypeIdPut	PUT /finance/agreements/{id}/worktypes/{worktypeId}
AgreementsApi	financeAgreementsCountGet	GET /finance/agreements/count
AgreementsApi	financeAgreementsGet	GET /finance/agreements
AgreementsApi	financeAgreementsIdConfigurationsConfigurationIdDelete	DELETE /finance/agreements/{id}/configurations/{configurationId}
AgreementsApi	financeAgreementsIdConfigurationsConfigurationIdGet	GET /finance/agreements/{id}/configurations/{configurationId}
AgreementsApi	financeAgreementsIdConfigurationsCountGet	GET /finance/agreements/{id}/configurations/count
AgreementsApi	financeAgreementsIdConfigurationsGet	GET /finance/agreements/{id}/configurations
AgreementsApi	financeAgreementsIdConfigurationsPost	POST /finance/agreements/{id}/configurations
AgreementsApi	financeAgreementsIdDelete	DELETE /finance/agreements/{id}
AgreementsApi	financeAgreementsIdGet	GET /finance/agreements/{id}
AgreementsApi	financeAgreementsIdPatch	PATCH /finance/agreements/{id}
AgreementsApi	financeAgreementsIdPut	PUT /finance/agreements/{id}
AgreementsApi	financeAgreementsPost	POST /finance/agreements
CurrenciesApi	financeCurrenciesCountGet	GET /finance/currencies/count
CurrenciesApi	financeCurrenciesGet	GET /finance/currencies
CurrenciesApi	financeCurrenciesIdDelete	DELETE /finance/currencies/{id}
CurrenciesApi	financeCurrenciesIdGet	GET /finance/currencies/{id}
CurrenciesApi	financeCurrenciesIdPatch	PATCH /finance/currencies/{id}
CurrenciesApi	financeCurrenciesIdPut	PUT /finance/currencies/{id}
CurrenciesApi	financeCurrenciesPost	POST /finance/currencies
InvoicePaymentsApi	financeInvoicesIdPaymentsGet	GET /finance/invoices/{id}/payments
InvoicePaymentsApi	financeInvoicesIdPaymentsPaymentIdDelete	DELETE /finance/invoices/{id}/payments/{paymentId}
InvoicePaymentsApi	financeInvoicesIdPaymentsPaymentIdGet	GET /finance/invoices/{id}/payments/{paymentId}
InvoicePaymentsApi	financeInvoicesIdPaymentsPaymentIdPatch	PATCH /finance/invoices/{id}/payments/{paymentId}
InvoicePaymentsApi	financeInvoicesIdPaymentsPaymentIdPut	PUT /finance/invoices/{id}/payments/{paymentId}
InvoicePaymentsApi	financeInvoicesIdPaymentsPost	POST /finance/invoices/{id}/payments
InvoicesApi	financeInvoicesCountGet	GET /finance/invoices/count
InvoicesApi	financeInvoicesGet	GET /finance/invoices
InvoicesApi	financeInvoicesIdDelete	DELETE /finance/invoices/{id}
InvoicesApi	financeInvoicesIdGet	GET /finance/invoices/{id}
InvoicesApi	financeInvoicesIdPatch	PATCH /finance/invoices/{id}
InvoicesApi	financeInvoicesIdPdfGet	GET /finance/invoices/{id}/pdf
InvoicesApi	financeInvoicesIdPut	PUT /finance/invoices/{id}
InvoicesApi	financeInvoicesPost	POST /finance/invoices
TaxCodeXRefsApi	financeTaxCodesIdTaxCodeXRefsCountGet	GET /finance/taxCodes/{id}/taxCodeXRefs/count
TaxCodeXRefsApi	financeTaxCodesIdTaxCodeXRefsGet	GET /finance/taxCodes/{id}/taxCodeXRefs
TaxCodeXRefsApi	financeTaxCodesIdTaxCodeXRefsPost	POST /finance/taxCodes/{id}/taxCodeXRefs
TaxCodeXRefsApi	financeTaxCodesIdTaxCodeXRefsTaxCodeXRefIdDelete	DELETE /finance/taxCodes/{id}/taxCodeXRefs/{taxCodeXRefId}
TaxCodeXRefsApi	financeTaxCodesIdTaxCodeXRefsTaxCodeXRefIdGet	GET /finance/taxCodes/{id}/taxCodeXRefs/{taxCodeXRefId}
TaxCodeXRefsApi	financeTaxCodesIdTaxCodeXRefsTaxCodeXRefIdPatch	PATCH /finance/taxCodes/{id}/taxCodeXRefs/{taxCodeXRefId}
TaxCodeXRefsApi	financeTaxCodesIdTaxCodeXRefsTaxCodeXRefIdPut	PUT /finance/taxCodes/{id}/taxCodeXRefs/{taxCodeXRefId}
TaxCodesApi	financeTaxCodesCountGet	GET /finance/taxCodes/count
TaxCodesApi	financeTaxCodesGet	GET /finance/taxCodes
TaxCodesApi	financeTaxCodesIdDelete	DELETE /finance/taxCodes/{id}
TaxCodesApi	financeTaxCodesIdGet	GET /finance/taxCodes/{id}
TaxCodesApi	financeTaxCodesIdPatch	PATCH /finance/taxCodes/{id}
TaxCodesApi	financeTaxCodesIdPut	PUT /finance/taxCodes/{id}
TaxCodesApi	financeTaxCodesPost	POST /finance/taxCodes

Documentation For Models

• AccountingBatch
• Addition
• Adjustment
• Agreement
• AgreementReference
• AgreementSite
• AgreementType
• AgreementTypeReference
• AgreementWorkRole
• AgreementWorkRoleExclusion
• AgreementWorkType
• AgreementWorkTypeExclusion
• BillingStatusReference
• BillingTermsReference
• BoardDefault
• BoardReference
• ChargeCodeReference
• ClassificationReference
• CompanyReference
• CompanyTypeReference
• ConfigurationReference
• ContactReference
• Count
• CountryReference
• CreateAccountingBatchRequest
• Currency
• CurrencyReference
• Error
• ExpenseTypeReference
• ExportAccountingBatchRequest
• GLExport
• GLExportAdjustmentTransaction
• GLExportAdjustmentTransactionDetail
• GLExportCustomer
• GLExportExpense
• GLExportExpenseBill
• GLExportExpenseBillDetail
• GLExportExpenseOffset
• GLExportInventoryTransfer
• GLExportInventoryTransferOffset
• GLExportPurchaseTransaction
• GLExportPurchaseTransactionDetail
• GLExportPurchaseTransactionDetailTax
• GLExportSettings
• GLExportTransaction
• GLExportTransactionDetail
• GLExportVendor
• Invoice
• InvoiceReference
• IvItemReference
• MemberReference
• Metadata
• OpportunityReference
• PatchOperation
• Payment
• PaymentMethodReference
• ProductSubCategoryReference
• ProjectPhaseReference
• ProjectReference
• PurchaseOrderReference
• ServiceTypeReference
• ShipmentMethodReference
• SiteReference
• TaxCode
• TaxCodeReference
• TaxCodeXRef
• TicketReference
• TimeEntryReference
• UnitOfMeasureReference
• UnpostedExpense
• UnpostedInvoice
• UnpostedProcurement
• ValidationError
• WarehouseBinReference
• WarehouseReference
• WorkRoleReference
• WorkTypeReference

Documentation For Authorization

BasicAuth

• Type: HTTP basic authentication