RecurringLinesById: Fortnox itgen_fnx_recurringlinesbyid_plural
read only REST
- Catalog:
Fortnox - Schema:
RecurringBillings - Label: itgen_fnx_recurringlinesbyid_plural
Get a recurring by ID
Returns the full representation of a single recurring contract, including its rows, accrual, tax reductions, calculated totals and any accumulated error logs. The ETag and Last-Modified response headers can be used for later conditional updates.
Can only retrieve data.
Summary
Returns the full representation of a single recurring contract, including its rows, accrual, tax reductions, calculated totals and any accumulated error logs. The ETag and Last-Modified response headers can be used for later conditional updates.
API Source
- Endpoint:
/api/recurring-billing/recurrings-v1/{recurring-id} - Operation:
get /api/recurring-billing/recurrings-v1/{recurring-id}
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 |
|---|---|---|---|---|
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). | ||
recurring- |
`` | The unique identifier of the recurring contract. | ||
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 RecurringLinesById 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 |
|---|---|---|---|---|---|
account_ |
int64 |
Account Number | writable, account_ |
General ledger account the row revenue is booked to. | |
accrual_ |
datetime |
itgen_fnx_accrual_created_at | filters on the platform, writable, ::ancestor. |
Timestamp when the accrual was created. Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_id | filters on the platform, writable, ::ancestor. |
Server-generated unique identifier of the accrual. | |
accrual_ |
datetime |
itgen_fnx_accrual_modified_at | filters on the platform, writable, ::ancestor. |
Timestamp when the accrual was last modified. Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_recurring_id | filters on the platform, writable, ::ancestor. |
Identifier of the recurring this accrual belongs to. Read-only. | |
amount_ |
int64 |
itgen_fnx_amount_per_invoicing | filters on the platform, writable, ::ancestor. |
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. | |
article_ |
varchar2 |
itgen_fnx_article_id | writable, article_ |
Reference to an article in the article register. When set, article defaults (price, account, unit) may be applied. | |
cost_ |
varchar2 |
itgen_fnx_cost_center_id | filters on the platform, writable, ::ancestor. |
Identifier of the cost center the recurring and its invoices are booked against. | |
cost_ |
varchar2 |
itgen_fnx_cost_center_id_2 | writable, cost_ |
Identifier of the cost center this row is booked against. Overrides the recurring-level cost center. | |
created_ |
datetime |
itgen_fnx_created_at | writable, created_ |
Timestamp when the row was created. Read-only. | |
created_ |
datetime |
itgen_fnx_created_at_2 | filters on the platform, writable, ::ancestor. |
Timestamp when the recurring was created. Read-only. | |
created_ |
varchar2 |
itgen_fnx_created_by | filters on the platform, writable, ::ancestor. |
Id of the user who created the recurring. Read-only. | |
currency |
varchar2 |
Currency | filters on the platform, writable, ::ancestor. |
ISO 4217 currency code the recurring is invoiced in (e.g. SEK, EUR). | |
customer_ |
varchar2 |
itgen_fnx_customer_address | filters on the platform, writable, ::ancestor. |
Street address of the customer. | |
customer_ |
varchar2 |
Customer City | filters on the platform, writable, ::ancestor. |
City of the customer address. | |
customer_ |
varchar2 |
itgen_fnx_customer_country_code | filters on the platform, writable, ::ancestor. |
ISO 3166-1 alpha-2 country code of the customer address. | |
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, ::ancestor. |
Customer name printed on the invoice. | |
customer_ |
varchar2 |
Customer Number | filters on the platform, writable, ::ancestor. |
Customer number identifying the customer in the customer register. Required. | |
customer_ |
varchar2 |
itgen_fnx_customer_phone | filters on the platform, writable, ::ancestor. |
Customer phone number. | |
customer_ |
varchar2 |
itgen_fnx_customer_zip | filters on the platform, writable, ::ancestor. |
Postal/ZIP code of the customer address. | |
dates_ |
datetime |
itgen_fnx_dates_dates_invoice_date | filters on the platform, writable, ::ancestor. |
The date printed on the invoice. Server-computed — not a client input. Null until it has been computed, and null when the recurring is FINISHED or has no further invoice. | |
dates_ |
datetime |
itgen_fnx_dates_dates_invoice_processing_date | filters on the platform, writable, ::ancestor. |
The date the next invoice is generated and processed. | |
dates_ |
datetime |
itgen_fnx_dates_dates_period_start_date | filters on the platform, writable, ::ancestor. |
The start date of the next billing period. | |
dates_ |
datetime |
itgen_fnx_dates_rules_end_date | filters on the platform, writable, ::ancestor. |
The last date this recurring produces invoices. Omit for an open-ended recurring. | |
dates_ |
varchar2 |
itgen_fnx_dates_rules_frequency | filters on the platform, writable, ::ancestor. |
||
dates_ |
int64 |
itgen_fnx_dates_rules_interval | filters on the platform, writable, ::ancestor. |
How many frequency units between occurrences. Combined with frequency this reads as "every " — e.g. interval 2 with frequency MONTH means every 2 months. Defaults to 1. |
|
dates_ |
varchar2 |
itgen_fnx_dates_rules_invoice_anchor | filters on the platform, writable, ::ancestor. |
||
dates_ |
varchar2 |
itgen_fnx_dates_rules_period_anchor | filters on the platform, writable, ::ancestor. |
||
delivery_ |
varchar2 |
itgen_fnx_delivery_address | filters on the platform, writable, ::ancestor. |
Delivery street address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_city | filters on the platform, writable, ::ancestor. |
City of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_country_code | filters on the platform, writable, ::ancestor. |
ISO 3166-1 alpha-2 country code of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_name | filters on the platform, writable, ::ancestor. |
Delivery recipient name. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_phone | filters on the platform, writable, ::ancestor. |
Contact phone number for the delivery. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_term_code | filters on the platform, writable, ::ancestor. |
Delivery terms code (e.g. Incoterm) printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_type_code | filters on the platform, writable, ::ancestor. |
Delivery method/type code printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_zip | filters on the platform, writable, ::ancestor. |
Postal/ZIP code of the delivery address. | |
description |
varchar2 |
Description | writable, description |
Text describing the row, printed on the invoice. | |
discount |
double |
Discount | writable, discount |
Discount applied to the row, interpreted according to discount_type. | |
discount_ |
varchar2 |
itgen_fnx_discount_type | writable, discount_ |
||
distribution_ |
varchar2 |
itgen_fnx_distribution_method | filters on the platform, writable, ::ancestor. |
||
email_ |
varchar2 |
itgen_fnx_email_to | filters on the platform, writable, ::ancestor. |
Recipient email address used to deliver the invoice when the distribution method is EMAIL. | |
id |
guid |
ID | writable, id |
Server-generated unique identifier of the row. | |
id_2 |
guid |
ID | filters on the platform, writable, ::ancestor. |
Server-generated unique identifier of the recurring. | |
invoice_ |
varchar2 |
itgen_fnx_invoice_handling | filters on the platform, writable, ::ancestor. |
||
modified_ |
datetime |
itgen_fnx_modified_at | writable, modified_ |
Timestamp when the row was last modified. Read-only. | |
modified_ |
datetime |
itgen_fnx_modified_at_2 | filters on the platform, writable, ::ancestor. |
Timestamp when the recurring was last modified. Read-only. | |
modified_ |
varchar2 |
itgen_fnx_modified_by | filters on the platform, writable, ::ancestor. |
Id of the user who last modified the recurring. Read-only. | |
order_ |
varchar2 |
itgen_fnx_order_number | filters on the platform, writable, ::ancestor. |
Customer purchase order number printed on the generated invoices. | |
our_ |
varchar2 |
itgen_fnx_our_reference | filters on the platform, writable, ::ancestor. |
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, ::ancestor. |
Payment terms applied to the generated invoices (e.g. days until due). | |
price |
double |
Price | writable, price |
Unit price before discount and VAT. | |
price_ |
varchar2 |
itgen_fnx_price_list_id | filters on the platform, writable, ::ancestor. |
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, ::ancestor. |
||
print_ |
varchar2 |
itgen_fnx_print_configuration_template | filters on the platform, writable, ::ancestor. |
if no value provided its fetched from settings | |
project_ |
varchar2 |
Project ID | filters on the platform, writable, ::ancestor. |
Identifier of the project the recurring and its invoices are booked against. | |
project_ |
varchar2 |
itgen_fnx_project_id_2 | writable, project_ |
Identifier of the project this row is booked against. Overrides the recurring-level project. | |
quantity |
double |
Quantity | writable, quantity |
Number of units invoiced for this row. | |
recurring_ |
guid |
itgen_fnx_recurring_id | writable, recurring_ |
Identifier of the recurring this row belongs to. Read-only. | |
remark |
varchar2 |
itgen_fnx_remark | filters on the platform, writable, ::ancestor. |
Free-text remark printed on the generated invoices. | |
row_ |
int64 |
itgen_fnx_row_index | writable, row_ |
Zero-based position of the row within the recurring's row list, determining print order. | |
serial_ |
int64 |
itgen_fnx_serial_number | filters on the platform, writable, ::ancestor. |
Server-assigned sequential number identifying the recurring within the tenant. | |
status |
varchar2 |
Status | filters on the platform, writable, ::ancestor. |
||
totals_ |
double |
itgen_fnx_totals_excl_vat | writable, totals. |
Row amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_excl_vat_2 | filters on the platform, writable, ::ancestor. |
Total amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat | writable, totals. |
Row amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat_2 | filters on the platform, writable, ::ancestor. |
Total amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_roundoff | filters on the platform, writable, ::ancestor. |
Rounding adjustment applied to the total. | |
totals_ |
double |
itgen_fnx_totals_vat | writable, totals. |
Row VAT amount. | |
totals_ |
double |
itgen_fnx_totals_vat_2 | filters on the platform, writable, ::ancestor. |
Total VAT amount. | |
type |
varchar2 |
Type | writable, type |
||
unit |
varchar2 |
Unit | writable, unit |
Unit of measure for the quantity (e.g. "hour", "pcs"). | |
vat_ |
varchar2 |
itgen_fnx_vat_option | filters on the platform, writable, ::ancestor. |
||
vat_ |
varchar2 |
itgen_fnx_vat_payment_type | filters on the platform, writable, ::ancestor. |
||
vat_ |
double |
itgen_fnx_vat_percentage | writable, vat_ |
VAT rate applied to the row, as a percentage. Typically one of 0, 6, 12 or 25. | |
your_ |
varchar2 |
itgen_fnx_your_reference | filters on the platform, writable, ::ancestor. |
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: