# Fortnox\FortnoxFinanceInvoicesApi



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

| Method | HTTP request | Description |
| ------------- | ------------- | ------------- |
| [**noxInvoiceControllerDoCreate()**](FortnoxFinanceInvoicesApi.md#noxInvoiceControllerDoCreate) | **POST** /3/noxfinansinvoices | Send an invoice with Fortnox Finans |
| [**noxInvoiceControllerDoShow()**](FortnoxFinanceInvoicesApi.md#noxInvoiceControllerDoShow) | **GET** /3/noxfinansinvoices/{InvoiceNumber} | Retrieve a single invoice payment |
| [**noxInvoiceControllerDoUpdateAndPause()**](FortnoxFinanceInvoicesApi.md#noxInvoiceControllerDoUpdateAndPause) | **PUT** /3/noxfinansinvoices/{InvoiceNumber}/pause | Action Pause |
| [**noxInvoiceControllerDoUpdateAndRepostPayment()**](FortnoxFinanceInvoicesApi.md#noxInvoiceControllerDoUpdateAndRepostPayment) | **PUT** /3/noxfinansinvoices/{InvoiceNumber}/report-payment | Action Report Payment |
| [**noxInvoiceControllerDoUpdateAndStop()**](FortnoxFinanceInvoicesApi.md#noxInvoiceControllerDoUpdateAndStop) | **PUT** /3/noxfinansinvoices/{InvoiceNumber}/stop | Action Stop |
| [**noxInvoiceControllerDoUpdateAndTakeFees()**](FortnoxFinanceInvoicesApi.md#noxInvoiceControllerDoUpdateAndTakeFees) | **PUT** /3/noxfinansinvoices/{InvoiceNumber}/take-fees | Action Take Fees |
| [**noxInvoiceControllerDoUpdateAndUnpause()**](FortnoxFinanceInvoicesApi.md#noxInvoiceControllerDoUpdateAndUnpause) | **PUT** /3/noxfinansinvoices/{InvoiceNumber}/unpause | Action Unpause |


## `noxInvoiceControllerDoCreate()`

```php
noxInvoiceControllerDoCreate($payload): \Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap
```

Send an invoice with Fortnox Finans

<p>  When sending an invoice with Fortnox Finans you will get the invoice status returned if everything succeeded,  if there were any problems, an error will be returned.  <p>  Please note that it can take 1 min to several hours before you will get back status, OCR number and link to  PDF document, meanwhile the invoice will have status UNKNOWN or NOT_AUTHORIZED.  <p>  Fortnox Finans is currently only accepting invoices in SEK  <p>  <i>Parameters in the body:</i>  <ul>      <li><b>InvoiceNumber</b>: the invoice number for the invoice which should be sent with Fortnox Finans</li>      <li><b>SendMethod</b>: how to send the invoice; EMAIL, LETTER, EINVOICE or NONE</li>      <li><b>Service</b>: which service to use; LEDGERBASE or REMINDER</li>  </ul>  <p>

### Example

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



$apiInstance = new Fortnox\Api\FortnoxFinanceInvoicesApi(
    // 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()
);
$payload = new \Fortnox\Model\FortnoxKfNoxInvoiceCreatePayloadWrap(); // \Fortnox\Model\FortnoxKfNoxInvoiceCreatePayloadWrap | Request body for create nox finans invoice

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **payload** | [**\Fortnox\Model\FortnoxKfNoxInvoiceCreatePayloadWrap**](../Model/FortnoxKfNoxInvoiceCreatePayloadWrap.md)| Request body for create nox finans invoice | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap**](../Model/FortnoxKfNoxInvoiceSingleItemWrap.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)

## `noxInvoiceControllerDoShow()`

```php
noxInvoiceControllerDoShow($invoice_number): \Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap
```

Retrieve a single invoice payment

<p>  Retrieves the status and balance of an invoice sent to Fortnox Finans.  You need to supply the invoice number in Fortox to retrieve the invoice.  <p>  <b>Note that</b> invoices sent with the old &quot;Noxbox&quot; platform will not have the &quot;ServiceName&quot;  property in the response. This new property is added to the response if the invoice is  sent with the new finance service.  <p>  Response explanation for <b>Service</b> and <b>ServiceName</b>  <p>  <b>Service:</b>  <ul>      <li><b>LEDGERBASE</b>: if the invoice is sent by using the old &quot;Noxbox&quot; platform, or the new finance service with the subtypes &quot;Service Full&quot; or &quot;Service Light&quot;. These services are explained above in the &quot;Fortnox Finans services&quot; section</li>      <li><b>REMINDER</b>: If the invoice is sent by the new finance service, with the service Reminder Service</li>  </ul>  <p>  <b>ServiceName</b> (only provided for <u>new finance service</u> invoices):  <ul>      <li><b>SERVICE_FULL</b>: Ledgerbase service <u>with</u> automatic reminders is used</li>      <li><b>SERVICE_LIGHT</b>: Ledgerbase service <u>without</u> automatic reminders is used.</li>      <li><b>REMINDER_SERVICE</b>: Reminder service is used</li>  </ul>

### Example

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



$apiInstance = new Fortnox\Api\FortnoxFinanceInvoicesApi(
    // 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_number = 'invoice_number_example'; // string | The Fortnox invoice number

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

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **invoice_number** | **string**| The Fortnox invoice number | |

### Return type

[**\Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap**](../Model/FortnoxKfNoxInvoiceSingleItemWrap.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)

## `noxInvoiceControllerDoUpdateAndPause()`

```php
noxInvoiceControllerDoUpdateAndPause($invoice_number, $payload): \Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap
```

Action Pause

<p>  Pauses an invoice for up to 60 days. Pause means that Fortnox Finans reminder process will stop for the invoice. All invoices which have the status OPEN can be paused.  <p>  <b>Note:</b> this action is <b>not</b> available for invoices sent by the old Noxbox platform  <p>  <i>Parameters in the body:</i>  <ul>      <li><b>PausedUntilDate</b>: the invoice will be paused to and including this date.</li>  </ul>  <p>

### Example

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



$apiInstance = new Fortnox\Api\FortnoxFinanceInvoicesApi(
    // 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_number = 'invoice_number_example'; // string | The Fortnox invoice number
$payload = new \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndPausePayloadWrap(); // \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndPausePayloadWrap | Request body for update nox finans invoice

try {
    $result = $apiInstance->noxInvoiceControllerDoUpdateAndPause($invoice_number, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxFinanceInvoicesApi->noxInvoiceControllerDoUpdateAndPause: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **invoice_number** | **string**| The Fortnox invoice number | |
| **payload** | [**\Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndPausePayloadWrap**](../Model/FortnoxKfNoxInvoiceUpdateAndPausePayloadWrap.md)| Request body for update nox finans invoice | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap**](../Model/FortnoxKfNoxInvoiceSingleItemWrap.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)

## `noxInvoiceControllerDoUpdateAndRepostPayment()`

```php
noxInvoiceControllerDoUpdateAndRepostPayment($invoice_number, $payload): \Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap
```

Action Report Payment

<p>  If a customer has paid some or all of the capital on an invoice directly to the client, this can be reported  for bookkeeping purposes and reported to Fortnox Finans to actually deduct the paid amount from the invoice.  <p>  <b>Note:</b> this action is <b>not</b> available for invoices sent by the old Noxbox platform  <p>  <i>Parameters in the body:</i>  <ul>      <li><b>PaymentAmount</b>: a decimal field with the amount to report.</li>      <li><b>PaymentMethodCode</b>: a string with the method code (e.g. BG, PG or other). Could be omitted if BookkeepPaymentInFortnox is false.</li>      <li><b>PaymentMethodAccount</b>: an integer with the account number to bookkeep the payment on (e.g. 1920 or other). Could be omitted if BookkeepPaymentInFortnox is false.</li>      <li><b>ClientTakesFees</b>: a boolean indicating if the client should take the customer fees or not.</li>      <li><b>BookkeepPaymentInFortnox</b>: a boolean indicating if the payment should be bookkept in Fortnox or not. Usually the payment should be bookkept.</li>      <li><b>ReportToFinance</b>: a boolean indicating if the payment should be reported to Fortnox Finans or not. Usually the payment should be reported.</li>  </ul>  <p>

### Example

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



$apiInstance = new Fortnox\Api\FortnoxFinanceInvoicesApi(
    // 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_number = 'invoice_number_example'; // string | The Fortnox invoice number
$payload = new \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndRepostPaymentPayloadWrap(); // \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndRepostPaymentPayloadWrap | Request body for update nox finans invoice

try {
    $result = $apiInstance->noxInvoiceControllerDoUpdateAndRepostPayment($invoice_number, $payload);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxFinanceInvoicesApi->noxInvoiceControllerDoUpdateAndRepostPayment: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **invoice_number** | **string**| The Fortnox invoice number | |
| **payload** | [**\Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndRepostPaymentPayloadWrap**](../Model/FortnoxKfNoxInvoiceUpdateAndRepostPaymentPayloadWrap.md)| Request body for update nox finans invoice | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap**](../Model/FortnoxKfNoxInvoiceSingleItemWrap.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)

## `noxInvoiceControllerDoUpdateAndStop()`

```php
noxInvoiceControllerDoUpdateAndStop($invoice_number, $fortnox_kf_nox_invoice_update_and_stop_payload_wrap): \Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap
```

Action Stop

<p>  Removes the invoice from Fortnox Finans process. The invoice can still be handled manually, but no further automatic process will be applied  <p>  <b>Note:</b> this action is <b>not</b> available for invoices sent by the old Noxbox platform

### Example

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



$apiInstance = new Fortnox\Api\FortnoxFinanceInvoicesApi(
    // 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_number = 'invoice_number_example'; // string | The Fortnox invoice number
$fortnox_kf_nox_invoice_update_and_stop_payload_wrap = new \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndStopPayloadWrap(); // \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndStopPayloadWrap | Request body for update nox finans invoice

try {
    $result = $apiInstance->noxInvoiceControllerDoUpdateAndStop($invoice_number, $fortnox_kf_nox_invoice_update_and_stop_payload_wrap);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxFinanceInvoicesApi->noxInvoiceControllerDoUpdateAndStop: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **invoice_number** | **string**| The Fortnox invoice number | |
| **fortnox_kf_nox_invoice_update_and_stop_payload_wrap** | [**\Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndStopPayloadWrap**](../Model/FortnoxKfNoxInvoiceUpdateAndStopPayloadWrap.md)| Request body for update nox finans invoice | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap**](../Model/FortnoxKfNoxInvoiceSingleItemWrap.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)

## `noxInvoiceControllerDoUpdateAndTakeFees()`

```php
noxInvoiceControllerDoUpdateAndTakeFees($invoice_number, $fortnox_kf_nox_invoice_update_and_take_fees_payload_wrap): \Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap
```

Action Take Fees

<p>  If fees have been added to an invoice, e.g. reminder fees, the client can choose to pay those fees instead of letting the customer pay.  <p>  <b>Note:</b> this action is <b>not</b> available for invoices sent by the old Noxbox platform

### Example

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



$apiInstance = new Fortnox\Api\FortnoxFinanceInvoicesApi(
    // 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_number = 'invoice_number_example'; // string | The Fortnox invoice number
$fortnox_kf_nox_invoice_update_and_take_fees_payload_wrap = new \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndTakeFeesPayloadWrap(); // \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndTakeFeesPayloadWrap | Request body for update nox finans invoice

try {
    $result = $apiInstance->noxInvoiceControllerDoUpdateAndTakeFees($invoice_number, $fortnox_kf_nox_invoice_update_and_take_fees_payload_wrap);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxFinanceInvoicesApi->noxInvoiceControllerDoUpdateAndTakeFees: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **invoice_number** | **string**| The Fortnox invoice number | |
| **fortnox_kf_nox_invoice_update_and_take_fees_payload_wrap** | [**\Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndTakeFeesPayloadWrap**](../Model/FortnoxKfNoxInvoiceUpdateAndTakeFeesPayloadWrap.md)| Request body for update nox finans invoice | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap**](../Model/FortnoxKfNoxInvoiceSingleItemWrap.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)

## `noxInvoiceControllerDoUpdateAndUnpause()`

```php
noxInvoiceControllerDoUpdateAndUnpause($invoice_number, $fortnox_kf_nox_invoice_update_and_unpause_payload_wrap): \Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap
```

Action Unpause

<p>  Unpauses a paused invoice. If the invoice is manually paused, then this action will remove the pause status immediately. Invoices which are paused by the system cannot be unpaused.  <p>  <b>Note:</b> this action is <b>not</b> available for invoices sent by the old Noxbox platform

### Example

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



$apiInstance = new Fortnox\Api\FortnoxFinanceInvoicesApi(
    // 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_number = 'invoice_number_example'; // string | The Fortnox invoice number
$fortnox_kf_nox_invoice_update_and_unpause_payload_wrap = new \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndUnpausePayloadWrap(); // \Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndUnpausePayloadWrap | Request body for update nox finans invoice

try {
    $result = $apiInstance->noxInvoiceControllerDoUpdateAndUnpause($invoice_number, $fortnox_kf_nox_invoice_update_and_unpause_payload_wrap);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FortnoxFinanceInvoicesApi->noxInvoiceControllerDoUpdateAndUnpause: ', $e->getMessage(), PHP_EOL;
}
```

### Parameters

| Name | Type | Description  | Notes |
| ------------- | ------------- | ------------- | ------------- |
| **invoice_number** | **string**| The Fortnox invoice number | |
| **fortnox_kf_nox_invoice_update_and_unpause_payload_wrap** | [**\Fortnox\Model\FortnoxKfNoxInvoiceUpdateAndUnpausePayloadWrap**](../Model/FortnoxKfNoxInvoiceUpdateAndUnpausePayloadWrap.md)| Request body for update nox finans invoice | [optional] |

### Return type

[**\Fortnox\Model\FortnoxKfNoxInvoiceSingleItemWrap**](../Model/FortnoxKfNoxInvoiceSingleItemWrap.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)
