VereTech\SyncroMSP_PHPclient\Client\ScheduleApi

All URIs are relative to https://{subdomain}.syncromsp.com/api/v1

Method	HTTP request	Description
schedulesGet	GET /schedules	Returns a paginated list of Invoice Schedules
schedulesIdAddLineItemPost	POST /schedules/{id}/add_line_item	Adds a Line Item to an Invoice Schedule
schedulesIdDelete	DELETE /schedules/{id}	Deletes a Schedule by ID
schedulesIdGet	GET /schedules/{id}	Retrieves a Schedule by ID
schedulesIdLineItemsScheduleLineItemIdPut	PUT /schedules/{id}/line_items/{schedule_line_item_id}	Updates a Line Item
schedulesIdPut	PUT /schedules/{id}	Updates an existing Invoice Schedule by ID
schedulesIdRemoveLineItemPost	POST /schedules/{id}/remove_line_item	Removes a Line Item from an Invoice Schedule
schedulesPost	POST /schedules	Creates an Invoice Schedule

schedulesGet

schedulesGet($customer_id, $page)

Returns a paginated list of Invoice Schedules

Required permission: Recurring Invoices - List

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\ScheduleApi(
    // 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
);
$customer_id = 56; // int | Returns a list of Schedules that belong to a Customer ID
$page = 56; // int | Returns provided page of results, each 'page' contains 25 results

try {
    $apiInstance->schedulesGet($customer_id, $page);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
customer_id	int	Returns a list of Schedules that belong to a Customer ID	[optional]
page	int	Returns provided page of results, each 'page' contains 25 results	[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

schedulesIdAddLineItemPost

schedulesIdAddLineItemPost($id, $body)

Adds a Line Item to an Invoice Schedule

Required permission: Recurring Invoices - Edit

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\ScheduleApi(
    // 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
);
$id = 56; // int | 
$body = new \stdClass; // object | 

try {
    $apiInstance->schedulesIdAddLineItemPost($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulesIdAddLineItemPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
body	object		[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

schedulesIdDelete

schedulesIdDelete($id)

Deletes a Schedule by ID

Required permission: Recurring Invoices - Delete

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\ScheduleApi(
    // 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
);
$id = 56; // int | 

try {
    $apiInstance->schedulesIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulesIdDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

schedulesIdGet

schedulesIdGet($id)

Retrieves a Schedule by ID

Required permission: Recurring Invoices - List

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\ScheduleApi(
    // 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
);
$id = 56; // int | 

try {
    $apiInstance->schedulesIdGet($id);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulesIdGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

schedulesIdLineItemsScheduleLineItemIdPut

schedulesIdLineItemsScheduleLineItemIdPut($id, $schedule_line_item_id, $body)

Updates a Line Item

Required permission: Recurring Invoices - Edit

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\ScheduleApi(
    // 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
);
$id = 56; // int | 
$schedule_line_item_id = 56; // int | ID of line item to update
$body = new \stdClass; // object | 

try {
    $apiInstance->schedulesIdLineItemsScheduleLineItemIdPut($id, $schedule_line_item_id, $body);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulesIdLineItemsScheduleLineItemIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
schedule_line_item_id	int	ID of line item to update
body	object		[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

schedulesIdPut

schedulesIdPut($id, $body)

Updates an existing Invoice Schedule by ID

Required permission: Recurring Invoices - Edit

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\ScheduleApi(
    // 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
);
$id = 56; // int | 
$body = new \stdClass; // object | 

try {
    $apiInstance->schedulesIdPut($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulesIdPut: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
body	object		[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

schedulesIdRemoveLineItemPost

schedulesIdRemoveLineItemPost($id, $body)

Removes a Line Item from an Invoice Schedule

Required permission: Recurring Invoices - Edit

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\ScheduleApi(
    // 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
);
$id = 56; // int | 
$body = 56; // int | 

try {
    $apiInstance->schedulesIdRemoveLineItemPost($id, $body);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulesIdRemoveLineItemPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int
body	int		[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

Content-Type: application/json
Accept: Not defined

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

schedulesPost

schedulesPost($body)

Creates an Invoice Schedule

Required permission: Recurring Invoices - New

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: bearerAuth
$config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = VereTech\SyncroMSP_PHPclient\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new VereTech\SyncroMSP_PHPclient\Client\Api\ScheduleApi(
    // 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
);
$body = new \stdClass; // object | 

try {
    $apiInstance->schedulesPost($body);
} catch (Exception $e) {
    echo 'Exception when calling ScheduleApi->schedulesPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
body	object		[optional]

Return type

void (empty response body)

Authorization

bearerAuth

HTTP request headers

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

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

Files

ScheduleApi.md

Latest commit

History

ScheduleApi.md

File metadata and controls

VereTech\SyncroMSP_PHPclient\Client\ScheduleApi

schedulesGet

Example

Parameters

Return type

Authorization

HTTP request headers

schedulesIdAddLineItemPost

Example

Parameters

Return type

Authorization

HTTP request headers

schedulesIdDelete

Example

Parameters

Return type

Authorization

HTTP request headers

schedulesIdGet

Example

Parameters

Return type

Authorization

HTTP request headers

schedulesIdLineItemsScheduleLineItemIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

schedulesIdPut

Example

Parameters

Return type

Authorization

HTTP request headers

schedulesIdRemoveLineItemPost

Example

Parameters

Return type

Authorization

HTTP request headers

schedulesPost

Example

Parameters

Return type

Authorization

HTTP request headers