Skip to content

Latest commit

 

History

History
118 lines (77 loc) · 3.57 KB

MigrationsApi.md

File metadata and controls

118 lines (77 loc) · 3.57 KB

SynergiTech\Sage\MigrationsApi

All URIs are relative to https://api.accounting.sage.com/v3.1, except if the operation defines another base path.

Method HTTP request Description
getMigrations() GET /migrations Returns all Migrations
putMigrations() PUT /migrations Updates a Migrations

getMigrations()

getMigrations(): \SynergiTech\Sage\Model\Migration

Returns all Migrations

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: Settings: Full Access, Read Only

Example

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



$apiInstance = new SynergiTech\Sage\Api\MigrationsApi(
    // 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()
);

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

Parameters

This endpoint does not need any parameter.

Return type

\SynergiTech\Sage\Model\Migration

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

putMigrations()

putMigrations($migrations): \SynergiTech\Sage\Model\Migration

Updates a Migrations

Endpoint Availability * Accounting Plus: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 * Accounting Standard: 🇬🇧, 🇮🇪 * Accounting Start: 🇨🇦, 🇪🇸, 🇫🇷, 🇬🇧, 🇮🇪, 🇺🇸 ### Access Control Restrictions Requires the authenticated user to have any mentioned role in one of the listed areas: * Area: Settings: Full Access

Example

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



$apiInstance = new SynergiTech\Sage\Api\MigrationsApi(
    // 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()
);
$migrations = new \SynergiTech\Sage\Model\PutMigrations(); // \SynergiTech\Sage\Model\PutMigrations

try {
    $result = $apiInstance->putMigrations($migrations);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MigrationsApi->putMigrations: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
migrations \SynergiTech\Sage\Model\PutMigrations

Return type

\SynergiTech\Sage\Model\Migration

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]