SpringImport\Swagger\Magento2\Client\SalesInvoiceManagementV1Api

May 18, 2017 ยท View on GitHub

All URIs are relative to http://t213.vg/rest/default

MethodHTTP requestDescription
salesInvoiceManagementV1GetCommentsListGetGET /V1/invoices/{id}/comments
salesInvoiceManagementV1NotifyPostPOST /V1/invoices/{id}/emails
salesInvoiceManagementV1SetCapturePostPOST /V1/invoices/{id}/capture
salesInvoiceManagementV1SetVoidPostPOST /V1/invoices/{id}/void

salesInvoiceManagementV1GetCommentsListGet

\SpringImport\Swagger\Magento2\Client\Model\SalesDataInvoiceCommentSearchResultInterface salesInvoiceManagementV1GetCommentsListGet($id)

Lists comments for a specified invoice.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesInvoiceManagementV1Api();
$id = 56; // int | The invoice ID.

try {
    $result = $api_instance->salesInvoiceManagementV1GetCommentsListGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesInvoiceManagementV1Api->salesInvoiceManagementV1GetCommentsListGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
idintThe invoice ID.

Return type

\SpringImport\Swagger\Magento2\Client\Model\SalesDataInvoiceCommentSearchResultInterface

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

salesInvoiceManagementV1NotifyPost

bool salesInvoiceManagementV1NotifyPost($id)

Emails a user a specified invoice.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesInvoiceManagementV1Api();
$id = 56; // int | The invoice ID.

try {
    $result = $api_instance->salesInvoiceManagementV1NotifyPost($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesInvoiceManagementV1Api->salesInvoiceManagementV1NotifyPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
idintThe invoice ID.

Return type

bool

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

salesInvoiceManagementV1SetCapturePost

string salesInvoiceManagementV1SetCapturePost($id)

Sets invoice capture.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesInvoiceManagementV1Api();
$id = 56; // int | 

try {
    $result = $api_instance->salesInvoiceManagementV1SetCapturePost($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesInvoiceManagementV1Api->salesInvoiceManagementV1SetCapturePost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
idint

Return type

string

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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

salesInvoiceManagementV1SetVoidPost

bool salesInvoiceManagementV1SetVoidPost($id)

Voids a specified invoice.

Example

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

$api_instance = new SpringImport\Swagger\Magento2\Client\Api\SalesInvoiceManagementV1Api();
$id = 56; // int | The invoice ID.

try {
    $result = $api_instance->salesInvoiceManagementV1SetVoidPost($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SalesInvoiceManagementV1Api->salesInvoiceManagementV1SetVoidPost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

NameTypeDescriptionNotes
idintThe invoice ID.

Return type

bool

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

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