invantive documentation
Forum di supporto InvantiveAccedi / Registrati

Recurrings: Fortnox itgen_fnx_recurrings_plural

read only REST

  • Catalogo: Fortnox
  • Schema: RecurringBillings
  • Etichetta: 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.

È possibile solo recuperare i dati.

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.

Codice sorgente dell'API

  • Punto finale: /api/recurring-billing/recurrings-v1
  • Operazione: get /api/recurring-billing/recurrings-v1

Caratteristiche prestazionali

Characteristic Value
Latenza media di accesso (ms) 356
Righe di scansione completa al minuto 85,000
Numero di righe di Query al minuto 168

Il risultato può essere memorizzato nella memoria cache sul client.

Parametri

Name Tipo di dati 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).

Colonne della tabella

Di seguito sono riportate le colonne della tabella Recurrings. Ogni colonna ha un tipo di dati SQL. Un nuovo valore non nullo deve essere fornito per ogni colonna richiesta in ogni momento durante l'inserimento e l'aggiornamento.

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

Note di rilascio

Cosa è cambiato, versione per versione, nelle tabelle, nelle colonne, negli attributi e nelle funzionalità del driver: