Fortnox API Data Model
Customers |
Retrieve a list of customersThe customers are returned sorted by customer number with the lowest number appearing first.
Catalog: Fortnox
Schema: Customers
Primary Keys: CustomerNumber
Label: {res:itgen_fnx_customers_plural}
Can retrieve data and change data using insert, update and delete.
Parameters of Table Function
The following parameters can be used to control the behaviour of the table function Customers. 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 |
|---|---|---|---|---|
city |
string |
☐ |
|
filter by city |
customernumber |
string |
☐ |
|
filter by customer number |
string |
☐ |
|
filter by email |
|
filter |
string |
☐ |
|
possibility to filter customers (Values: active, inactive) |
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). |
gln |
string |
☐ |
|
filter by gln |
glndelivery |
string |
☐ |
|
filter by gln delivery |
lastmodified |
string |
☐ |
|
filter by last modified |
name |
string |
☐ |
|
filter by name |
organisationnumber |
string |
☐ |
|
filter by organisation number |
phone |
string |
☐ |
|
filter by phone |
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). |
zipcode |
string |
☐ |
|
filter by zip code |
Columns of Table Function
The columns of the table function Customers 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 |
|---|---|---|---|---|
Address1 |
string(1024) |
{res:itgen_fnx_address1} |
☐ |
|
Address2 |
string(1024) |
{res:itgen_fnx_address2} |
☐ |
|
c_url |
string |
{res:itgen_fnx_c_url} |
☐ |
|
City |
string(1024) |
{res:itgen_fnx_city} |
☐ |
|
CustomerNumber |
string(1024) |
{res:itgen_fnx_customernumber} |
☐ |
|
string(1024) |
{res:itgen_fnx_email} |
☐ |
|
|
Name |
string(1024) |
{res:itgen_fnx_name} |
☐ |
|
OrganisationNumber |
string(30) |
{res:itgen_fnx_organisationnumber} |
☐ |
|
Phone |
string(1024) |
{res:itgen_fnx_phone} |
☐ |
|
ZipCode |
string(10) |
{res:itgen_fnx_zipcode} |
☐ |
|
03-06-2025 18:15 Version 24.1.110-BETA+5438
