Please enable JavaScript to view this site.

Made in EU
Fortnox Forums

Fortnox API Data Model

Navigation: Catalog: Fortnox > Schemas > Schema: TimeReporting_Articles > Tables

TimeReportingArticles

Get full article registrations that match filterResponse property descriptions:     id - The unique id of a basic common combination of article registrations. (The basic common combination means "user/purchase date/customer/project/cost center", which leads to a dialog with several article registrations.)     purchaseDate - The date on which the article is purchased or registered for charging.     ownerId - The user ID who creates the basic common combination.     version - The version of the basic common combination (article dialog) being updated, which is used for handling the concurrency issue.     registrationType - It is always "ARTICLE" for article list endpoint.     Sub-Class - ArticleRegistration:         id - The unique id of an article registration.         registrationId - The id of the basic common combination.         orderIndex - the order index for the article registration in regard of the common combination.         ownerId - The user ID who owns the article registration.         totalQuantity - The quantity of the article.         unitPrice - The unit price connected to the article registration, which might be locked on an invoice/order basis or for non-invoiceable.         unitCost - The unit cost connected to the article registration, which might be locked on an invoice/order basis.         invoiceBasisId - The ID of invoice/order basis which is used for creating an invoice/order.         nonInvoiceable - If the article registration would be ignored for charging or not.         note - The note on the article registration.         documentId - The document ID which includes the article registration and is created in Invoicing application.         documentType - The document type which could be "invoice" or "order".

Catalog: Fortnox

Schema: TimeReporting_Articles

Label: {res:itgen_fnx_timereportingarticles_plural}

This is a read-only table function. The Fortnox API may not support changing the data or the Invantive UniversalSQL driver for Fortnox does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the Fortnox API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function TimeReportingArticles. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name

Data Type

Required

Default Value

Documentation

financialyear

int64

☐

 

Selects what financial year that should be used (does not work on every table).

financialyeardate

datetime

☐

 

Selects by date, what financial year that should be used (does not work on every table).

fromDate

datetime

☐

 

The start date of the search span, the max of which should be 1 year to the end date ("toDate").Example: 2022-11-01

fromdate1

datetime

☐

 

Defines a selection based on a start date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table).

includeNonInvoiceablePrice

boolean

☐

 

If the price of the non-invoiceable article registration is included, or not.

includeRegistrationsWithoutProject

boolean

☐

 

If the article registration without project is included, or not.

inInvoiceBasis

boolean

☐

 

If the article registration is locked on an invoice basis, or not.

internalArticles

boolean

☐

 

If the article registration is internal, which is registered on an internal customer, or not.

invoiced

boolean

☐

 

If a document is created with the article registration, or not.

lastmodified

datetime

☐

 

Retrieves all records since the provided timestamp (does not work on every table).

nonInvoiceable

boolean

☐

 

If the article registration has been moved to non-invoiceable, or not.

toDate

datetime

☐

 

The end date of the search span, the max of which should be 1 year back to the start date ("fromDate").Example: 2022-11-30

todate1

datetime

☐

 

Defines a selection based on an end date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table).

 

Columns of Table Function

The columns of the table function TimeReportingArticles are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

costCenter_active

string

{res:itgen_fnx_costcenter_active}

☐

 

costCenter_id

string(40)

{res:itgen_fnx_costcenter_id}

☐

 

costCenter_name

string(255)

{res:itgen_fnx_costcenter_name}

☐

 

createdTime

datetime

{res:itgen_fnx_createdtime}

☐

 

customer_accountManager

string

{res:itgen_fnx_customer_accountmanager}

☐

 

customer_active

boolean

{res:itgen_fnx_customer_active}

☐

 

customer_defaultProjectId

string

{res:itgen_fnx_customer_defaultprojectid}

☐

 

customer_deleted

boolean

{res:itgen_fnx_customer_deleted}

☐

 

customer_id

string(40)

{res:itgen_fnx_customer_id}

☐

 

customer_invoiceCity

string

{res:itgen_fnx_customer_invoicecity}

☐

 

customer_invoiceZipCode

string

{res:itgen_fnx_customer_invoicezipcode}

☐

 

customer_isBusiness

int32

{res:itgen_fnx_customer_isbusiness}

☐

 

customer_name

string(255)

{res:itgen_fnx_customer_name}

☐

 

customer_number

string(1024)

{res:itgen_fnx_customer_number}

☐

 

customer_priceList

string

{res:itgen_fnx_customer_pricelist}

☐

 

customer_propertyDesignation

string

{res:itgen_fnx_customer_propertydesignation}

☐

 

id

guid

{res:itgen_fnx_id}

☐

 

ownerId

string

{res:itgen_fnx_ownerid}

☐

 

project_description

string(50)

{res:itgen_fnx_project_description}

☐

 

project_endDate

datetime

{res:itgen_fnx_project_enddate}

☐

 

project_id

string(40)

{res:itgen_fnx_project_id}

☐

 

project_invoicedAmount

double

{res:itgen_fnx_project_invoicedamount}

☐

 

project_orderAmount

double

{res:itgen_fnx_project_orderamount}

☐

 

project_orderTime

double

{res:itgen_fnx_project_ordertime}

☐

 

project_projectLeader

string

{res:itgen_fnx_project_projectleader}

☐

 

project_startDate

datetime

{res:itgen_fnx_project_startdate}

☐

 

project_status

int32

{res:itgen_fnx_project_status}

☐

 

project_totalAmountInInvoices

double

{res:itgen_fnx_project_totalamountininvoices}

☐

 

purchaseDate

datetime

{res:itgen_fnx_purchasedate}

☐

 

registeredArticle_createdBy

string

{res:itgen_fnx_registeredarticle_createdby}

☐

 

registeredArticle_createdTime

datetime

{res:itgen_fnx_registeredarticle_createdtime}

☐

 

registeredArticle_documentId

int64

{res:itgen_fnx_registeredarticle_documentid}

☐

 

registeredArticle_documentType

string

{res:itgen_fnx_registeredarticle_documenttype}

☐

 

registeredArticle_id

guid

{res:itgen_fnx_registeredarticle_id}

☐

 

registeredArticle_invoiceBasisId

int64

{res:itgen_fnx_registeredarticle_invoicebasisid}

☐

 

registeredArticle_invoiceText

string(1000)

{res:itgen_fnx_registeredarticle_invoicetext}

☐

 

registeredArticle_nonInvoiceable

boolean

{res:itgen_fnx_registeredarticle_noninvoiceable}

☐

 

registeredArticle_note

string(1000)

{res:itgen_fnx_registeredarticle_note}

☐

 

registeredArticle_orderIndex

int32

{res:itgen_fnx_registeredarticle_orderindex}

☐

 

registeredArticle_ownerId

string

{res:itgen_fnx_registeredarticle_ownerid}

☐

 

registeredArticle_timeLocked

boolean

{res:itgen_fnx_registeredarticle_timelocked}

☐

 

registeredArticle_totalQuantity

decimal

{res:itgen_fnx_registeredarticle_totalquantity}

☐

 

registeredArticle_unitCost

decimal

{res:itgen_fnx_registeredarticle_unitcost}

☐

 

registeredArticle_unitPrice

decimal

{res:itgen_fnx_registeredarticle_unitprice}

☐

 

registrationType

string

{res:itgen_fnx_registrationtype}

☐

 

version

int64

{res:itgen_fnx_version}

☐

 

 

03-06-2025 18:15 Version 24.1.110-BETA+5438

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer