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). | ||
from |
`` | 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). | ||
include |
`` | If the price of the non-invoiceable article registration is included, or not. | ||
include |
`` | If the article registration without project is included, or not. | ||
in |
`` | If the article registration is locked on an invoice basis, or not. | ||
internal |
`` | 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). | ||
non |
`` | 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 |
|---|---|---|---|---|---|
cost |
varchar2 |
Cost Centre Active | filters on the platform, writable, ::ancestor. |
||
cost |
varchar2 |
Cost Centre ID | filters on the platform, writable, ::ancestor. |
||
cost |
varchar2 |
Cost Centre Name | filters on the platform, writable, ::ancestor. |
||
created |
varchar2 |
Created by | writable, created |
||
created |
datetime |
Created Time | writable, created |
||
created |
datetime |
Created Time 2 | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Account Manager | filters on the platform, writable, ::ancestor. |
||
customer_ |
char |
Customer Active | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Default Projectid | filters on the platform, writable, ::ancestor. |
||
customer_ |
char |
Customer Deleted | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer ID | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Invoice City | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Invoice Zip Code | filters on the platform, writable, ::ancestor. |
||
customer_ |
int32 |
Customer Is Business | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Name | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Number | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Pricelist | filters on the platform, writable, ::ancestor. |
||
customer_ |
varchar2 |
Customer Property Designation | filters on the platform, writable, ::ancestor. |
||
document |
int64 |
Document ID | writable, document |
||
document |
varchar2 |
Document Type | writable, document |
||
id |
guid |
ID | writable, id |
||
id_2 |
guid |
ID | filters on the platform, writable, ::ancestor. |
||
invoice |
int64 |
Invoice Basis ID | writable, invoice |
||
invoice |
varchar2 |
Invoice Text | writable, invoice |
||
non |
char |
Non Invoiceable | writable, non |
||
note |
varchar2 |
Note | writable, note |
||
order |
int32 |
Order Index | writable, order |
||
owner |
varchar2 |
Owner ID | writable, owner |
||
owner |
varchar2 |
Owner ID 2 | filters on the platform, writable, ::ancestor. |
||
owner |
varchar2 |
itgen_fnx_ownername | writable, owner |
||
owner |
varchar2 |
itgen_fnx_ownername_2 | filters on the platform, writable, ::ancestor. |
||
project_ |
varchar2 |
Project Description | filters on the platform, writable, ::ancestor. |
||
project_ |
datetime |
Project End Date | filters on the platform, writable, ::ancestor. |
||
project_ |
varchar2 |
Project ID | filters on the platform, writable, ::ancestor. |
||
project_ |
double |
Project Invoiced Amount | filters on the platform, writable, ::ancestor. |
||
project_ |
double |
Project Order Amount | filters on the platform, writable, ::ancestor. |
||
project_ |
double |
Project Order Time | filters on the platform, writable, ::ancestor. |
||
project_ |
varchar2 |
Project Leader | filters on the platform, writable, ::ancestor. |
||
project_ |
datetime |
Project Start Date | filters on the platform, writable, ::ancestor. |
||
project_ |
int32 |
Project Status | filters on the platform, writable, ::ancestor. |
||
project_ |
double |
Project Total Amount in Invoices | filters on the platform, writable, ::ancestor. |
||
purchase |
datetime |
Purchase Date | filters on the platform, writable, ::ancestor. |
||
registered |
varchar2 |
Registered Article Created By | filters on the platform, writable, ::ancestor. |
||
registered |
datetime |
Registered Article Created Time | filters on the platform, writable, ::ancestor. |
||
registered |
int64 |
Registered Article Document ID | filters on the platform, writable, ::ancestor. |
||
registered |
varchar2 |
Registered Article Document Type | filters on the platform, writable, ::ancestor. |
||
registered |
guid |
Registered Article ID | filters on the platform, writable, ::ancestor. |
||
registered |
int64 |
Registered Article Invoice Basis ID | filters on the platform, writable, ::ancestor. |
||
registered |
varchar2 |
Registered Article Invoice Text | filters on the platform, writable, ::ancestor. |
||
registered |
char |
Registered Article Non Invoiceable | filters on the platform, writable, ::ancestor. |
||
registered |
varchar2 |
Registered Article Note | filters on the platform, writable, ::ancestor. |
||
registered |
int32 |
Registered Article Order Index | filters on the platform, writable, ::ancestor. |
||
registered |
varchar2 |
Registered Article Owner ID | filters on the platform, writable, ::ancestor. |
||
registered |
varchar2 |
itgen_fnx_registeredarticle_ownername | filters on the platform, writable, ::ancestor. |
||
registered |
char |
Registered Article Time Locked | filters on the platform, writable, ::ancestor. |
||
registered |
decimal |
Registered Article Total Quantity | filters on the platform, writable, ::ancestor. |
||
registered |
decimal |
Registered Article Unit Cost | filters on the platform, writable, ::ancestor. |
||
registered |
decimal |
Registered Article Unit Price | filters on the platform, writable, ::ancestor. |
||
registration |
varchar2 |
Registration Type | filters on the platform, writable, ::ancestor. |
||
time |
char |
Time Locked | writable, time |
||
total |
decimal |
Total Quantity | writable, total |
||
unit |
decimal |
Unit Cost | writable, unit |
||
unit |
decimal |
Unit Price | writable, unit |
||
version |
int64 |
Version | filters on the platform, writable, ::ancestor. |
Release Notes
What changed per release in the tables, columns, attributes and capabilities of the driver: