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