invantive documentation
Forums d'Invantive SupportConnectez-vous/inscrivez-vous

Recurrings: Fortnox itgen_fnx_recurrings_plural

read only REST

  • Catalogue : Fortnox
  • Schéma : RecurringBillings
  • Étiquette : 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.

Permet uniquement de récupérer des données.

Résumé

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.

Source de l'API

  • Point de terminaison : /api/recurring-billing/recurrings-v1
  • Opération : get /api/recurring-billing/recurrings-v1

Caractéristiques de performance

Characteristic Value
Latence moyenne d'accès (ms) 356
Nombre de lignes par minute en mode de balayage complet 85,000
Nombre de lignes de requêtes ponctuelles par minute 168

Le résultat peut être mis en cache côté client.

Paramètres

Name Type de données 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).

Colonnes de table

Les colonnes de la table Recurrings sont présentées ci-dessous. Chaque colonne possède un type de données SQL. Une nouvelle valeur non nulle doit être fournie pour chaque colonne requise à tout moment lors de l'insertion et de la mise à jour.

Name Type de données Label Required Marks Documentation
accrual_accrual_account_number int64 itgen_fnx_accrual_accrual_account_number filtres sur la plateforme, modifiables, accrual.accrual_account_number General ledger account holding the deferred (not yet recognised) revenue.
accrual_amount decimal itgen_fnx_accrual_amount filtres sur la plateforme, modifiables, accrual.amount Total amount to be periodised (accrued) across accounting periods.
accrual_created_at datetime itgen_fnx_accrual_created_at filtres sur la plateforme, modifiables, accrual.created_at Timestamp when the accrual was created.Read-only.
accrual_id guid itgen_fnx_accrual_id filtres sur la plateforme, modifiables, accrual.id Server-generated unique identifier of the accrual.
accrual_modified_at datetime itgen_fnx_accrual_modified_at filtres sur la plateforme, modifiables, accrual.modified_at Timestamp when the accrual was last modified.Read-only.
accrual_recurring_id guid itgen_fnx_accrual_recurring_id filtres sur la plateforme, modifiables, accrual.recurring_id Identifier of the recurring this accrual belongs to.Read-only.
accrual_revenue_account_number int64 itgen_fnx_accrual_revenue_account_number filtres sur la plateforme, modifiables, 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 filtres sur la plateforme, modifiables, accrual.vat_option
amount_per_invoicing int64 itgen_fnx_amount_per_invoicing filtres sur la plateforme, modifiables, 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.Valeur par défaut : 1.
cost_center_id varchar2 itgen_fnx_cost_center_id filtres sur la plateforme, modifiables, cost_center_id Identifier of the cost center the recurring and its invoices are booked against.
created_at datetime itgen_fnx_created_at filtres sur la plateforme, modifiables, created_at Timestamp when the recurring was created.Read-only.
currency varchar2 Currency filtres sur la plateforme, modifiables, currency ISO 4217 currency code the recurring is invoiced in (e.g.SEK, EUR).
customer_address varchar2 itgen_fnx_customer_address filtres sur la plateforme, modifiables, customer.address Street address of the customer.
customer_city varchar2 Ville du client filtres sur la plateforme, modifiables, customer.city City of the customer address.
customer_country_code varchar2 itgen_fnx_customer_country_code filtres sur la plateforme, modifiables, customer.country_code ISO 3166-1 alpha-2 country code of the customer address.
customer_name varchar2 Nom du client filtres sur la plateforme, modifiables, customer.name Customer name printed on the invoice.
customer_number varchar2 Numéro de client filtres sur la plateforme, modifiables, customer.number Customer number identifying the customer in the customer register.Obligatoire.
customer_phone varchar2 itgen_fnx_customer_phone filtres sur la plateforme, modifiables, customer.phone Customer phone number.
customer_zip varchar2 itgen_fnx_customer_zip filtres sur la plateforme, modifiables, customer.zip Postal/ZIP code of the customer address.
delivery_address varchar2 itgen_fnx_delivery_address filtres sur la plateforme, modifiables, delivery.address Delivery street address.
delivery_city varchar2 itgen_fnx_delivery_city filtres sur la plateforme, modifiables, delivery.city City of the delivery address.
delivery_country_code varchar2 itgen_fnx_delivery_country_code filtres sur la plateforme, modifiables, delivery.country_code ISO 3166-1 alpha-2 country code of the delivery address.
delivery_name varchar2 itgen_fnx_delivery_name filtres sur la plateforme, modifiables, delivery.name Delivery recipient name.
delivery_phone varchar2 itgen_fnx_delivery_phone filtres sur la plateforme, modifiables, delivery.phone Contact phone number for the delivery.
delivery_term_code varchar2 itgen_fnx_delivery_term_code filtres sur la plateforme, modifiables, delivery.term_code Delivery terms code (e.g.Incoterm) printed on the invoice.
delivery_type_code varchar2 itgen_fnx_delivery_type_code filtres sur la plateforme, modifiables, delivery.type_code Delivery method/type code printed on the invoice.
delivery_zip varchar2 itgen_fnx_delivery_zip filtres sur la plateforme, modifiables, delivery.zip Postal/ZIP code of the delivery address.
distribution_method varchar2 itgen_fnx_distribution_method filtres sur la plateforme, modifiables, distribution_method
email_to varchar2 itgen_fnx_email_to filtres sur la plateforme, modifiables, email.to Recipient email address used to deliver the invoice when the distribution method is EMAIL.
id guid ID filtres sur la plateforme, modifiables, id Server-generated unique identifier of the recurring.
invoice_handling varchar2 itgen_fnx_invoice_handling filtres sur la plateforme, modifiables, invoice_handling
modified_at datetime itgen_fnx_modified_at filtres sur la plateforme, modifiables, modified_at Timestamp when the recurring was last modified.Read-only.
order_number varchar2 itgen_fnx_order_number filtres sur la plateforme, modifiables, order_number Customer purchase order number printed on the generated invoices.
our_reference varchar2 itgen_fnx_our_reference filtres sur la plateforme, modifiables, our_reference The seller's own reference (e.g. the responsible employee) printed on the invoice.
payment_terms varchar2 itgen_fnx_payment_terms filtres sur la plateforme, modifiables, payment_terms Payment terms applied to the generated invoices (e.g. days until due).
price_list_id varchar2 itgen_fnx_price_list_id filtres sur la plateforme, modifiables, 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 filtres sur la plateforme, modifiables, print_configuration.language
print_configuration_template varchar2 itgen_fnx_print_configuration_template filtres sur la plateforme, modifiables, print_configuration.template if no value provided its fetched from settings
project_id varchar2 Identifiant du projet filtres sur la plateforme, modifiables, project_id Identifier of the project the recurring and its invoices are booked against.
remark varchar2 itgen_fnx_remark filtres sur la plateforme, modifiables, remark Free-text remark printed on the generated invoices.
serial_number int64 itgen_fnx_serial_number filtres sur la plateforme, modifiables, serial_number Server-assigned sequential number identifying the recurring within the tenant.
status varchar2 Status filtres sur la plateforme, modifiables, status
totals_excl_vat double itgen_fnx_totals_excl_vat filtres sur la plateforme, modifiables, totals.excl_vat Total amount excluding VAT.
totals_incl_vat double itgen_fnx_totals_incl_vat filtres sur la plateforme, modifiables, totals.incl_vat Total amount including VAT.
totals_roundoff double itgen_fnx_totals_roundoff filtres sur la plateforme, modifiables, totals.roundoff Rounding adjustment applied to the total.
totals_vat double itgen_fnx_totals_vat filtres sur la plateforme, modifiables, totals.vat Total VAT amount.
vat_option varchar2 itgen_fnx_vat_option filtres sur la plateforme, modifiables, vat_option
vat_payment_type varchar2 itgen_fnx_vat_payment_type filtres sur la plateforme, modifiables, vat_payment_type
your_reference varchar2 itgen_fnx_your_reference filtres sur la plateforme, modifiables, your_reference The customer's reference (e.g. their contact person) printed on the invoice.

Notes de Version

Quels ont été les changements apportés à chaque version au niveau des tables, des colonnes, des attributs et des fonctionnalités du chauffeur :