RecurringDeviationsByRecurringId: Fortnox itgen_fnx_recurringdeviationsbyrecurringid_plural
read only REST
- Catalog:
Fortnox - Schema:
RecurringBillingDeviations - Label: itgen_fnx_recurringdeviationsbyrecurringid_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- |
`` | 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 RecurringDeviationsByRecurringId 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_ |
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. | |
created_ |
datetime |
itgen_fnx_created_at | filters on the platform, writable, created_ |
Timestamp when the deviation was created. Read-only. | |
deviation_ |
varchar2 |
itgen_fnx_deviation_type | filters on the platform, writable, deviation_ |
||
id |
guid |
ID | filters on the platform, writable, id |
Server-generated unique identifier of the deviation. | |
modified_ |
datetime |
itgen_fnx_modified_at | filters on the platform, writable, modified_ |
Timestamp when the deviation was last modified. Read-only. | |
recurring_ |
guid |
itgen_fnx_recurring_id | filters on the platform, writable, recurring_ |
Identifier of the recurring this deviation belongs to. Read-only. | |
repeat_ |
int64 |
itgen_fnx_repeat_interval | filters on the platform, writable, repeat_ |
When set, the SKIP deviation repeats every this many invoices starting from target_invoice_index. Only applies to SKIP deviations. | |
target_ |
int64 |
itgen_fnx_target_invoice_index | filters on the platform, writable, target_ |
Zero-based index of the invoice occurrence in the recurring's sequence that the deviation applies to. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: