Recurrings: Fortnox itgen_fnx_recurrings_plural
read only REST
- Catalog:
Fortnox - Schema:
RecurringBillings - Label: itgen_fnx_recurrings_plural
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.
Can only retrieve data.
Summary
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.
API Source
- Endpoint:
/api/recurring-billing/recurrings-v1 - Operation:
get /api/recurring-billing/recurrings-v1
Performance Characteristics
| Characteristic | Value |
|---|---|
| Average access latency (ms) | 356 |
| Full scan rows per minute | 85,000 |
| Point query rows per minute | 168 |
The result can be cached on the client.
Parameters
| Name | Data Type | Required | Default | Documentation |
|---|---|---|---|---|
error- |
`` | 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). |
Table Columns
The columns of the table Recurrings are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.
| Name | Data Type | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
accrual_ |
int64 |
itgen_fnx_accrual_accrual_account_number | filters on the platform, writable, accrual. |
General ledger account holding the deferred (not yet recognised) revenue. | |
accrual_ |
decimal |
itgen_fnx_accrual_amount | filters on the platform, writable, accrual. |
Total amount to be periodised (accrued) across accounting periods. | |
accrual_ |
datetime |
itgen_fnx_accrual_created_at | filters on the platform, writable, accrual. |
Timestamp when the accrual was created. Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_id | filters on the platform, writable, accrual. |
Server-generated unique identifier of the accrual. | |
accrual_ |
datetime |
itgen_fnx_accrual_modified_at | filters on the platform, writable, accrual. |
Timestamp when the accrual was last modified. Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_recurring_id | filters on the platform, writable, accrual. |
Identifier of the recurring this accrual belongs to. Read-only. | |
accrual_ |
int64 |
itgen_fnx_accrual_revenue_account_number | filters on the platform, writable, accrual. |
General ledger account the revenue is recognised to as each period is released. | |
accrual_ |
varchar2 |
itgen_fnx_accrual_vat_option | filters on the platform, writable, accrual. |
||
amount_ |
int64 |
itgen_fnx_amount_per_invoicing | filters on the platform, writable, amount_ |
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_ |
varchar2 |
itgen_fnx_cost_center_id | filters on the platform, writable, cost_ |
Identifier of the cost center the recurring and its invoices are booked against. | |
created_ |
datetime |
itgen_fnx_created_at | filters on the platform, writable, created_ |
Timestamp when the recurring was created. Read-only. | |
currency |
varchar2 |
Currency | filters on the platform, writable, currency |
ISO 4217 currency code the recurring is invoiced in (e.g. SEK, EUR). | |
customer_ |
varchar2 |
itgen_fnx_customer_address | filters on the platform, writable, customer. |
Street address of the customer. | |
customer_ |
varchar2 |
Customer City | filters on the platform, writable, customer. |
City of the customer address. | |
customer_ |
varchar2 |
itgen_fnx_customer_country_code | filters on the platform, writable, customer. |
ISO 3166-1 alpha-2 country code of the customer address. | |
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, customer. |
Customer name printed on the invoice. | |
customer_ |
varchar2 |
Customer Number | filters on the platform, writable, customer. |
Customer number identifying the customer in the customer register. Required. | |
customer_ |
varchar2 |
itgen_fnx_customer_phone | filters on the platform, writable, customer. |
Customer phone number. | |
customer_ |
varchar2 |
itgen_fnx_customer_zip | filters on the platform, writable, customer. |
Postal/ZIP code of the customer address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_address | filters on the platform, writable, delivery. |
Delivery street address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_city | filters on the platform, writable, delivery. |
City of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_country_code | filters on the platform, writable, delivery. |
ISO 3166-1 alpha-2 country code of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_name | filters on the platform, writable, delivery. |
Delivery recipient name. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_phone | filters on the platform, writable, delivery. |
Contact phone number for the delivery. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_term_code | filters on the platform, writable, delivery. |
Delivery terms code (e.g. Incoterm) printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_type_code | filters on the platform, writable, delivery. |
Delivery method/type code printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_zip | filters on the platform, writable, delivery. |
Postal/ZIP code of the delivery address. | |
distribution_ |
varchar2 |
itgen_fnx_distribution_method | filters on the platform, writable, distribution_ |
||
email_ |
varchar2 |
itgen_fnx_email_to | filters on the platform, writable, email. |
Recipient email address used to deliver the invoice when the distribution method is EMAIL. | |
id |
guid |
ID | filters on the platform, writable, id |
Server-generated unique identifier of the recurring. | |
invoice_ |
varchar2 |
itgen_fnx_invoice_handling | filters on the platform, writable, invoice_ |
||
modified_ |
datetime |
itgen_fnx_modified_at | filters on the platform, writable, modified_ |
Timestamp when the recurring was last modified. Read-only. | |
order_ |
varchar2 |
itgen_fnx_order_number | filters on the platform, writable, order_ |
Customer purchase order number printed on the generated invoices. | |
our_ |
varchar2 |
itgen_fnx_our_reference | filters on the platform, writable, our_ |
The seller's own reference (e.g. the responsible employee) printed on the invoice. | |
payment_ |
varchar2 |
itgen_fnx_payment_terms | filters on the platform, writable, payment_ |
Payment terms applied to the generated invoices (e.g. days until due). | |
price_ |
varchar2 |
itgen_fnx_price_list_id | filters on the platform, writable, price_ |
Identifier of the price list used to resolve article prices for this recurring. | |
print_ |
varchar2 |
itgen_fnx_print_configuration_language | filters on the platform, writable, print_ |
||
print_ |
varchar2 |
itgen_fnx_print_configuration_template | filters on the platform, writable, print_ |
if no value provided its fetched from settings | |
project_ |
varchar2 |
Project ID | filters on the platform, writable, project_ |
Identifier of the project the recurring and its invoices are booked against. | |
remark |
varchar2 |
itgen_fnx_remark | filters on the platform, writable, remark |
Free-text remark printed on the generated invoices. | |
serial_ |
int64 |
itgen_fnx_serial_number | filters on the platform, writable, serial_ |
Server-assigned sequential number identifying the recurring within the tenant. | |
status |
varchar2 |
Status | filters on the platform, writable, status |
||
totals_ |
double |
itgen_fnx_totals_excl_vat | filters on the platform, writable, totals. |
Total amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat | filters on the platform, writable, totals. |
Total amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_roundoff | filters on the platform, writable, totals. |
Rounding adjustment applied to the total. | |
totals_ |
double |
itgen_fnx_totals_vat | filters on the platform, writable, totals. |
Total VAT amount. | |
vat_ |
varchar2 |
itgen_fnx_vat_option | filters on the platform, writable, vat_ |
||
vat_ |
varchar2 |
itgen_fnx_vat_payment_type | filters on the platform, writable, vat_ |
||
your_ |
varchar2 |
itgen_fnx_your_reference | filters on the platform, writable, your_ |
The customer's reference (e.g. their contact person) printed on the invoice. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: