No description, website, or topics provided.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
lib
test
.travis.yml
LICENSE
README.md
autoload.php
composer.json
git_push.sh

README.md

GeneratedRetroTax

No descripton provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

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

  • API version: 2016-12-19T14:06:08Z
  • Package version: 0.0.1
  • Build date: 2017-02-17T16:22:00.483+02:00
  • Build package: class io.swagger.codegen.languages.PhpClientCodegen

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/retrotax/php-api-client.git"
    }
  ],
  "require": {
    "retrotax/php-api-client": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/GeneratedRetroTax/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit lib/Tests

Getting Started

Please follow the installation procedure and then run the following:

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

// Configure API key authorization: api_key
RetroTax\Configuration::getDefaultConfiguration()->setApiKey('x-api-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// RetroTax\Configuration::getDefaultConfiguration()->setApiKeyPrefix('x-api-key', 'Bearer');

$api_instance = new RetroTax\Api\DefaultApi();
$x_auth_token = "x_auth_token_example"; // string | 
$x_auth_iv = "x_auth_iv_example"; // string | 

try {
    $result = $api_instance->applicationStatusesGet($x_auth_token, $x_auth_iv);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->applicationStatusesGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api-qa.retrotax-aci.com

Class Method HTTP request Description
DefaultApi applicationStatusesGet GET /application_statuses
DefaultApi applicationStatusesStatusCodeGet GET /application_statuses/{status_code}
DefaultApi authenticationDelete DELETE /authentication
DefaultApi authenticationPost POST /authentication
DefaultApi authenticationUserDetailsGet GET /authentication/user_details
DefaultApi branchesGet GET /branches
DefaultApi companiesCompanyIdGet GET /companies/{company_id}
DefaultApi companiesCompanyIdLocationsGet GET /companies/{company_id}/locations
DefaultApi companiesCompanyIdLocationsLocationIdGet GET /companies/{company_id}/locations/{location_id}
DefaultApi companiesGet GET /companies
DefaultApi employeesEmployeeIdDocumentsGet GET /employees/{employee_id}/documents
DefaultApi employeesEmployeeIdDocumentsPost POST /employees/{employee_id}/documents
DefaultApi employeesEmployeeIdEsignPut PUT /employees/{employee_id}/esign
DefaultApi employeesEmployeeIdGet GET /employees/{employee_id}
DefaultApi employeesEmployeeIdPayEntriesGet GET /employees/{employee_id}/pay_entries
DefaultApi employeesEmployeeIdPayEntriesPayEntryIdDelete DELETE /employees/{employee_id}/pay_entries/{pay_entry_id}
DefaultApi employeesEmployeeIdPayEntriesPayEntryIdPut PUT /employees/{employee_id}/pay_entries/{pay_entry_id}
DefaultApi employeesEmployeeIdPayEntriesPost POST /employees/{employee_id}/pay_entries
DefaultApi employeesEmployeeIdPut PUT /employees/{employee_id}
DefaultApi employeesGet GET /employees
DefaultApi employeesPost POST /employees
DefaultApi occupationsGet GET /occupations
DefaultApi reportsGet GET /reports
DefaultApi statesGet GET /states
DefaultApi statesStateCodeCountiesGet GET /states/{state_code}/counties
DefaultApi subscriptionsGet GET /subscriptions
DefaultApi subscriptionsPost POST /subscriptions
DefaultApi subscriptionsSubscriptionIdDelete DELETE /subscriptions/{subscription_id}
DefaultApi subscriptionsSubscriptionIdGet GET /subscriptions/{subscription_id}
DefaultApi subscriptionsSubscriptionIdPut PUT /subscriptions/{subscription_id}
DefaultApi subscriptionsTypesGet GET /subscriptions/types
DefaultApi supplementaryProgramStatusesGet GET /supplementary_program_statuses
DefaultApi supplementaryProgramStatusesStatusCodeGet GET /supplementary_program_statuses/{status_code}
DefaultApi supplementaryProgramsGet GET /supplementary_programs
DefaultApi supplementaryProgramsSupplementaryProgramCodeGet GET /supplementary_programs/{supplementary_program_code}
DefaultApi targetGroupsGet GET /target_groups
DefaultApi targetGroupsTargetGroupCodeGet GET /target_groups/{target_group_code}
DefaultApi usersChangePasswordPut PUT /users/change_password
DefaultApi usersForgotPasswordPost POST /users/forgot_password
DefaultApi usersForgotUsernamePost POST /users/forgot_username
DefaultApi usersPut PUT /users
DefaultApi zoneStatusesGet GET /zone_statuses
DefaultApi zoneStatusesStatusCodeGet GET /zone_statuses/{status_code}
DefaultApi zonesGet GET /zones
DefaultApi zonesZoneCodeGet GET /zones/{zone_code}

Documentation For Models

Documentation For Authorization

api_key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

Author