invantive documentation
Foros de Soporte de InvantiveIniciar Sesión / Registrarse

Recurrings: Fortnox itgen_fnx_recurrings_plural

read only REST

  • Catálogo: Fortnox
  • Esquema: RecurringBillings
  • Etiqueta: 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.

Solo puede recuperar datos.

Resumen

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.

Fuente de la API

  • Punto final: /api/recurring-billing/recurrings-v1
  • Operación: get /api/recurring-billing/recurrings-v1

Características de rendimiento

Characteristic Value
Latencia media de acceso (ms) 356
Número de filas escaneadas por minuto 85,000
Número de filas de queries puntuales por minuto 168

El resultado se puede almacenar en la Caché del cliente.

Parámetros

Name Tipo de Datos 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).

Columnas de la Tabla

A continuación se muestran las columnas de la tabla Recurrings. Cada columna tiene un tipo de datos SQL. Se debe proporcionar un nuevo valor no nulo para cada columna requerida en todo momento durante la inserción y la actualización.

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

Notas de la Versión

Cambios introducidos en cada versión en las tablas, columnas, atributos y capacidades del controlador: