RecurringLinesById: Fortnox itgen_fnx_recurringlinesbyid_plural
read only REST
- Katalog:
Fortnox - Schema:
RecurringBillings - Bezeichnung: 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.
Es können nur Daten abgerufen werden.
Zusammenfassung
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-Quelle
- Endpunkt:
/api/recurring-billing/recurrings-v1/{recurring-id} - Operation:
get /api/recurring-billing/recurrings-v1/{recurring-id}
Leistungsmerkmale
| Characteristic | Value |
|---|---|
| Durchschnittliche Zugriffsverzögerung (ms) | 356 |
| Anzahl der Vollscan-Zeilen pro Minute | 85,000 |
| Anzahl der Query-Zeilen pro Minute | 168 |
Das Ergebnis kann auf dem Client im Cache zwischengespeichert werden.
Parameter
| Name | Datentyp | 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). |
Tabellenspalten
Die Spalten der Tabelle RecurringLinesById sind unten aufgeführt. Jede Spalte hat einen SQL-Datentyp. Beim Einfügen und Aktualisieren muss für jede erforderliche Spalte jederzeit ein neuer Wert angegeben werden der nicht Null ist.
| Name | Datentyp | Label | Required | Marks | Documentation |
|---|---|---|---|---|---|
account_ |
int64 |
Kontonummer | beschreibbar, account_ |
General ledger account the row revenue is booked to. | |
accrual_ |
datetime |
itgen_fnx_accrual_created_at | Filter auf der Plattform, beschreibbar, ::ancestor. |
Timestamp when the accrual was created.Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_id | Filter auf der Plattform, beschreibbar, ::ancestor. |
Server-generated unique identifier of the accrual. | |
accrual_ |
datetime |
itgen_fnx_accrual_modified_at | Filter auf der Plattform, beschreibbar, ::ancestor. |
Timestamp when the accrual was last modified.Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_recurring_id | Filter auf der Plattform, beschreibbar, ::ancestor. |
Identifier of the recurring this accrual belongs to.Read-only. | |
amount_ |
int64 |
itgen_fnx_amount_per_invoicing | Filter auf der Plattform, beschreibbar, ::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.Standardmäßig ist 1 eingestellt. | |
article_ |
varchar2 |
itgen_fnx_article_id | beschreibbar, 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 | Filter auf der Plattform, beschreibbar, ::ancestor. |
Identifier of the cost center the recurring and its invoices are booked against. | |
cost_ |
varchar2 |
itgen_fnx_cost_center_id_2 | beschreibbar, cost_ |
Identifier of the cost center this row is booked against.Overrides the recurring-level cost center. | |
created_ |
datetime |
itgen_fnx_created_at | beschreibbar, created_ |
Timestamp when the row was created.Read-only. | |
created_ |
datetime |
itgen_fnx_created_at_2 | Filter auf der Plattform, beschreibbar, ::ancestor. |
Timestamp when the recurring was created.Read-only. | |
created_ |
varchar2 |
itgen_fnx_created_by | Filter auf der Plattform, beschreibbar, ::ancestor. |
Id of the user who created the recurring.Read-only. | |
currency |
varchar2 |
Currency | Filter auf der Plattform, beschreibbar, ::ancestor. |
ISO 4217 currency code the recurring is invoiced in (e.g.SEK, EUR). | |
customer_ |
varchar2 |
itgen_fnx_customer_address | Filter auf der Plattform, beschreibbar, ::ancestor. |
Street address of the customer. | |
customer_ |
varchar2 |
Ort des Kunden | Filter auf der Plattform, beschreibbar, ::ancestor. |
City of the customer address. | |
customer_ |
varchar2 |
itgen_fnx_customer_country_code | Filter auf der Plattform, beschreibbar, ::ancestor. |
ISO 3166-1 alpha-2 country code of the customer address. | |
customer_ |
varchar2 |
Name des Kunden | Filter auf der Plattform, beschreibbar, ::ancestor. |
Customer name printed on the invoice. | |
customer_ |
varchar2 |
Kundennummer | Filter auf der Plattform, beschreibbar, ::ancestor. |
Customer number identifying the customer in the customer register.Erforderlich. | |
customer_ |
varchar2 |
itgen_fnx_customer_phone | Filter auf der Plattform, beschreibbar, ::ancestor. |
Customer phone number. | |
customer_ |
varchar2 |
itgen_fnx_customer_zip | Filter auf der Plattform, beschreibbar, ::ancestor. |
Postal/ZIP code of the customer address. | |
dates_ |
datetime |
itgen_fnx_dates_dates_invoice_date | Filter auf der Plattform, beschreibbar, ::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 | Filter auf der Plattform, beschreibbar, ::ancestor. |
The date the next invoice is generated and processed. | |
dates_ |
datetime |
itgen_fnx_dates_dates_period_start_date | Filter auf der Plattform, beschreibbar, ::ancestor. |
The start date of the next billing period. | |
dates_ |
datetime |
itgen_fnx_dates_rules_end_date | Filter auf der Plattform, beschreibbar, ::ancestor. |
The last date this recurring produces invoices.Omit for an open-ended recurring. | |
dates_ |
varchar2 |
itgen_fnx_dates_rules_frequency | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
dates_ |
int64 |
itgen_fnx_dates_rules_interval | Filter auf der Plattform, beschreibbar, ::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.Standardmäßig ist 1 eingestellt. |
|
dates_ |
varchar2 |
itgen_fnx_dates_rules_invoice_anchor | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
dates_ |
varchar2 |
itgen_fnx_dates_rules_period_anchor | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
delivery_ |
varchar2 |
itgen_fnx_delivery_address | Filter auf der Plattform, beschreibbar, ::ancestor. |
Delivery street address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_city | Filter auf der Plattform, beschreibbar, ::ancestor. |
City of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_country_code | Filter auf der Plattform, beschreibbar, ::ancestor. |
ISO 3166-1 alpha-2 country code of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_name | Filter auf der Plattform, beschreibbar, ::ancestor. |
Delivery recipient name. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_phone | Filter auf der Plattform, beschreibbar, ::ancestor. |
Contact phone number for the delivery. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_term_code | Filter auf der Plattform, beschreibbar, ::ancestor. |
Delivery terms code (e.g.Incoterm) printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_type_code | Filter auf der Plattform, beschreibbar, ::ancestor. |
Delivery method/type code printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_zip | Filter auf der Plattform, beschreibbar, ::ancestor. |
Postal/ZIP code of the delivery address. | |
description |
varchar2 |
Description | beschreibbar, description |
Text describing the row, printed on the invoice. | |
discount |
double |
Discount | beschreibbar, discount |
Discount applied to the row, interpreted according to discount_type. | |
discount_ |
varchar2 |
itgen_fnx_discount_type | beschreibbar, discount_ |
||
distribution_ |
varchar2 |
itgen_fnx_distribution_method | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
email_ |
varchar2 |
itgen_fnx_email_to | Filter auf der Plattform, beschreibbar, ::ancestor. |
Recipient email address used to deliver the invoice when the distribution method is EMAIL. | |
id |
guid |
ID | beschreibbar, id |
Server-generated unique identifier of the row. | |
id_2 |
guid |
ID | Filter auf der Plattform, beschreibbar, ::ancestor. |
Server-generated unique identifier of the recurring. | |
invoice_ |
varchar2 |
itgen_fnx_invoice_handling | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
modified_ |
datetime |
itgen_fnx_modified_at | beschreibbar, modified_ |
Timestamp when the row was last modified.Read-only. | |
modified_ |
datetime |
itgen_fnx_modified_at_2 | Filter auf der Plattform, beschreibbar, ::ancestor. |
Timestamp when the recurring was last modified.Read-only. | |
modified_ |
varchar2 |
itgen_fnx_modified_by | Filter auf der Plattform, beschreibbar, ::ancestor. |
Id of the user who last modified the recurring.Read-only. | |
order_ |
varchar2 |
itgen_fnx_order_number | Filter auf der Plattform, beschreibbar, ::ancestor. |
Customer purchase order number printed on the generated invoices. | |
our_ |
varchar2 |
itgen_fnx_our_reference | Filter auf der Plattform, beschreibbar, ::ancestor. |
The seller's own reference (e.g. the responsible employee) printed on the invoice. | |
payment_ |
varchar2 |
itgen_fnx_payment_terms | Filter auf der Plattform, beschreibbar, ::ancestor. |
Payment terms applied to the generated invoices (e.g. days until due). | |
price |
double |
Price | beschreibbar, price |
Unit price before discount and VAT. | |
price_ |
varchar2 |
itgen_fnx_price_list_id | Filter auf der Plattform, beschreibbar, ::ancestor. |
Identifier of the price list used to resolve article prices for this recurring. | |
print_ |
varchar2 |
itgen_fnx_print_configuration_language | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
print_ |
varchar2 |
itgen_fnx_print_configuration_template | Filter auf der Plattform, beschreibbar, ::ancestor. |
if no value provided its fetched from settings | |
project_ |
varchar2 |
Projekt ID | Filter auf der Plattform, beschreibbar, ::ancestor. |
Identifier of the project the recurring and its invoices are booked against. | |
project_ |
varchar2 |
itgen_fnx_project_id_2 | beschreibbar, project_ |
Identifier of the project this row is booked against.Overrides the recurring-level project. | |
quantity |
double |
Quantity | beschreibbar, quantity |
Number of units invoiced for this row. | |
recurring_ |
guid |
itgen_fnx_recurring_id | beschreibbar, recurring_ |
Identifier of the recurring this row belongs to.Read-only. | |
remark |
varchar2 |
itgen_fnx_remark | Filter auf der Plattform, beschreibbar, ::ancestor. |
Free-text remark printed on the generated invoices. | |
row_ |
int64 |
itgen_fnx_row_index | beschreibbar, row_ |
Zero-based position of the row within the recurring's row list, determining print order. | |
serial_ |
int64 |
itgen_fnx_serial_number | Filter auf der Plattform, beschreibbar, ::ancestor. |
Server-assigned sequential number identifying the recurring within the tenant. | |
status |
varchar2 |
Status | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
totals_ |
double |
itgen_fnx_totals_excl_vat | beschreibbar, totals. |
Row amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_excl_vat_2 | Filter auf der Plattform, beschreibbar, ::ancestor. |
Total amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat | beschreibbar, totals. |
Row amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat_2 | Filter auf der Plattform, beschreibbar, ::ancestor. |
Total amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_roundoff | Filter auf der Plattform, beschreibbar, ::ancestor. |
Rounding adjustment applied to the total. | |
totals_ |
double |
itgen_fnx_totals_vat | beschreibbar, totals. |
Row VAT amount. | |
totals_ |
double |
itgen_fnx_totals_vat_2 | Filter auf der Plattform, beschreibbar, ::ancestor. |
Total VAT amount. | |
type |
varchar2 |
Type | beschreibbar, type |
||
unit |
varchar2 |
Unit | beschreibbar, unit |
Unit of measure for the quantity (e.g."hour", "pcs"). | |
vat_ |
varchar2 |
itgen_fnx_vat_option | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
vat_ |
varchar2 |
itgen_fnx_vat_payment_type | Filter auf der Plattform, beschreibbar, ::ancestor. |
||
vat_ |
double |
itgen_fnx_vat_percentage | beschreibbar, vat_ |
VAT rate applied to the row, as a percentage.Typically one of 0, 6, 12 or 25. | |
your_ |
varchar2 |
itgen_fnx_your_reference | Filter auf der Plattform, beschreibbar, ::ancestor. |
The customer's reference (e.g. their contact person) printed on the invoice. |
Anmerkungen zu dieser Version
Was hat sich in den Tabellen, Spalten, Attributen und Funktionen des Treibers mit jeder neuen Version geändert: