invantive documentation
Invantive SupportforenAnmelden / Eintragen

Recurrings: Fortnox itgen_fnx_recurrings_plural

read only REST

  • Katalog: Fortnox
  • Schema: RecurringBillings
  • Bezeichnung: itgen_fnx_recurrings_plural

List all recurring contracts Returns a paginated list of recurring contracts for the authenticated tenant. The result can be narrowed with the customer-numbers, statuses, invoice-handlings and error-status filters, ordered with sortby and order, and paged with offset and limit (1-100, default 100). Pagination metadata is returned in the X-PAGINATION and X-LAST-RECORD response headers.

Es können nur Daten abgerufen werden.

Zusammenfassung

Returns a paginated list of recurring contracts for the authenticated tenant. The result can be narrowed with the customer-numbers, statuses, invoice-handlings and error-status filters, ordered with sortby and order, and paged with offset and limit (1-100, default 100). Pagination metadata is returned in the X-PAGINATION and X-LAST-RECORD response headers.

API-Quelle

  • Endpunkt: /api/recurring-billing/recurrings-v1
  • Operation: get /api/recurring-billing/recurrings-v1

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
error-status `` Filter recurrings by error status (Values: HAS_ERROR, HAS_NO_ERROR)
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).
offset `` Number of items to skip
order `` Sort order direction
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 Recurrings 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
accrual_accrual_account_number int64 itgen_fnx_accrual_accrual_account_number Filter auf der Plattform, beschreibbar, accrual.accrual_account_number General ledger account holding the deferred (not yet recognised) revenue.
accrual_amount decimal itgen_fnx_accrual_amount Filter auf der Plattform, beschreibbar, accrual.amount Total amount to be periodised (accrued) across accounting periods.
accrual_created_at datetime itgen_fnx_accrual_created_at Filter auf der Plattform, beschreibbar, accrual.created_at Timestamp when the accrual was created.Read-only.
accrual_id guid itgen_fnx_accrual_id Filter auf der Plattform, beschreibbar, accrual.id Server-generated unique identifier of the accrual.
accrual_modified_at datetime itgen_fnx_accrual_modified_at Filter auf der Plattform, beschreibbar, accrual.modified_at Timestamp when the accrual was last modified.Read-only.
accrual_recurring_id guid itgen_fnx_accrual_recurring_id Filter auf der Plattform, beschreibbar, accrual.recurring_id Identifier of the recurring this accrual belongs to.Read-only.
accrual_revenue_account_number int64 itgen_fnx_accrual_revenue_account_number Filter auf der Plattform, beschreibbar, accrual.revenue_account_number General ledger account the revenue is recognised to as each period is released.
accrual_vat_option varchar2 itgen_fnx_accrual_vat_option Filter auf der Plattform, beschreibbar, accrual.vat_option
amount_per_invoicing int64 itgen_fnx_amount_per_invoicing Filter auf der Plattform, beschreibbar, 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.Standardmäßig ist 1 eingestellt.
cost_center_id varchar2 itgen_fnx_cost_center_id Filter auf der Plattform, beschreibbar, cost_center_id Identifier of the cost center the recurring and its invoices are booked against.
created_at datetime itgen_fnx_created_at Filter auf der Plattform, beschreibbar, created_at Timestamp when the recurring was created.Read-only.
currency varchar2 Currency Filter auf der Plattform, beschreibbar, currency ISO 4217 currency code the recurring is invoiced in (e.g.SEK, EUR).
customer_address varchar2 itgen_fnx_customer_address Filter auf der Plattform, beschreibbar, customer.address Street address of the customer.
customer_city varchar2 Ort des Kunden Filter auf der Plattform, beschreibbar, customer.city City of the customer address.
customer_country_code varchar2 itgen_fnx_customer_country_code Filter auf der Plattform, beschreibbar, customer.country_code ISO 3166-1 alpha-2 country code of the customer address.
customer_name varchar2 Name des Kunden Filter auf der Plattform, beschreibbar, customer.name Customer name printed on the invoice.
customer_number varchar2 Kundennummer Filter auf der Plattform, beschreibbar, customer.number Customer number identifying the customer in the customer register.Erforderlich.
customer_phone varchar2 itgen_fnx_customer_phone Filter auf der Plattform, beschreibbar, customer.phone Customer phone number.
customer_zip varchar2 itgen_fnx_customer_zip Filter auf der Plattform, beschreibbar, customer.zip Postal/ZIP code of the customer address.
delivery_address varchar2 itgen_fnx_delivery_address Filter auf der Plattform, beschreibbar, delivery.address Delivery street address.
delivery_city varchar2 itgen_fnx_delivery_city Filter auf der Plattform, beschreibbar, delivery.city City of the delivery address.
delivery_country_code varchar2 itgen_fnx_delivery_country_code Filter auf der Plattform, beschreibbar, delivery.country_code ISO 3166-1 alpha-2 country code of the delivery address.
delivery_name varchar2 itgen_fnx_delivery_name Filter auf der Plattform, beschreibbar, delivery.name Delivery recipient name.
delivery_phone varchar2 itgen_fnx_delivery_phone Filter auf der Plattform, beschreibbar, delivery.phone Contact phone number for the delivery.
delivery_term_code varchar2 itgen_fnx_delivery_term_code Filter auf der Plattform, beschreibbar, delivery.term_code Delivery terms code (e.g.Incoterm) printed on the invoice.
delivery_type_code varchar2 itgen_fnx_delivery_type_code Filter auf der Plattform, beschreibbar, delivery.type_code Delivery method/type code printed on the invoice.
delivery_zip varchar2 itgen_fnx_delivery_zip Filter auf der Plattform, beschreibbar, delivery.zip Postal/ZIP code of the delivery address.
distribution_method varchar2 itgen_fnx_distribution_method Filter auf der Plattform, beschreibbar, distribution_method
email_to varchar2 itgen_fnx_email_to Filter auf der Plattform, beschreibbar, email.to Recipient email address used to deliver the invoice when the distribution method is EMAIL.
id guid ID Filter auf der Plattform, beschreibbar, id Server-generated unique identifier of the recurring.
invoice_handling varchar2 itgen_fnx_invoice_handling Filter auf der Plattform, beschreibbar, invoice_handling
modified_at datetime itgen_fnx_modified_at Filter auf der Plattform, beschreibbar, modified_at Timestamp when the recurring was last modified.Read-only.
order_number varchar2 itgen_fnx_order_number Filter auf der Plattform, beschreibbar, order_number Customer purchase order number printed on the generated invoices.
our_reference varchar2 itgen_fnx_our_reference Filter auf der Plattform, beschreibbar, our_reference The seller's own reference (e.g. the responsible employee) printed on the invoice.
payment_terms varchar2 itgen_fnx_payment_terms Filter auf der Plattform, beschreibbar, payment_terms Payment terms applied to the generated invoices (e.g. days until due).
price_list_id varchar2 itgen_fnx_price_list_id Filter auf der Plattform, beschreibbar, 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 Filter auf der Plattform, beschreibbar, print_configuration.language
print_configuration_template varchar2 itgen_fnx_print_configuration_template Filter auf der Plattform, beschreibbar, print_configuration.template if no value provided its fetched from settings
project_id varchar2 Projekt ID Filter auf der Plattform, beschreibbar, project_id Identifier of the project the recurring and its invoices are booked against.
remark varchar2 itgen_fnx_remark Filter auf der Plattform, beschreibbar, remark Free-text remark printed on the generated invoices.
serial_number int64 itgen_fnx_serial_number Filter auf der Plattform, beschreibbar, serial_number Server-assigned sequential number identifying the recurring within the tenant.
status varchar2 Status Filter auf der Plattform, beschreibbar, status
totals_excl_vat double itgen_fnx_totals_excl_vat Filter auf der Plattform, beschreibbar, totals.excl_vat Total amount excluding VAT.
totals_incl_vat double itgen_fnx_totals_incl_vat Filter auf der Plattform, beschreibbar, totals.incl_vat Total amount including VAT.
totals_roundoff double itgen_fnx_totals_roundoff Filter auf der Plattform, beschreibbar, totals.roundoff Rounding adjustment applied to the total.
totals_vat double itgen_fnx_totals_vat Filter auf der Plattform, beschreibbar, totals.vat Total VAT amount.
vat_option varchar2 itgen_fnx_vat_option Filter auf der Plattform, beschreibbar, vat_option
vat_payment_type varchar2 itgen_fnx_vat_payment_type Filter auf der Plattform, beschreibbar, vat_payment_type
your_reference varchar2 itgen_fnx_your_reference Filter auf der Plattform, beschreibbar, your_reference 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: