invantive documentation
Invantive Support ForumsAanmelden / Inschrijven

Recurrings: Fortnox itgen_fnx_recurrings_plural

read only REST

  • Catalogus: Fortnox
  • Schema: RecurringBillings
  • Label: 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.

Kan alleen gegevens ophalen.

Samenvatting

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

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

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

Tabelkolommen

De kolommen van de tabel Recurrings 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
accrual_accrual_account_number int64 itgen_fnx_accrual_accrual_account_number filters op het platform, beschrijfbaar, accrual.accrual_account_number General ledger account holding the deferred (not yet recognised) revenue.
accrual_amount decimal itgen_fnx_accrual_amount filters op het platform, beschrijfbaar, accrual.amount Total amount to be periodised (accrued) across accounting periods.
accrual_created_at datetime itgen_fnx_accrual_created_at filters op het platform, beschrijfbaar, accrual.created_at Timestamp when the accrual was created.Read-only.
accrual_id guid itgen_fnx_accrual_id filters op het platform, beschrijfbaar, accrual.id Server-generated unique identifier of the accrual.
accrual_modified_at datetime itgen_fnx_accrual_modified_at filters op het platform, beschrijfbaar, 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, accrual.recurring_id Identifier of the recurring this accrual belongs to.Read-only.
accrual_revenue_account_number int64 itgen_fnx_accrual_revenue_account_number filters op het platform, beschrijfbaar, 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 filters op het platform, beschrijfbaar, accrual.vat_option
amount_per_invoicing int64 itgen_fnx_amount_per_invoicing filters op het platform, beschrijfbaar, 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.
cost_center_id varchar2 itgen_fnx_cost_center_id filters op het platform, beschrijfbaar, cost_center_id Identifier of the cost center the recurring and its invoices are booked against.
created_at datetime itgen_fnx_created_at filters op het platform, beschrijfbaar, created_at Timestamp when the recurring was created.Read-only.
currency varchar2 Currency filters op het platform, beschrijfbaar, 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, customer.address Street address of the customer.
customer_city varchar2 Klant Stad filters op het platform, beschrijfbaar, customer.city City of the customer address.
customer_country_code varchar2 itgen_fnx_customer_country_code filters op het platform, beschrijfbaar, customer.country_code ISO 3166-1 alpha-2 country code of the customer address.
customer_name varchar2 Naam Klant filters op het platform, beschrijfbaar, customer.name Customer name printed on the invoice.
customer_number varchar2 Klantnummer filters op het platform, beschrijfbaar, customer.number Customer number identifying the customer in the customer register.Verplicht.
customer_phone varchar2 itgen_fnx_customer_phone filters op het platform, beschrijfbaar, customer.phone Customer phone number.
customer_zip varchar2 itgen_fnx_customer_zip filters op het platform, beschrijfbaar, customer.zip Postal/ZIP code of the customer address.
delivery_address varchar2 itgen_fnx_delivery_address filters op het platform, beschrijfbaar, delivery.address Delivery street address.
delivery_city varchar2 itgen_fnx_delivery_city filters op het platform, beschrijfbaar, delivery.city City of the delivery address.
delivery_country_code varchar2 itgen_fnx_delivery_country_code filters op het platform, beschrijfbaar, 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, delivery.name Delivery recipient name.
delivery_phone varchar2 itgen_fnx_delivery_phone filters op het platform, beschrijfbaar, delivery.phone Contact phone number for the delivery.
delivery_term_code varchar2 itgen_fnx_delivery_term_code filters op het platform, beschrijfbaar, 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, delivery.type_code Delivery method/type code printed on the invoice.
delivery_zip varchar2 itgen_fnx_delivery_zip filters op het platform, beschrijfbaar, delivery.zip Postal/ZIP code of the delivery address.
distribution_method varchar2 itgen_fnx_distribution_method filters op het platform, beschrijfbaar, distribution_method
email_to varchar2 itgen_fnx_email_to filters op het platform, beschrijfbaar, email.to Recipient email address used to deliver the invoice when the distribution method is EMAIL.
id guid ID filters op het platform, beschrijfbaar, id Server-generated unique identifier of the recurring.
invoice_handling varchar2 itgen_fnx_invoice_handling filters op het platform, beschrijfbaar, invoice_handling
modified_at datetime itgen_fnx_modified_at filters op het platform, beschrijfbaar, modified_at Timestamp when the recurring was last modified.Read-only.
order_number varchar2 itgen_fnx_order_number filters op het platform, beschrijfbaar, order_number Customer purchase order number printed on the generated invoices.
our_reference varchar2 itgen_fnx_our_reference filters op het platform, beschrijfbaar, 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, payment_terms Payment terms applied to the generated invoices (e.g. days until due).
price_list_id varchar2 itgen_fnx_price_list_id filters op het platform, beschrijfbaar, 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, print_configuration.language
print_configuration_template varchar2 itgen_fnx_print_configuration_template filters op het platform, beschrijfbaar, print_configuration.template if no value provided its fetched from settings
project_id varchar2 Project ID filters op het platform, beschrijfbaar, project_id Identifier of the project the recurring and its invoices are booked against.
remark varchar2 itgen_fnx_remark filters op het platform, beschrijfbaar, remark Free-text remark printed on the generated invoices.
serial_number int64 itgen_fnx_serial_number filters op het platform, beschrijfbaar, serial_number Server-assigned sequential number identifying the recurring within the tenant.
status varchar2 Status filters op het platform, beschrijfbaar, status
totals_excl_vat double itgen_fnx_totals_excl_vat filters op het platform, beschrijfbaar, totals.excl_vat Total amount excluding VAT.
totals_incl_vat double itgen_fnx_totals_incl_vat filters op het platform, beschrijfbaar, totals.incl_vat Total amount including VAT.
totals_roundoff double itgen_fnx_totals_roundoff filters op het platform, beschrijfbaar, totals.roundoff Rounding adjustment applied to the total.
totals_vat double itgen_fnx_totals_vat filters op het platform, beschrijfbaar, totals.vat Total VAT amount.
vat_option varchar2 itgen_fnx_vat_option filters op het platform, beschrijfbaar, vat_option
vat_payment_type varchar2 itgen_fnx_vat_payment_type filters op het platform, beschrijfbaar, vat_payment_type
your_reference varchar2 itgen_fnx_your_reference filters op het platform, beschrijfbaar, 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: