Tripletex\LedgerpaymentTypeOutApi

All URIs are relative to https://tripletex.no/v2

Method	HTTP request	Description
delete	DELETE /ledger/paymentTypeOut/{id}	[BETA] Delete payment type for outgoing payments by ID.
get	GET /ledger/paymentTypeOut/{id}	[BETA] Get payment type for outgoing payments by ID.
post	POST /ledger/paymentTypeOut	[BETA] Create new payment type for outgoing payments
postList	POST /ledger/paymentTypeOut/list	[BETA] Create multiple payment types for outgoing payments at once
put	PUT /ledger/paymentTypeOut/{id}	[BETA] Update existing payment type for outgoing payments
putList	PUT /ledger/paymentTypeOut/list	[BETA] Update multiple payment types for outgoing payments at once
search	GET /ledger/paymentTypeOut	[BETA] Gets payment types for outgoing payments

delete

delete($id)

[BETA] Delete payment type for outgoing payments by ID.

Example

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

// Configure HTTP basic authorization: tokenAuthScheme
$config = Tripletex\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Tripletex\Api\LedgerpaymentTypeOutApi(
    // 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 | Element ID

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

Parameters

Name	Type	Description	Notes
id	int	Element ID

Return type

void (empty response body)

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

get

\Tripletex\Model\ResponseWrapperPaymentTypeOut get($id, $fields)

[BETA] Get payment type for outgoing payments by ID.

Example

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

// Configure HTTP basic authorization: tokenAuthScheme
$config = Tripletex\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Tripletex\Api\LedgerpaymentTypeOutApi(
    // 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 | Element ID
$fields = "fields_example"; // string | Fields filter pattern

try {
    $result = $apiInstance->get($id, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LedgerpaymentTypeOutApi->get: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	Element ID
fields	string	Fields filter pattern	[optional]

Return type

\Tripletex\Model\ResponseWrapperPaymentTypeOut

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

post

\Tripletex\Model\ResponseWrapperPaymentTypeOut post($body)

[BETA] Create new payment type for outgoing payments

Example

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

// Configure HTTP basic authorization: tokenAuthScheme
$config = Tripletex\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Tripletex\Api\LedgerpaymentTypeOutApi(
    // 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 \Tripletex\Model\PaymentTypeOut(); // \Tripletex\Model\PaymentTypeOut | JSON representing the new object to be created. Should not have ID and version set.

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

Parameters

Name	Type	Description	Notes
body	\Tripletex\Model\PaymentTypeOut	JSON representing the new object to be created. Should not have ID and version set.	[optional]

Return type

\Tripletex\Model\ResponseWrapperPaymentTypeOut

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: Not defined

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

postList

\Tripletex\Model\ListResponsePaymentTypeOut postList($body)

[BETA] Create multiple payment types for outgoing payments at once

Example

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

// Configure HTTP basic authorization: tokenAuthScheme
$config = Tripletex\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Tripletex\Api\LedgerpaymentTypeOutApi(
    // 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 = array(new \Tripletex\Model\PaymentTypeOut()); // \Tripletex\Model\PaymentTypeOut[] | JSON representing a list of new object to be created. Should not have ID and version set.

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

Parameters

Name	Type	Description	Notes
body	\Tripletex\Model\PaymentTypeOut[]	JSON representing a list of new object to be created. Should not have ID and version set.	[optional]

Return type

\Tripletex\Model\ListResponsePaymentTypeOut

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: Not defined

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

put

\Tripletex\Model\ResponseWrapperPaymentTypeOut put($id, $body)

[BETA] Update existing payment type for outgoing payments

Example

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

// Configure HTTP basic authorization: tokenAuthScheme
$config = Tripletex\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Tripletex\Api\LedgerpaymentTypeOutApi(
    // 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 | Element ID
$body = new \Tripletex\Model\PaymentTypeOut(); // \Tripletex\Model\PaymentTypeOut | Partial object describing what should be updated

try {
    $result = $apiInstance->put($id, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LedgerpaymentTypeOutApi->put: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	int	Element ID
body	\Tripletex\Model\PaymentTypeOut	Partial object describing what should be updated	[optional]

Return type

\Tripletex\Model\ResponseWrapperPaymentTypeOut

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: Not defined

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

putList

\Tripletex\Model\ListResponsePaymentTypeOut putList($body)

[BETA] Update multiple payment types for outgoing payments at once

Example

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

// Configure HTTP basic authorization: tokenAuthScheme
$config = Tripletex\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Tripletex\Api\LedgerpaymentTypeOutApi(
    // 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 = array(new \Tripletex\Model\PaymentTypeOut()); // \Tripletex\Model\PaymentTypeOut[] | JSON representing updates to object. Should have ID and version set.

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

Parameters

Name	Type	Description	Notes
body	\Tripletex\Model\PaymentTypeOut[]	JSON representing updates to object. Should have ID and version set.	[optional]

Return type

\Tripletex\Model\ListResponsePaymentTypeOut

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: application/json; charset=utf-8
Accept: Not defined

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

search

\Tripletex\Model\ListResponsePaymentTypeOut search($id, $description, $is_inactive, $from, $count, $sorting, $fields)

[BETA] Gets payment types for outgoing payments

This is an API endpoint for getting payment types for outgoing payments. This is equivalent to the section 'Outgoing Payments' under Accounts Settings in Tripletex. These are the payment types listed in supplier invoices, vat returns, salary payments and Tax/ENI

Example

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

// Configure HTTP basic authorization: tokenAuthScheme
$config = Tripletex\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');


$apiInstance = new Tripletex\Api\LedgerpaymentTypeOutApi(
    // 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 = "id_example"; // string | List of IDs
$description = "description_example"; // string | Containing
$is_inactive = true; // bool | Equals
$from = 0; // int | From index
$count = 1000; // int | Number of elements to return
$sorting = "sorting_example"; // string | Sorting pattern
$fields = "fields_example"; // string | Fields filter pattern

try {
    $result = $apiInstance->search($id, $description, $is_inactive, $from, $count, $sorting, $fields);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling LedgerpaymentTypeOutApi->search: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string	List of IDs	[optional]
description	string	Containing	[optional]
is_inactive	bool	Equals	[optional]
from	int	From index	[optional] [default to 0]
count	int	Number of elements to return	[optional] [default to 1000]
sorting	string	Sorting pattern	[optional]
fields	string	Fields filter pattern	[optional]

Return type

\Tripletex\Model\ListResponsePaymentTypeOut

Authorization

tokenAuthScheme

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

Files

LedgerpaymentTypeOutApi.md

Latest commit

History

LedgerpaymentTypeOutApi.md

File metadata and controls

Tripletex\LedgerpaymentTypeOutApi

delete

Example

Parameters

Return type

Authorization

HTTP request headers

get

Example

Parameters

Return type

Authorization

HTTP request headers

post

Example

Parameters

Return type

Authorization

HTTP request headers

postList

Example

Parameters

Return type

Authorization

HTTP request headers

put

Example

Parameters

Return type

Authorization

HTTP request headers

putList

Example

Parameters

Return type

Authorization

HTTP request headers

search

Example

Parameters

Return type

Authorization

HTTP request headers