invantive documentation
Invantive Support ForumsLog In / Sign Up

TimeReportingArticleRegistrations: Fortnox Time Reporting Article Registrations

read only REST

  • Catalog: Fortnox
  • Schema: TimeReportingArticles
  • Label: Time Reporting Article Registrations

Get full article registrations that match filter

Response 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".

Can only retrieve data.

Summary

Response 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".

API Source

  • Endpoint: /api/time/articles-v1
  • Operation: get /api/time/articles-v1

Performance Characteristics

Characteristic Value
Average access latency (ms) 356
Full scan rows per minute 85,000
Point query rows per minute 168

The result can be cached on the client.

Parameters

Name Data Type 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 `` The start date of the search span, the max of which should be 1 year to the end date ("toDate"). Example: 2022-11-01
fromdate2 `` Defines a selection based on a start date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table).
includeNonInvoiceablePrice `` If the price of the non-invoiceable article registration is included, or not.
includeRegistrationsWithoutProject `` If the article registration without project is included, or not.
inInvoiceBasis `` If the article registration is locked on an invoice basis, or not.
internalArticles `` If the article registration is internal, which is registered on an internal customer, or not.
invoiced `` If a document is created with the article registration, or not.
lastmodified `` Retrieves all records since the provided timestamp (does not work on every table).
nonInvoiceable `` If the article registration has been moved to non-invoiceable, or not.
toDate `` 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
todate2 `` Defines a selection based on an end date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table).

Table Columns

The columns of the table TimeReportingArticleRegistrations are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
costCenter_active varchar2 Cost Centre Active filters on the platform, writable, ::ancestor.costCenter.active
costCenter_id varchar2(40) Cost Centre ID filters on the platform, writable, ::ancestor.costCenter.id
costCenter_name varchar2(255) Cost Centre Name filters on the platform, writable, ::ancestor.costCenter.name
createdBy varchar2 Created by writable, createdBy
createdTime datetime Created Time writable, createdTime
createdTime_2 datetime Created Time 2 filters on the platform, writable, ::ancestor.createdTime
customer_accountManager varchar2 Customer Account Manager filters on the platform, writable, ::ancestor.customer.accountManager
customer_active char Customer Active filters on the platform, writable, ::ancestor.customer.active
customer_defaultProjectId varchar2 Customer Default Projectid filters on the platform, writable, ::ancestor.customer.defaultProjectId
customer_deleted char Customer Deleted filters on the platform, writable, ::ancestor.customer.deleted
customer_id varchar2(40) Customer ID filters on the platform, writable, ::ancestor.customer.id
customer_invoiceCity varchar2 Customer Invoice City filters on the platform, writable, ::ancestor.customer.invoiceCity
customer_invoiceZipCode varchar2 Customer Invoice Zip Code filters on the platform, writable, ::ancestor.customer.invoiceZipCode
customer_isBusiness int32 Customer Is Business filters on the platform, writable, ::ancestor.customer.isBusiness
customer_name varchar2(255) Customer Name filters on the platform, writable, ::ancestor.customer.name
customer_number varchar2(1024) Customer Number filters on the platform, writable, ::ancestor.customer.number
customer_priceList varchar2 Customer Pricelist filters on the platform, writable, ::ancestor.customer.priceList
customer_propertyDesignation varchar2 Customer Property Designation filters on the platform, writable, ::ancestor.customer.propertyDesignation
documentId int64 Document ID writable, documentId
documentType varchar2 Document Type writable, documentType
id guid ID writable, id
id_2 guid ID filters on the platform, writable, ::ancestor.id
invoiceBasisId int64 Invoice Basis ID writable, invoiceBasisId
invoiceText varchar2(1000) Invoice Text writable, invoiceText
nonInvoiceable char Non Invoiceable writable, nonInvoiceable
note varchar2(1000) Note writable, note
orderIndex int32 Order Index writable, orderIndex
ownerId varchar2 Owner ID writable, ownerId
ownerId_2 varchar2 Owner ID 2 filters on the platform, writable, ::ancestor.ownerId
ownerName varchar2 itgen_fnx_ownername writable, ownerName
ownerName_2 varchar2 itgen_fnx_ownername_2 filters on the platform, writable, ::ancestor.ownerName
project_description varchar2(50) Project Description filters on the platform, writable, ::ancestor.project.description
project_endDate datetime Project End Date filters on the platform, writable, ::ancestor.project.endDate
project_id varchar2(40) Project ID filters on the platform, writable, ::ancestor.project.id
project_invoicedAmount double Project Invoiced Amount filters on the platform, writable, ::ancestor.project.invoicedAmount
project_orderAmount double Project Order Amount filters on the platform, writable, ::ancestor.project.orderAmount
project_orderTime double Project Order Time filters on the platform, writable, ::ancestor.project.orderTime
project_projectLeader varchar2 Project Leader filters on the platform, writable, ::ancestor.project.projectLeader
project_startDate datetime Project Start Date filters on the platform, writable, ::ancestor.project.startDate
project_status int32 Project Status filters on the platform, writable, ::ancestor.project.status
project_totalAmountInInvoices double Project Total Amount in Invoices filters on the platform, writable, ::ancestor.project.totalAmountInInvoices
purchaseDate datetime Purchase Date filters on the platform, writable, ::ancestor.purchaseDate
registeredArticle_createdBy varchar2 Registered Article Created By filters on the platform, writable, ::ancestor.registeredArticle.createdBy
registeredArticle_createdTime datetime Registered Article Created Time filters on the platform, writable, ::ancestor.registeredArticle.createdTime
registeredArticle_documentId int64 Registered Article Document ID filters on the platform, writable, ::ancestor.registeredArticle.documentId
registeredArticle_documentType varchar2 Registered Article Document Type filters on the platform, writable, ::ancestor.registeredArticle.documentType
registeredArticle_id guid Registered Article ID filters on the platform, writable, ::ancestor.registeredArticle.id
registeredArticle_invoiceBasisId int64 Registered Article Invoice Basis ID filters on the platform, writable, ::ancestor.registeredArticle.invoiceBasisId
registeredArticle_invoiceText varchar2(1000) Registered Article Invoice Text filters on the platform, writable, ::ancestor.registeredArticle.invoiceText
registeredArticle_nonInvoiceable char Registered Article Non Invoiceable filters on the platform, writable, ::ancestor.registeredArticle.nonInvoiceable
registeredArticle_note varchar2(1000) Registered Article Note filters on the platform, writable, ::ancestor.registeredArticle.note
registeredArticle_orderIndex int32 Registered Article Order Index filters on the platform, writable, ::ancestor.registeredArticle.orderIndex
registeredArticle_ownerId varchar2 Registered Article Owner ID filters on the platform, writable, ::ancestor.registeredArticle.ownerId
registeredArticle_ownerName varchar2 itgen_fnx_registeredarticle_ownername filters on the platform, writable, ::ancestor.registeredArticle.ownerName
registeredArticle_timeLocked char Registered Article Time Locked filters on the platform, writable, ::ancestor.registeredArticle.timeLocked
registeredArticle_totalQuantity decimal Registered Article Total Quantity filters on the platform, writable, ::ancestor.registeredArticle.totalQuantity
registeredArticle_unitCost decimal Registered Article Unit Cost filters on the platform, writable, ::ancestor.registeredArticle.unitCost
registeredArticle_unitPrice decimal Registered Article Unit Price filters on the platform, writable, ::ancestor.registeredArticle.unitPrice
registrationType varchar2 Registration Type filters on the platform, writable, ::ancestor.registrationType
timeLocked char Time Locked writable, timeLocked
totalQuantity decimal Total Quantity writable, totalQuantity
unitCost decimal Unit Cost writable, unitCost
unitPrice decimal Unit Price writable, unitPrice
version int64 Version filters on the platform, writable, ::ancestor.version

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: