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- |
`` | 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_ |
int64 |
itgen_fnx_accrual_accrual_account_number | filtros en la plataforma, modificables, accrual. |
General ledger account holding the deferred (not yet recognised) revenue. | |
accrual_ |
decimal |
itgen_fnx_accrual_amount | filtros en la plataforma, modificables, accrual. |
Total amount to be periodised (accrued) across accounting periods. | |
accrual_ |
datetime |
itgen_fnx_accrual_created_at | filtros en la plataforma, modificables, accrual. |
Timestamp when the accrual was created.Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_id | filtros en la plataforma, modificables, accrual. |
Server-generated unique identifier of the accrual. | |
accrual_ |
datetime |
itgen_fnx_accrual_modified_at | filtros en la plataforma, modificables, accrual. |
Timestamp when the accrual was last modified.Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_recurring_id | filtros en la plataforma, modificables, accrual. |
Identifier of the recurring this accrual belongs to.Read-only. | |
accrual_ |
int64 |
itgen_fnx_accrual_revenue_account_number | filtros en la plataforma, modificables, accrual. |
General ledger account the revenue is recognised to as each period is released. | |
accrual_ |
varchar2 |
itgen_fnx_accrual_vat_option | filtros en la plataforma, modificables, accrual. |
||
amount_ |
int64 |
itgen_fnx_amount_per_invoicing | filtros en la plataforma, modificables, amount_ |
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_ |
varchar2 |
itgen_fnx_cost_center_id | filtros en la plataforma, modificables, cost_ |
Identifier of the cost center the recurring and its invoices are booked against. | |
created_ |
datetime |
itgen_fnx_created_at | filtros en la plataforma, modificables, created_ |
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_ |
varchar2 |
itgen_fnx_customer_address | filtros en la plataforma, modificables, customer. |
Street address of the customer. | |
customer_ |
varchar2 |
Ciudad del cliente | filtros en la plataforma, modificables, customer. |
City of the customer address. | |
customer_ |
varchar2 |
itgen_fnx_customer_country_code | filtros en la plataforma, modificables, customer. |
ISO 3166-1 alpha-2 country code of the customer address. | |
customer_ |
varchar2 |
Nombre del Cliente | filtros en la plataforma, modificables, customer. |
Customer name printed on the invoice. | |
customer_ |
varchar2 |
Numero de cliente | filtros en la plataforma, modificables, customer. |
Customer number identifying the customer in the customer register.Obligatorio. | |
customer_ |
varchar2 |
itgen_fnx_customer_phone | filtros en la plataforma, modificables, customer. |
Customer phone number. | |
customer_ |
varchar2 |
itgen_fnx_customer_zip | filtros en la plataforma, modificables, customer. |
Postal/ZIP code of the customer address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_address | filtros en la plataforma, modificables, delivery. |
Delivery street address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_city | filtros en la plataforma, modificables, delivery. |
City of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_country_code | filtros en la plataforma, modificables, delivery. |
ISO 3166-1 alpha-2 country code of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_name | filtros en la plataforma, modificables, delivery. |
Delivery recipient name. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_phone | filtros en la plataforma, modificables, delivery. |
Contact phone number for the delivery. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_term_code | filtros en la plataforma, modificables, delivery. |
Delivery terms code (e.g.Incoterm) printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_type_code | filtros en la plataforma, modificables, delivery. |
Delivery method/type code printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_zip | filtros en la plataforma, modificables, delivery. |
Postal/ZIP code of the delivery address. | |
distribution_ |
varchar2 |
itgen_fnx_distribution_method | filtros en la plataforma, modificables, distribution_ |
||
email_ |
varchar2 |
itgen_fnx_email_to | filtros en la plataforma, modificables, email. |
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_ |
varchar2 |
itgen_fnx_invoice_handling | filtros en la plataforma, modificables, invoice_ |
||
modified_ |
datetime |
itgen_fnx_modified_at | filtros en la plataforma, modificables, modified_ |
Timestamp when the recurring was last modified.Read-only. | |
order_ |
varchar2 |
itgen_fnx_order_number | filtros en la plataforma, modificables, order_ |
Customer purchase order number printed on the generated invoices. | |
our_ |
varchar2 |
itgen_fnx_our_reference | filtros en la plataforma, modificables, our_ |
The seller's own reference (e.g. the responsible employee) printed on the invoice. | |
payment_ |
varchar2 |
itgen_fnx_payment_terms | filtros en la plataforma, modificables, payment_ |
Payment terms applied to the generated invoices (e.g. days until due). | |
price_ |
varchar2 |
itgen_fnx_price_list_id | filtros en la plataforma, modificables, price_ |
Identifier of the price list used to resolve article prices for this recurring. | |
print_ |
varchar2 |
itgen_fnx_print_configuration_language | filtros en la plataforma, modificables, print_ |
||
print_ |
varchar2 |
itgen_fnx_print_configuration_template | filtros en la plataforma, modificables, print_ |
if no value provided its fetched from settings | |
project_ |
varchar2 |
Identificación del Proyecto | filtros en la plataforma, modificables, project_ |
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_ |
int64 |
itgen_fnx_serial_number | filtros en la plataforma, modificables, serial_ |
Server-assigned sequential number identifying the recurring within the tenant. | |
status |
varchar2 |
Status | filtros en la plataforma, modificables, status |
||
totals_ |
double |
itgen_fnx_totals_excl_vat | filtros en la plataforma, modificables, totals. |
Total amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat | filtros en la plataforma, modificables, totals. |
Total amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_roundoff | filtros en la plataforma, modificables, totals. |
Rounding adjustment applied to the total. | |
totals_ |
double |
itgen_fnx_totals_vat | filtros en la plataforma, modificables, totals. |
Total VAT amount. | |
vat_ |
varchar2 |
itgen_fnx_vat_option | filtros en la plataforma, modificables, vat_ |
||
vat_ |
varchar2 |
itgen_fnx_vat_payment_type | filtros en la plataforma, modificables, vat_ |
||
your_ |
varchar2 |
itgen_fnx_your_reference | filtros en la plataforma, modificables, your_ |
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: