invantive documentation
Invantive Support ForumsLog In / Sign Up

RecurringDeviationLinesByRecurringId: Fortnox itgen_fnx_recurringdeviationlinesbyrecurringid_plural

read only REST

  • Catalog: Fortnox
  • Schema: RecurringBillingDeviations
  • Label: itgen_fnx_recurringdeviationlinesbyrecurringid_plural

List all deviations for a recurring Returns the deviations defined for a recurring. A deviation overrides the normal invoicing for one or more occurrences of the recurring — either changing the rows (ROWS) or skipping the invoice entirely (SKIP).

Can only retrieve data.

Summary

Returns the deviations defined for a recurring. A deviation overrides the normal invoicing for one or more occurrences of the recurring — either changing the rows (ROWS) or skipping the invoice entirely (SKIP).

API Source

  • Endpoint: /api/recurring-billing/recurrings-v1/{recurring-id}/deviations
  • Operation: get /api/recurring-billing/recurrings-v1/{recurring-id}/deviations

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-id `` 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 RecurringDeviationLinesByRecurringId 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_number int64 Account Number writable, account_number General ledger account the row revenue is booked to.
accrual_created_at datetime itgen_fnx_accrual_created_at filters on the platform, writable, ::ancestor.accrual.created_at Timestamp when the accrual was created. Read-only.
accrual_id guid itgen_fnx_accrual_id filters on the platform, writable, ::ancestor.accrual.id Server-generated unique identifier of the accrual.
accrual_modified_at datetime itgen_fnx_accrual_modified_at filters on the platform, writable, ::ancestor.accrual.modified_at Timestamp when the accrual was last modified. Read-only.
accrual_recurring_id guid itgen_fnx_accrual_recurring_id filters on the platform, writable, ::ancestor.accrual.recurring_id Identifier of the recurring this accrual belongs to. Read-only.
article_id varchar2 itgen_fnx_article_id writable, article_id Reference to an article in the article register. When set, article defaults (price, account, unit) may be applied.
cost_center_id varchar2 itgen_fnx_cost_center_id writable, cost_center_id Identifier of the cost center this row is booked against. Overrides the recurring-level cost center.
created_at datetime itgen_fnx_created_at writable, created_at Timestamp when the deviation row was created. Read-only.
created_at_2 datetime itgen_fnx_created_at_2 filters on the platform, writable, ::ancestor.created_at Timestamp when the deviation was created. Read-only.
description varchar2 Description writable, description Text describing the row, printed on the invoice.
deviation_id guid itgen_fnx_deviation_id writable, deviation_id Identifier of the deviation this row belongs to. Read-only.
deviation_type varchar2 itgen_fnx_deviation_type filters on the platform, writable, ::ancestor.deviation_type
discount double Discount writable, discount Discount applied to the row, interpreted according to discount_type.
discount_type varchar2 itgen_fnx_discount_type writable, discount_type
id guid ID writable, id Server-generated unique identifier of the deviation row.
id_2 guid ID filters on the platform, writable, ::ancestor.id Server-generated unique identifier of the deviation.
modified_at datetime itgen_fnx_modified_at writable, modified_at Timestamp when the deviation row was last modified. Read-only.
modified_at_2 datetime itgen_fnx_modified_at_2 filters on the platform, writable, ::ancestor.modified_at Timestamp when the deviation was last modified. Read-only.
price double Price writable, price Unit price before discount and VAT.
project_id varchar2 Project ID writable, project_id 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_id guid itgen_fnx_recurring_id writable, recurring_id Identifier of the recurring the deviation belongs to. Read-only.
recurring_id_2 guid itgen_fnx_recurring_id_2 filters on the platform, writable, ::ancestor.recurring_id Identifier of the recurring this deviation belongs to. Read-only.
repeat_interval int64 itgen_fnx_repeat_interval filters on the platform, writable, ::ancestor.repeat_interval When set, the SKIP deviation repeats every this many invoices starting from target_invoice_index. Only applies to SKIP deviations.
row_index int64 itgen_fnx_row_index writable, row_index Zero-based position of the row within the recurring's row list, determining print order.
source_recurring_row_id guid itgen_fnx_source_recurring_row_id writable, source_recurring_row_id Identifier of the recurring row this deviation row was derived from, when applicable.
target_invoice_index int64 itgen_fnx_target_invoice_index filters on the platform, writable, ::ancestor.target_invoice_index Zero-based index of the invoice occurrence in the recurring's sequence that the deviation applies to.
type varchar2 Type writable, type
unit varchar2 Unit writable, unit Unit of measure for the quantity (e.g. "hour", "pcs").
vat_percentage double itgen_fnx_vat_percentage writable, vat_percentage VAT rate applied to the row, as a percentage. Typically one of 0, 6, 12 or 25.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: