# Fortnox\FortnoxInvoicePaymentsApi



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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**invoicePaymentControllerDoCreate()**](FortnoxInvoicePaymentsApi.md#invoicePaymentControllerDoCreate) | **POST** /3/invoicepayments | Create an invoice payment |
| [**invoicePaymentControllerDoDelete()**](FortnoxInvoicePaymentsApi.md#invoicePaymentControllerDoDelete) | **DELETE** /3/invoicepayments/{Number} | Remove an invoice payment |
| [**invoicePaymentControllerDoIndex()**](FortnoxInvoicePaymentsApi.md#invoicePaymentControllerDoIndex) | **GET** /3/invoicepayments | Retrieve a list of invoice payments |
| [**invoicePaymentControllerDoShow()**](FortnoxInvoicePaymentsApi.md#invoicePaymentControllerDoShow) | **GET** /3/invoicepayments/{Number} | Retrieve a single invoice payment |
| [**invoicePaymentControllerDoUpdate()**](FortnoxInvoicePaymentsApi.md#invoicePaymentControllerDoUpdate) | **PUT** /3/invoicepayments/{Number} | Update an invoice payment |
| [**invoicePaymentControllerDoUpdateAndBookkeep()**](FortnoxInvoicePaymentsApi.md#invoicePaymentControllerDoUpdateAndBookkeep) | **PUT** /3/invoicepayments/{Number}/bookkeep | Bookkeep an invoice payment |


## `invoicePaymentControllerDoCreate()`

```php
invoicePaymentControllerDoCreate($invoice_payment): \Fortnox\Model\FortnoxKfInvoicePaymentSingleItemWrap
```

Create an invoice payment

Create an invoice payment

### Example

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



$apiInstance = new Fortnox\Api\FortnoxInvoicePaymentsApi(
    // 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()
);
$invoice_payment = new \Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap(); // \Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap | Request body for create invoice payment

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **invoice_payment** | [**\Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap**](../Model/FortnoxKfInvoicePaymentSinglePayloadItemWrap.md)| Request body for create invoice payment | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfInvoicePaymentSingleItemWrap**](../Model/FortnoxKfInvoicePaymentSingleItemWrap.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `invoicePaymentControllerDoDelete()`

```php
invoicePaymentControllerDoDelete($number)
```

Remove an invoice payment

Delete an invoice payment

### Example

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



$apiInstance = new Fortnox\Api\FortnoxInvoicePaymentsApi(
    // 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()
);
$number = 'number_example'; // string | identifies the invoice payment

try {
    $apiInstance->invoicePaymentControllerDoDelete($number);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxInvoicePaymentsApi->invoicePaymentControllerDoDelete: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **number** | **string**| identifies the invoice payment | |

### Return type

void (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `invoicePaymentControllerDoIndex()`

```php
invoicePaymentControllerDoIndex($sortby, $invoicenumber, $lastmodified): \Fortnox\Model\FortnoxKfInvoicePaymentListItemWrap
```

Retrieve a list of invoice payments

Get invoice payments

### Example

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



$apiInstance = new Fortnox\Api\FortnoxInvoicePaymentsApi(
    // 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()
);
$sortby = 'sortby_example'; // string | field to sort returned list on
$invoicenumber = 56; // int | filter by invoice number
$lastmodified = 'lastmodified_example'; // string | filter by last modified

try {
    $result = $apiInstance->invoicePaymentControllerDoIndex($sortby, $invoicenumber, $lastmodified);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxInvoicePaymentsApi->invoicePaymentControllerDoIndex: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **sortby** | **string**| field to sort returned list on | [optional] |
| **invoicenumber** | **int**| filter by invoice number | [optional] |
| **lastmodified** | **string**| filter by last modified | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfInvoicePaymentListItemWrap**](../Model/FortnoxKfInvoicePaymentListItemWrap.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `invoicePaymentControllerDoShow()`

```php
invoicePaymentControllerDoShow($number): \Fortnox\Model\FortnoxKfInvoicePaymentSingleItemWrap
```

Retrieve a single invoice payment

Retrieve an invoice payment

### Example

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



$apiInstance = new Fortnox\Api\FortnoxInvoicePaymentsApi(
    // 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()
);
$number = 'number_example'; // string | identifies the invoice payment

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **number** | **string**| identifies the invoice payment | |

### Return type

[**\Fortnox\Model\FortnoxKfInvoicePaymentSingleItemWrap**](../Model/FortnoxKfInvoicePaymentSingleItemWrap.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `invoicePaymentControllerDoUpdate()`

```php
invoicePaymentControllerDoUpdate($number, $invoice_payment): \Fortnox\Model\FortnoxKfInvoicePaymentSingleItemWrap
```

Update an invoice payment

Update an invoice payment

### Example

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



$apiInstance = new Fortnox\Api\FortnoxInvoicePaymentsApi(
    // 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()
);
$number = 'number_example'; // string | identifies the invoice payment
$invoice_payment = new \Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap(); // \Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap | Request body for update invoice payment

try {
    $result = $apiInstance->invoicePaymentControllerDoUpdate($number, $invoice_payment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxInvoicePaymentsApi->invoicePaymentControllerDoUpdate: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **number** | **string**| identifies the invoice payment | |
| **invoice_payment** | [**\Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap**](../Model/FortnoxKfInvoicePaymentSinglePayloadItemWrap.md)| Request body for update invoice payment | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfInvoicePaymentSingleItemWrap**](../Model/FortnoxKfInvoicePaymentSingleItemWrap.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)

## `invoicePaymentControllerDoUpdateAndBookkeep()`

```php
invoicePaymentControllerDoUpdateAndBookkeep($number, $invoice_payment): \Fortnox\Model\FortnoxKfInvoicePaymentSingleItemWrap
```

Bookkeep an invoice payment

Update an invoice payment

### Example

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



$apiInstance = new Fortnox\Api\FortnoxInvoicePaymentsApi(
    // 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()
);
$number = 'number_example'; // string | identifies the invoice payment
$invoice_payment = new \Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap(); // \Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap | Request body for update invoice payment

try {
    $result = $apiInstance->invoicePaymentControllerDoUpdateAndBookkeep($number, $invoice_payment);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxInvoicePaymentsApi->invoicePaymentControllerDoUpdateAndBookkeep: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **number** | **string**| identifies the invoice payment | |
| **invoice_payment** | [**\Fortnox\Model\FortnoxKfInvoicePaymentSinglePayloadItemWrap**](../Model/FortnoxKfInvoicePaymentSinglePayloadItemWrap.md)| Request body for update invoice payment | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfInvoicePaymentSingleItemWrap**](../Model/FortnoxKfInvoicePaymentSingleItemWrap.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: `application/json`

[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
[[Back to Model list]](../../README.md#models)
[[Back to README]](../../README.md)
