invantive documentation
Invantive Support ForumsAanmelden / Inschrijven

RecurringLinesById: Fortnox itgen_fnx_recurringlinesbyid_plural

read only REST

  • Catalogus: 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.

Kan alleen gegevens ophalen.

Samenvatting

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-bron

  • Eindpunt: /api/recurring-billing/recurrings-v1/{recurring-id}
  • Operatie: get /api/recurring-billing/recurrings-v1/{recurring-id}

Prestatiekenmerken

Characteristic Value
Gemiddelde toegangsvertraging (ms) 356
Aantal rijen per minuut bij volledige scan 85,000
Aantal rijen per minuut in een Query 168

Het resultaat kan op de client in de Cache worden opgeslagen.

Parameters

Name Datatype 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).

Tabelkolommen

De kolommen van de tabel RecurringLinesById worden hieronder weergegeven. Elke kolom heeft een SQL-gegevenstype. Voor elke vereiste kolom moet bij het invoegen en bijwerken steeds een nieuwe, niet-lege waarde worden opgegeven.

Name Datatype Label Required Marks Documentation
account_number int64 Rekeningnummer beschrijfbaar, account_number General ledger account the row revenue is booked to.
accrual_created_at datetime itgen_fnx_accrual_created_at filters op het platform, beschrijfbaar, ::ancestor.accrual.created_at Timestamp when the accrual was created.Read-only.
accrual_id guid itgen_fnx_accrual_id filters op het platform, beschrijfbaar, ::ancestor.accrual.id Server-generated unique identifier of the accrual.
accrual_modified_at datetime itgen_fnx_accrual_modified_at filters op het platform, beschrijfbaar, ::ancestor.accrual.modified_at Timestamp when the accrual was last modified.Read-only.
accrual_recurring_id guid itgen_fnx_accrual_recurring_id filters op het platform, beschrijfbaar, ::ancestor.accrual.recurring_id Identifier of the recurring this accrual belongs to.Read-only.
amount_per_invoicing int64 itgen_fnx_amount_per_invoicing filters op het platform, beschrijfbaar, ::ancestor.amount_per_invoicing 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.Standaard is dit 1.
article_id varchar2 itgen_fnx_article_id beschrijfbaar, 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 filters op het platform, beschrijfbaar, ::ancestor.cost_center_id Identifier of the cost center the recurring and its invoices are booked against.
cost_center_id_2 varchar2 itgen_fnx_cost_center_id_2 beschrijfbaar, 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 beschrijfbaar, created_at Timestamp when the row was created.Read-only.
created_at_2 datetime itgen_fnx_created_at_2 filters op het platform, beschrijfbaar, ::ancestor.created_at Timestamp when the recurring was created.Read-only.
created_by varchar2 itgen_fnx_created_by filters op het platform, beschrijfbaar, ::ancestor.created_by Id of the user who created the recurring.Read-only.
currency varchar2 Currency filters op het platform, beschrijfbaar, ::ancestor.currency ISO 4217 currency code the recurring is invoiced in (e.g.SEK, EUR).
customer_address varchar2 itgen_fnx_customer_address filters op het platform, beschrijfbaar, ::ancestor.customer.address Street address of the customer.
customer_city varchar2 Klant Stad filters op het platform, beschrijfbaar, ::ancestor.customer.city City of the customer address.
customer_country_code varchar2 itgen_fnx_customer_country_code filters op het platform, beschrijfbaar, ::ancestor.customer.country_code ISO 3166-1 alpha-2 country code of the customer address.
customer_name varchar2 Naam Klant filters op het platform, beschrijfbaar, ::ancestor.customer.name Customer name printed on the invoice.
customer_number varchar2 Klantnummer filters op het platform, beschrijfbaar, ::ancestor.customer.number Customer number identifying the customer in the customer register.Verplicht.
customer_phone varchar2 itgen_fnx_customer_phone filters op het platform, beschrijfbaar, ::ancestor.customer.phone Customer phone number.
customer_zip varchar2 itgen_fnx_customer_zip filters op het platform, beschrijfbaar, ::ancestor.customer.zip Postal/ZIP code of the customer address.
dates_dates_invoice_date datetime itgen_fnx_dates_dates_invoice_date filters op het platform, beschrijfbaar, ::ancestor.dates.dates.invoice_date 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_dates_invoice_processing_date datetime itgen_fnx_dates_dates_invoice_processing_date filters op het platform, beschrijfbaar, ::ancestor.dates.dates.invoice_processing_date The date the next invoice is generated and processed.
dates_dates_period_start_date datetime itgen_fnx_dates_dates_period_start_date filters op het platform, beschrijfbaar, ::ancestor.dates.dates.period_start_date The start date of the next billing period.
dates_rules_end_date datetime itgen_fnx_dates_rules_end_date filters op het platform, beschrijfbaar, ::ancestor.dates.rules.end_date The last date this recurring produces invoices.Omit for an open-ended recurring.
dates_rules_frequency varchar2 itgen_fnx_dates_rules_frequency filters op het platform, beschrijfbaar, ::ancestor.dates.rules.frequency
dates_rules_interval int64 itgen_fnx_dates_rules_interval filters op het platform, beschrijfbaar, ::ancestor.dates.rules.interval How many frequency units between occurrences.Combined with frequency this reads as "every " — e.g. interval 2 with frequency MONTH means every 2 months.Standaard is dit 1.
dates_rules_invoice_anchor varchar2 itgen_fnx_dates_rules_invoice_anchor filters op het platform, beschrijfbaar, ::ancestor.dates.rules.invoice_anchor
dates_rules_period_anchor varchar2 itgen_fnx_dates_rules_period_anchor filters op het platform, beschrijfbaar, ::ancestor.dates.rules.period_anchor
delivery_address varchar2 itgen_fnx_delivery_address filters op het platform, beschrijfbaar, ::ancestor.delivery.address Delivery street address.
delivery_city varchar2 itgen_fnx_delivery_city filters op het platform, beschrijfbaar, ::ancestor.delivery.city City of the delivery address.
delivery_country_code varchar2 itgen_fnx_delivery_country_code filters op het platform, beschrijfbaar, ::ancestor.delivery.country_code ISO 3166-1 alpha-2 country code of the delivery address.
delivery_name varchar2 itgen_fnx_delivery_name filters op het platform, beschrijfbaar, ::ancestor.delivery.name Delivery recipient name.
delivery_phone varchar2 itgen_fnx_delivery_phone filters op het platform, beschrijfbaar, ::ancestor.delivery.phone Contact phone number for the delivery.
delivery_term_code varchar2 itgen_fnx_delivery_term_code filters op het platform, beschrijfbaar, ::ancestor.delivery.term_code Delivery terms code (e.g.Incoterm) printed on the invoice.
delivery_type_code varchar2 itgen_fnx_delivery_type_code filters op het platform, beschrijfbaar, ::ancestor.delivery.type_code Delivery method/type code printed on the invoice.
delivery_zip varchar2 itgen_fnx_delivery_zip filters op het platform, beschrijfbaar, ::ancestor.delivery.zip Postal/ZIP code of the delivery address.
description varchar2 Description beschrijfbaar, description Text describing the row, printed on the invoice.
discount double Discount beschrijfbaar, discount Discount applied to the row, interpreted according to discount_type.
discount_type varchar2 itgen_fnx_discount_type beschrijfbaar, discount_type
distribution_method varchar2 itgen_fnx_distribution_method filters op het platform, beschrijfbaar, ::ancestor.distribution_method
email_to varchar2 itgen_fnx_email_to filters op het platform, beschrijfbaar, ::ancestor.email.to Recipient email address used to deliver the invoice when the distribution method is EMAIL.
id guid ID beschrijfbaar, id Server-generated unique identifier of the row.
id_2 guid ID filters op het platform, beschrijfbaar, ::ancestor.id Server-generated unique identifier of the recurring.
invoice_handling varchar2 itgen_fnx_invoice_handling filters op het platform, beschrijfbaar, ::ancestor.invoice_handling
modified_at datetime itgen_fnx_modified_at beschrijfbaar, modified_at Timestamp when the row was last modified.Read-only.
modified_at_2 datetime itgen_fnx_modified_at_2 filters op het platform, beschrijfbaar, ::ancestor.modified_at Timestamp when the recurring was last modified.Read-only.
modified_by varchar2 itgen_fnx_modified_by filters op het platform, beschrijfbaar, ::ancestor.modified_by Id of the user who last modified the recurring.Read-only.
order_number varchar2 itgen_fnx_order_number filters op het platform, beschrijfbaar, ::ancestor.order_number Customer purchase order number printed on the generated invoices.
our_reference varchar2 itgen_fnx_our_reference filters op het platform, beschrijfbaar, ::ancestor.our_reference The seller's own reference (e.g. the responsible employee) printed on the invoice.
payment_terms varchar2 itgen_fnx_payment_terms filters op het platform, beschrijfbaar, ::ancestor.payment_terms Payment terms applied to the generated invoices (e.g. days until due).
price double Price beschrijfbaar, price Unit price before discount and VAT.
price_list_id varchar2 itgen_fnx_price_list_id filters op het platform, beschrijfbaar, ::ancestor.price_list_id Identifier of the price list used to resolve article prices for this recurring.
print_configuration_language varchar2 itgen_fnx_print_configuration_language filters op het platform, beschrijfbaar, ::ancestor.print_configuration.language
print_configuration_template varchar2 itgen_fnx_print_configuration_template filters op het platform, beschrijfbaar, ::ancestor.print_configuration.template if no value provided its fetched from settings
project_id varchar2 Project ID filters op het platform, beschrijfbaar, ::ancestor.project_id Identifier of the project the recurring and its invoices are booked against.
project_id_2 varchar2 itgen_fnx_project_id_2 beschrijfbaar, project_id Identifier of the project this row is booked against.Overrides the recurring-level project.
quantity double Quantity beschrijfbaar, quantity Number of units invoiced for this row.
recurring_id guid itgen_fnx_recurring_id beschrijfbaar, recurring_id Identifier of the recurring this row belongs to.Read-only.
remark varchar2 itgen_fnx_remark filters op het platform, beschrijfbaar, ::ancestor.remark Free-text remark printed on the generated invoices.
row_index int64 itgen_fnx_row_index beschrijfbaar, row_index Zero-based position of the row within the recurring's row list, determining print order.
serial_number int64 itgen_fnx_serial_number filters op het platform, beschrijfbaar, ::ancestor.serial_number Server-assigned sequential number identifying the recurring within the tenant.
status varchar2 Status filters op het platform, beschrijfbaar, ::ancestor.status
totals_excl_vat double itgen_fnx_totals_excl_vat beschrijfbaar, totals.excl_vat Row amount excluding VAT.
totals_excl_vat_2 double itgen_fnx_totals_excl_vat_2 filters op het platform, beschrijfbaar, ::ancestor.totals.excl_vat Total amount excluding VAT.
totals_incl_vat double itgen_fnx_totals_incl_vat beschrijfbaar, totals.incl_vat Row amount including VAT.
totals_incl_vat_2 double itgen_fnx_totals_incl_vat_2 filters op het platform, beschrijfbaar, ::ancestor.totals.incl_vat Total amount including VAT.
totals_roundoff double itgen_fnx_totals_roundoff filters op het platform, beschrijfbaar, ::ancestor.totals.roundoff Rounding adjustment applied to the total.
totals_vat double itgen_fnx_totals_vat beschrijfbaar, totals.vat Row VAT amount.
totals_vat_2 double itgen_fnx_totals_vat_2 filters op het platform, beschrijfbaar, ::ancestor.totals.vat Total VAT amount.
type varchar2 Type beschrijfbaar, type
unit varchar2 Unit beschrijfbaar, unit Unit of measure for the quantity (e.g."hour", "pcs").
vat_option varchar2 itgen_fnx_vat_option filters op het platform, beschrijfbaar, ::ancestor.vat_option
vat_payment_type varchar2 itgen_fnx_vat_payment_type filters op het platform, beschrijfbaar, ::ancestor.vat_payment_type
vat_percentage double itgen_fnx_vat_percentage beschrijfbaar, vat_percentage VAT rate applied to the row, as a percentage.Typically one of 0, 6, 12 or 25.
your_reference varchar2 itgen_fnx_your_reference filters op het platform, beschrijfbaar, ::ancestor.your_reference The customer's reference (e.g. their contact person) printed on the invoice.

Release Notes

Wat is er per release veranderd in de tabellen, kolommen, attributen en mogelijkheden van de driver: