RecurringById: Fortnox itgen_fnx_recurringbyid_plural
read only REST
- Catalogo:
Fortnox - Schema:
RecurringBillings - Etichetta: itgen_fnx_recurringbyid_plural
Get a recurring by ID Returns the full representation of a single recurring contract, including its rows, accrual, tax reductions, calculated totals and any accumulated error logs. The ETag and Last-Modified response headers can be used for later conditional updates.
È possibile solo recuperare i dati.
Riepilogo
Returns the full representation of a single recurring contract, including its rows, accrual, tax reductions, calculated totals and any accumulated error logs. The ETag and Last-Modified response headers can be used for later conditional updates.
Codice sorgente dell'API
- Punto finale:
/api/recurring-billing/recurrings-v1/{recurring-id} - Operazione:
get /api/recurring-billing/recurrings-v1/{recurring-id}
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 |
|---|---|---|---|---|
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). | ||
recurring- |
`` | The unique identifier of the recurring contract. | ||
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 RecurringById. 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_ |
datetime |
itgen_fnx_accrual_created_at | filters on the platform, writable, accrual. |
Timestamp when the accrual was created.Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_id | filters on the platform, writable, accrual. |
Server-generated unique identifier of the accrual. | |
accrual_ |
datetime |
itgen_fnx_accrual_modified_at | filters on the platform, writable, accrual. |
Timestamp when the accrual was last modified.Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_recurring_id | filters on the platform, writable, accrual. |
Identifier of the recurring this accrual belongs to.Read-only. | |
amount_ |
int64 |
itgen_fnx_amount_per_invoicing | filters on the platform, writable, 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.Defaults to 1. | |
cost_ |
varchar2 |
itgen_fnx_cost_center_id | filters on the platform, writable, cost_ |
Identifier of the cost center the recurring and its invoices are booked against. | |
created_ |
datetime |
itgen_fnx_created_at | filters on the platform, writable, created_ |
Timestamp when the recurring was created.Read-only. | |
created_ |
varchar2 |
itgen_fnx_created_by | filters on the platform, writable, created_ |
Id of the user who created the recurring.Read-only. | |
currency |
varchar2 |
Currency | filters on the platform, writable, currency |
ISO 4217 currency code the recurring is invoiced in (e.g.SEK, EUR). | |
customer_ |
varchar2 |
itgen_fnx_customer_address | filters on the platform, writable, customer. |
Street address of the customer. | |
customer_ |
varchar2 |
Città del cliente | filters on the platform, writable, customer. |
City of the customer address. | |
customer_ |
varchar2 |
itgen_fnx_customer_country_code | filters on the platform, writable, customer. |
ISO 3166-1 alpha-2 country code of the customer address. | |
customer_ |
varchar2 |
Nome del cliente | filters on the platform, writable, customer. |
Customer name printed on the invoice. | |
customer_ |
varchar2 |
Numero del cliente | filters on the platform, writable, customer. |
Customer number identifying the customer in the customer register.Required. | |
customer_ |
varchar2 |
itgen_fnx_customer_phone | filters on the platform, writable, customer. |
Customer phone number. | |
customer_ |
varchar2 |
itgen_fnx_customer_zip | filters on the platform, writable, customer. |
Postal/ZIP code of the customer address. | |
dates_ |
datetime |
itgen_fnx_dates_dates_invoice_date | filters on the platform, writable, dates. |
The date printed on the invoice.Server-computed — not a client input.Null until it has been computed, and null when the recurring is FINISHED or has no further invoice. | |
dates_ |
datetime |
itgen_fnx_dates_dates_invoice_processing_date | filters on the platform, writable, dates. |
The date the next invoice is generated and processed. | |
dates_ |
datetime |
itgen_fnx_dates_dates_period_start_date | filters on the platform, writable, dates. |
The start date of the next billing period. | |
dates_ |
datetime |
itgen_fnx_dates_rules_end_date | filters on the platform, writable, dates. |
The last date this recurring produces invoices.Omit for an open-ended recurring. | |
dates_ |
varchar2 |
itgen_fnx_dates_rules_frequency | filters on the platform, writable, dates. |
||
dates_ |
int64 |
itgen_fnx_dates_rules_interval | filters on the platform, writable, dates. |
How many frequency units between occurrences.Combined with frequency this reads as "every " — e.g. interval 2 with frequency MONTH means every 2 months.Defaults to 1. |
|
dates_ |
varchar2 |
itgen_fnx_dates_rules_invoice_anchor | filters on the platform, writable, dates. |
||
dates_ |
varchar2 |
itgen_fnx_dates_rules_period_anchor | filters on the platform, writable, dates. |
||
delivery_ |
varchar2 |
itgen_fnx_delivery_address | filters on the platform, writable, delivery. |
Delivery street address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_city | filters on the platform, writable, delivery. |
City of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_country_code | filters on the platform, writable, delivery. |
ISO 3166-1 alpha-2 country code of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_name | filters on the platform, writable, delivery. |
Delivery recipient name. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_phone | filters on the platform, writable, delivery. |
Contact phone number for the delivery. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_term_code | filters on the platform, writable, delivery. |
Delivery terms code (e.g.Incoterm) printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_type_code | filters on the platform, writable, delivery. |
Delivery method/type code printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_zip | filters on the platform, writable, delivery. |
Postal/ZIP code of the delivery address. | |
distribution_ |
varchar2 |
itgen_fnx_distribution_method | filters on the platform, writable, distribution_ |
||
email_ |
varchar2 |
itgen_fnx_email_to | filters on the platform, writable, email. |
Recipient email address used to deliver the invoice when the distribution method is EMAIL. | |
id |
guid |
ID | filters on the platform, writable, id |
Server-generated unique identifier of the recurring. | |
invoice_ |
varchar2 |
itgen_fnx_invoice_handling | filters on the platform, writable, invoice_ |
||
modified_ |
datetime |
itgen_fnx_modified_at | filters on the platform, writable, modified_ |
Timestamp when the recurring was last modified.Read-only. | |
modified_ |
varchar2 |
itgen_fnx_modified_by | filters on the platform, writable, modified_ |
Id of the user who last modified the recurring.Read-only. | |
order_ |
varchar2 |
itgen_fnx_order_number | filters on the platform, writable, order_ |
Customer purchase order number printed on the generated invoices. | |
our_ |
varchar2 |
itgen_fnx_our_reference | filters on the platform, writable, our_ |
The seller's own reference (e.g. the responsible employee) printed on the invoice. | |
payment_ |
varchar2 |
itgen_fnx_payment_terms | filters on the platform, writable, payment_ |
Payment terms applied to the generated invoices (e.g. days until due). | |
price_ |
varchar2 |
itgen_fnx_price_list_id | filters on the platform, writable, price_ |
Identifier of the price list used to resolve article prices for this recurring. | |
print_ |
varchar2 |
itgen_fnx_print_configuration_language | filters on the platform, writable, print_ |
||
print_ |
varchar2 |
itgen_fnx_print_configuration_template | filters on the platform, writable, print_ |
if no value provided its fetched from settings | |
project_ |
varchar2 |
Identificatore del progetto | filters on the platform, writable, project_ |
Identifier of the project the recurring and its invoices are booked against. | |
remark |
varchar2 |
itgen_fnx_remark | filters on the platform, writable, remark |
Free-text remark printed on the generated invoices. | |
serial_ |
int64 |
itgen_fnx_serial_number | filters on the platform, writable, serial_ |
Server-assigned sequential number identifying the recurring within the tenant. | |
status |
varchar2 |
Status | filters on the platform, writable, status |
||
totals_ |
double |
itgen_fnx_totals_excl_vat | filters on the platform, writable, totals. |
Total amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat | filters on the platform, writable, totals. |
Total amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_roundoff | filters on the platform, writable, totals. |
Rounding adjustment applied to the total. | |
totals_ |
double |
itgen_fnx_totals_vat | filters on the platform, writable, totals. |
Total VAT amount. | |
vat_ |
varchar2 |
itgen_fnx_vat_option | filters on the platform, writable, vat_ |
||
vat_ |
varchar2 |
itgen_fnx_vat_payment_type | filters on the platform, writable, vat_ |
||
your_ |
varchar2 |
itgen_fnx_your_reference | filters on the platform, writable, 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: