RecurringLinesById: Fortnox itgen_fnx_recurringlinesbyid_plural
read only REST
- Catálogo:
Fortnox - Esquema:
RecurringBillings - Etiqueta: itgen_fnx_recurringlinesbyid_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.
Solo puede recuperar datos.
Resumen
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.
Fuente de la API
- Punto final:
/api/recurring-billing/recurrings-v1/{recurring-id} - Operación:
get /api/recurring-billing/recurrings-v1/{recurring-id}
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 |
|---|---|---|---|---|
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). |
Columnas de la Tabla
A continuación se muestran las columnas de la tabla RecurringLinesById. 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 |
|---|---|---|---|---|---|
account_ |
int64 |
Número de Cuenta | editable, account_ |
General ledger account the row revenue is booked to. | |
accrual_ |
datetime |
itgen_fnx_accrual_created_at | filtros en la plataforma, modificables, ::ancestor. |
Timestamp when the accrual was created.Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_id | filtros en la plataforma, modificables, ::ancestor. |
Server-generated unique identifier of the accrual. | |
accrual_ |
datetime |
itgen_fnx_accrual_modified_at | filtros en la plataforma, modificables, ::ancestor. |
Timestamp when the accrual was last modified.Read-only. | |
accrual_ |
guid |
itgen_fnx_accrual_recurring_id | filtros en la plataforma, modificables, ::ancestor. |
Identifier of the recurring this accrual belongs to.Read-only. | |
amount_ |
int64 |
itgen_fnx_amount_per_invoicing | filtros en la plataforma, modificables, ::ancestor. |
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. | |
article_ |
varchar2 |
itgen_fnx_article_id | editable, article_ |
Reference to an article in the article register.When set, article defaults (price, account, unit) may be applied. | |
cost_ |
varchar2 |
itgen_fnx_cost_center_id | filtros en la plataforma, modificables, ::ancestor. |
Identifier of the cost center the recurring and its invoices are booked against. | |
cost_ |
varchar2 |
itgen_fnx_cost_center_id_2 | editable, cost_ |
Identifier of the cost center this row is booked against.Overrides the recurring-level cost center. | |
created_ |
datetime |
itgen_fnx_created_at | editable, created_ |
Timestamp when the row was created.Read-only. | |
created_ |
datetime |
itgen_fnx_created_at_2 | filtros en la plataforma, modificables, ::ancestor. |
Timestamp when the recurring was created.Read-only. | |
created_ |
varchar2 |
itgen_fnx_created_by | filtros en la plataforma, modificables, ::ancestor. |
Id of the user who created the recurring.Read-only. | |
currency |
varchar2 |
Currency | filtros en la plataforma, modificables, ::ancestor. |
ISO 4217 currency code the recurring is invoiced in (e.g.SEK, EUR). | |
customer_ |
varchar2 |
itgen_fnx_customer_address | filtros en la plataforma, modificables, ::ancestor. |
Street address of the customer. | |
customer_ |
varchar2 |
Ciudad del cliente | filtros en la plataforma, modificables, ::ancestor. |
City of the customer address. | |
customer_ |
varchar2 |
itgen_fnx_customer_country_code | filtros en la plataforma, modificables, ::ancestor. |
ISO 3166-1 alpha-2 country code of the customer address. | |
customer_ |
varchar2 |
Nombre del Cliente | filtros en la plataforma, modificables, ::ancestor. |
Customer name printed on the invoice. | |
customer_ |
varchar2 |
Numero de cliente | filtros en la plataforma, modificables, ::ancestor. |
Customer number identifying the customer in the customer register.Obligatorio. | |
customer_ |
varchar2 |
itgen_fnx_customer_phone | filtros en la plataforma, modificables, ::ancestor. |
Customer phone number. | |
customer_ |
varchar2 |
itgen_fnx_customer_zip | filtros en la plataforma, modificables, ::ancestor. |
Postal/ZIP code of the customer address. | |
dates_ |
datetime |
itgen_fnx_dates_dates_invoice_date | filtros en la plataforma, modificables, ::ancestor. |
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 | filtros en la plataforma, modificables, ::ancestor. |
The date the next invoice is generated and processed. | |
dates_ |
datetime |
itgen_fnx_dates_dates_period_start_date | filtros en la plataforma, modificables, ::ancestor. |
The start date of the next billing period. | |
dates_ |
datetime |
itgen_fnx_dates_rules_end_date | filtros en la plataforma, modificables, ::ancestor. |
The last date this recurring produces invoices.Omit for an open-ended recurring. | |
dates_ |
varchar2 |
itgen_fnx_dates_rules_frequency | filtros en la plataforma, modificables, ::ancestor. |
||
dates_ |
int64 |
itgen_fnx_dates_rules_interval | filtros en la plataforma, modificables, ::ancestor. |
How many frequency units between occurrences.Combined with frequency this reads as "every " — e.g. interval 2 with frequency MONTH means every 2 months.El valor por defecto es 1. |
|
dates_ |
varchar2 |
itgen_fnx_dates_rules_invoice_anchor | filtros en la plataforma, modificables, ::ancestor. |
||
dates_ |
varchar2 |
itgen_fnx_dates_rules_period_anchor | filtros en la plataforma, modificables, ::ancestor. |
||
delivery_ |
varchar2 |
itgen_fnx_delivery_address | filtros en la plataforma, modificables, ::ancestor. |
Delivery street address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_city | filtros en la plataforma, modificables, ::ancestor. |
City of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_country_code | filtros en la plataforma, modificables, ::ancestor. |
ISO 3166-1 alpha-2 country code of the delivery address. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_name | filtros en la plataforma, modificables, ::ancestor. |
Delivery recipient name. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_phone | filtros en la plataforma, modificables, ::ancestor. |
Contact phone number for the delivery. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_term_code | filtros en la plataforma, modificables, ::ancestor. |
Delivery terms code (e.g.Incoterm) printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_type_code | filtros en la plataforma, modificables, ::ancestor. |
Delivery method/type code printed on the invoice. | |
delivery_ |
varchar2 |
itgen_fnx_delivery_zip | filtros en la plataforma, modificables, ::ancestor. |
Postal/ZIP code of the delivery address. | |
description |
varchar2 |
Description | editable, description |
Text describing the row, printed on the invoice. | |
discount |
double |
Discount | editable, discount |
Discount applied to the row, interpreted according to discount_type. | |
discount_ |
varchar2 |
itgen_fnx_discount_type | editable, discount_ |
||
distribution_ |
varchar2 |
itgen_fnx_distribution_method | filtros en la plataforma, modificables, ::ancestor. |
||
email_ |
varchar2 |
itgen_fnx_email_to | filtros en la plataforma, modificables, ::ancestor. |
Recipient email address used to deliver the invoice when the distribution method is EMAIL. | |
id |
guid |
ID | editable, id |
Server-generated unique identifier of the row. | |
id_2 |
guid |
ID | filtros en la plataforma, modificables, ::ancestor. |
Server-generated unique identifier of the recurring. | |
invoice_ |
varchar2 |
itgen_fnx_invoice_handling | filtros en la plataforma, modificables, ::ancestor. |
||
modified_ |
datetime |
itgen_fnx_modified_at | editable, modified_ |
Timestamp when the row was last modified.Read-only. | |
modified_ |
datetime |
itgen_fnx_modified_at_2 | filtros en la plataforma, modificables, ::ancestor. |
Timestamp when the recurring was last modified.Read-only. | |
modified_ |
varchar2 |
itgen_fnx_modified_by | filtros en la plataforma, modificables, ::ancestor. |
Id of the user who last modified the recurring.Read-only. | |
order_ |
varchar2 |
itgen_fnx_order_number | filtros en la plataforma, modificables, ::ancestor. |
Customer purchase order number printed on the generated invoices. | |
our_ |
varchar2 |
itgen_fnx_our_reference | filtros en la plataforma, modificables, ::ancestor. |
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, ::ancestor. |
Payment terms applied to the generated invoices (e.g. days until due). | |
price |
double |
Price | editable, price |
Unit price before discount and VAT. | |
price_ |
varchar2 |
itgen_fnx_price_list_id | filtros en la plataforma, modificables, ::ancestor. |
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, ::ancestor. |
||
print_ |
varchar2 |
itgen_fnx_print_configuration_template | filtros en la plataforma, modificables, ::ancestor. |
if no value provided its fetched from settings | |
project_ |
varchar2 |
Identificación del Proyecto | filtros en la plataforma, modificables, ::ancestor. |
Identifier of the project the recurring and its invoices are booked against. | |
project_ |
varchar2 |
itgen_fnx_project_id_2 | editable, project_ |
Identifier of the project this row is booked against.Overrides the recurring-level project. | |
quantity |
double |
Quantity | editable, quantity |
Number of units invoiced for this row. | |
recurring_ |
guid |
itgen_fnx_recurring_id | editable, recurring_ |
Identifier of the recurring this row belongs to.Read-only. | |
remark |
varchar2 |
itgen_fnx_remark | filtros en la plataforma, modificables, ::ancestor. |
Free-text remark printed on the generated invoices. | |
row_ |
int64 |
itgen_fnx_row_index | editable, row_ |
Zero-based position of the row within the recurring's row list, determining print order. | |
serial_ |
int64 |
itgen_fnx_serial_number | filtros en la plataforma, modificables, ::ancestor. |
Server-assigned sequential number identifying the recurring within the tenant. | |
status |
varchar2 |
Status | filtros en la plataforma, modificables, ::ancestor. |
||
totals_ |
double |
itgen_fnx_totals_excl_vat | editable, totals. |
Row amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_excl_vat_2 | filtros en la plataforma, modificables, ::ancestor. |
Total amount excluding VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat | editable, totals. |
Row amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_incl_vat_2 | filtros en la plataforma, modificables, ::ancestor. |
Total amount including VAT. | |
totals_ |
double |
itgen_fnx_totals_roundoff | filtros en la plataforma, modificables, ::ancestor. |
Rounding adjustment applied to the total. | |
totals_ |
double |
itgen_fnx_totals_vat | editable, totals. |
Row VAT amount. | |
totals_ |
double |
itgen_fnx_totals_vat_2 | filtros en la plataforma, modificables, ::ancestor. |
Total VAT amount. | |
type |
varchar2 |
Type | editable, type |
||
unit |
varchar2 |
Unit | editable, unit |
Unit of measure for the quantity (e.g."hour", "pcs"). | |
vat_ |
varchar2 |
itgen_fnx_vat_option | filtros en la plataforma, modificables, ::ancestor. |
||
vat_ |
varchar2 |
itgen_fnx_vat_payment_type | filtros en la plataforma, modificables, ::ancestor. |
||
vat_ |
double |
itgen_fnx_vat_percentage | editable, vat_ |
VAT rate applied to the row, as a percentage.Typically one of 0, 6, 12 or 25. | |
your_ |
varchar2 |
itgen_fnx_your_reference | filtros en la plataforma, modificables, ::ancestor. |
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: