Skip to content

Latest commit

 

History

History
139 lines (96 loc) · 4.31 KB

InvoicesApi.md

File metadata and controls

139 lines (96 loc) · 4.31 KB
Raw

Arta\Client\InvoicesApi

All URIs are relative to https://api.arta.io, except if the operation defines another base path.

Method HTTP request Description
invoicesGet() GET /invoices/{invoice_id} Get an Invoice record
invoicesList() GET /invoices List invoice records

invoicesGet()

invoicesGet($authorization, $invoice_id): \Arta\Client\Model\Invoice

Get an Invoice record

Retrieve an existing Invoice record

Example

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


// Configure API key authorization: apiKeyAuth
$config = Arta\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Arta\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Arta\Client\Api\InvoicesApi(
    // 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
);
$authorization = ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y; // string | Authorize your API calls with an Arta API token
$invoice_id = 56; // int | invoice_id parameter

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

Parameters

Name Type Description Notes
authorization string Authorize your API calls with an Arta API token
invoice_id int invoice_id parameter

Return type

\Arta\Client\Model\Invoice

Authorization

apiKeyAuth

HTTP request headers

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

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

invoicesList()

invoicesList($authorization, $page_size, $page): \Arta\Client\Model\InvoiceList

List invoice records

Retrieve a paginated collection of Invoices belonging to your Organization

Example

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


// Configure API key authorization: apiKeyAuth
$config = Arta\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Arta\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');


$apiInstance = new Arta\Client\Api\InvoicesApi(
    // 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
);
$authorization = ARTA_APIKey s0e1t2e3c4a5s6t7r8o9n10o11m12y; // string | Authorize your API calls with an Arta API token
$page_size = 20; // int | Results per page (max 50)
$page = 1; // int | Page number of the results to fetch.

try {
    $result = $apiInstance->invoicesList($authorization, $page_size, $page);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling InvoicesApi->invoicesList: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
authorization string Authorize your API calls with an Arta API token
page_size int Results per page (max 50) [optional] [default to 20]
page int Page number of the results to fetch. [optional] [default to 1]

Return type

\Arta\Client\Model\InvoiceList

Authorization

apiKeyAuth

HTTP request headers

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

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