IncomingGoodDocuments |
List Incoming Goods DocumentsList incoming goods documents matching the given parameters.Sortable fields:id,has_delivery_note,delivery_note_id,supplier_number,date
Catalog: Fortnox
Schema: Warehouse_IncomingGoods
Primary Keys: id
Label: {res:itgen_fnx_incominggooddocuments_plural}
Retrieve: true
Insert: true
Update: true
Delete: false
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function IncomingGoodDocuments. 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 |
|---|---|---|---|---|
completed |
boolean |
☐ |
|
`true` to include only completed documents.`false` to include only non-completed documents. |
deliveryNote |
string |
☐ |
|
Include only documents where `deliveryNote`-field contains the given text (case-insensitive). |
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 |
☐ |
|
Defines a selection based on a start date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table). |
itemId |
string |
☐ |
|
Include only documents with the given `itemId`. |
lastmodified |
datetime |
☐ |
|
Retrieves all records since the provided timestamp (does not work on every table). |
note |
string |
☐ |
|
Include only documents where `note`-field contains the given text (case-insensitive). |
q |
string |
☐ |
|
Include only documents where `id` or `deliveryNote`-field contains the given text (case-insensitive). |
released |
boolean |
☐ |
|
`true` to include only released documents.`false` to include only non-released documents. |
supplierNumber |
string |
☐ |
|
Include only documents with the given `supplierNumber`. |
todate |
datetime |
☐ |
|
Defines a selection based on an end date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table). |
voided |
boolean |
☐ |
|
`true` to include only voided documents.`false` to include only non-voided documents. |
Columns of Table Function
The columns of the table function IncomingGoodDocuments 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 |
Documentation |
|---|---|---|---|---|
completed |
boolean |
{res:itgen_fnx_completed} |
☐ |
|
date |
datetime |
{res:itgen_fnx_date} |
☐ |
|
deliveryNoteId |
string |
{res:itgen_fnx_deliverynoteid} |
☐ |
|
hasDeliveryNote |
boolean |
{res:itgen_fnx_hasdeliverynote} |
☐ |
|
id |
int64 |
{res:itgen_fnx_id} |
☐ |
|
note |
string |
{res:itgen_fnx_note} |
☐ |
|
released |
boolean |
{res:itgen_fnx_released} |
☐ |
|
stockPointId |
guid |
{res:itgen_fnx_stockpointid} |
☐ |
|
supplierName |
string |
{res:itgen_fnx_suppliername} |
☐ |
|
supplierNumber |
string |
{res:itgen_fnx_suppliernumber} |
☐ |
|
unmatchedValue |
decimal |
{res:itgen_fnx_unmatchedvalue} |
☐ |
|
voided |
boolean |
{res:itgen_fnx_voided} |
☐ |
|
03-06-2025 18:15 Version 24.1.110-BETA+5438
Fortnox API Data Model