# Recurrings List all recurring contracts Returns a paginated list of recurring contracts for the authenticated tenant. The result can be narrowed with the `customer-numbers`, `statuses`, `invoice-handlings` and `error-status` filters, ordered with `sortby` and `order`, and paged with `offset` and `limit` (1-100, default 100). Pagination metadata is returned in the `X-PAGINATION` and `X-LAST-RECORD` response headers. ## Documentation Returns a paginated list of recurring contracts for the authenticated tenant. The result can be narrowed with the `customer-numbers`, `statuses`, `invoice-handlings` and `error-status` filters, ordered with `sortby` and `order`, and paged with `offset` and `limit` (1-100, default 100). Pagination metadata is returned in the `X-PAGINATION` and `X-LAST-RECORD` response headers. - Catalog: `Fortnox` - Schema: `RecurringBillings` This is a read-only table function. The Fortnox API may not support changing the data or the Invantive UniversalSQL driver for Fortnox does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Fortnox API. ## Parameters of Table Function The following parameters can be used to control the behaviour of the table function `Recurrings`. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values. Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three. Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third. | Name | Data Type | Required | Default Value | Documentation | |---|:---:|:---:|:---:|---| | `error-status` | `` | ☐ | | Filter recurrings by error status (Values: HAS_ERROR, HAS_NO_ERROR) | | `financialyear` | `` | ☐ | | Selects what financial year that should be used (does not work on every table). | | `financialyeardate` | `` | ☐ | | Selects by date, what financial year that should be used (does not work on every table). | | `fromdate` | `` | ☐ | | Defines a selection based on a start date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table). | | `lastmodified` | `` | ☐ | | Retrieves all records since the provided timestamp (does not work on every table). | | `offset` | `` | ☐ | | Number of items to skip | | `order` | `` | ☐ | | Sort order direction | | `todate` | `` | ☐ | | Defines a selection based on an end date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table). | ## Columns of Table Function The columns of the table function `Recurrings` are shown below. Each column has an SQL data type. | Name | Data Type | Label | Required | Documentation | |---|:---:|---|:---:|---| | `accrual_accrual_account_number` | `int64` | | ☐ | General ledger account holding the deferred (not yet recognised) revenue. | | `accrual_amount` | `decimal` | | ☐ | Total amount to be periodised (accrued) across accounting periods. | | `accrual_created_at` | `datetime` | | ☐ | Timestamp when the accrual was created. Read-only. | | `accrual_id` | `guid` | | ☐ | Server-generated unique identifier of the accrual. | | `accrual_modified_at` | `datetime` | | ☐ | Timestamp when the accrual was last modified. Read-only. | | `accrual_recurring_id` | `guid` | | ☐ | Identifier of the recurring this accrual belongs to. Read-only. | | `accrual_revenue_account_number` | `int64` | | ☐ | General ledger account the revenue is recognised to as each period is released. | | `accrual_vat_option` | `varchar2` | | ☐ | | | `amount_per_invoicing` | `int64` | | ☐ | Number of recurring periods combined onto a single invoice. For example, with a monthly recurring an amount of 3 invoices a full quarter at once. Must be between 1 and 12. Defaults to 1. | | `cost_center_id` | `varchar2` | | ☐ | Identifier of the cost center the recurring and its invoices are booked against. | | `created_at` | `datetime` | | ☐ | Timestamp when the recurring was created. Read-only. | | `currency` | `varchar2` | Currency | ☐ | ISO 4217 currency code the recurring is invoiced in (e.g. SEK, EUR). | | `customer_address` | `varchar2` | | ☐ | Street address of the customer. | | `customer_city` | `varchar2` | Customer City | ☐ | City of the customer address. | | `customer_country_code` | `varchar2` | | ☐ | ISO 3166-1 alpha-2 country code of the customer address. | | `customer_name` | `varchar2` | Customer Name | ☐ | Customer name printed on the invoice. | | `customer_number` | `varchar2` | Customer Number | ☐ | Customer number identifying the customer in the customer register. Required. | | `customer_phone` | `varchar2` | | ☐ | Customer phone number. | | `customer_zip` | `varchar2` | | ☐ | Postal/ZIP code of the customer address. | | `delivery_address` | `varchar2` | | ☐ | Delivery street address. | | `delivery_city` | `varchar2` | | ☐ | City of the delivery address. | | `delivery_country_code` | `varchar2` | | ☐ | ISO 3166-1 alpha-2 country code of the delivery address. | | `delivery_name` | `varchar2` | | ☐ | Delivery recipient name. | | `delivery_phone` | `varchar2` | | ☐ | Contact phone number for the delivery. | | `delivery_term_code` | `varchar2` | | ☐ | Delivery terms code (e.g. Incoterm) printed on the invoice. | | `delivery_type_code` | `varchar2` | | ☐ | Delivery method/type code printed on the invoice. | | `delivery_zip` | `varchar2` | | ☐ | Postal/ZIP code of the delivery address. | | `distribution_method` | `varchar2` | | ☐ | | | `email_to` | `varchar2` | | ☐ | Recipient email address used to deliver the invoice when the distribution method is EMAIL. | | `id` | `guid` | ID | ☐ | Server-generated unique identifier of the recurring. | | `invoice_handling` | `varchar2` | | ☐ | | | `modified_at` | `datetime` | | ☐ | Timestamp when the recurring was last modified. Read-only. | | `order_number` | `varchar2` | | ☐ | Customer purchase order number printed on the generated invoices. | | `our_reference` | `varchar2` | | ☐ | The seller's own reference (e.g. the responsible employee) printed on the invoice. | | `payment_terms` | `varchar2` | | ☐ | Payment terms applied to the generated invoices (e.g. days until due). | | `price_list_id` | `varchar2` | | ☐ | Identifier of the price list used to resolve article prices for this recurring. | | `print_configuration_language` | `varchar2` | | ☐ | | | `print_configuration_template` | `varchar2` | | ☐ | if no value provided its fetched from settings | | `project_id` | `varchar2` | Project ID | ☐ | Identifier of the project the recurring and its invoices are booked against. | | `remark` | `varchar2` | | ☐ | Free-text remark printed on the generated invoices. | | `serial_number` | `int64` | | ☐ | Server-assigned sequential number identifying the recurring within the tenant. | | `status` | `varchar2` | Status | ☐ | | | `totals_excl_vat` | `double` | | ☐ | Total amount excluding VAT. | | `totals_incl_vat` | `double` | | ☐ | Total amount including VAT. | | `totals_roundoff` | `double` | | ☐ | Rounding adjustment applied to the total. | | `totals_vat` | `double` | | ☐ | Total VAT amount. | | `vat_option` | `varchar2` | | ☐ | | | `vat_payment_type` | `varchar2` | | ☐ | | | `your_reference` | `varchar2` | | ☐ | The customer's reference (e.g. their contact person) printed on the invoice. |