Fortnox API Data Model
FinancialInvoiceByNumber |
Retrieve a single invoice paymentRetrieves the status and balance of an invoice sent to Fortnox Finans.You need to supply the invoice number in Fortox to retrieve the invoice.Note that invoices sent with the old "Noxbox" platform will not have the "ServiceName"property in the response. This new property is added to the response if the invoice issent with the new finance service.Response explanation for Service and ServiceNameService:LEDGERBASE: if the invoice is sent by using the old "Noxbox" platform, or the new finance service with the subtypes "Service Full" or "Service Light". These services are explained above in the "Fortnox Finans services" sectionREMINDER: If the invoice is sent by the new finance service, with the service Reminder ServiceServiceName (only provided for new finance service invoices):SERVICE_FULL: Ledgerbase service with automatic reminders is usedSERVICE_LIGHT: Ledgerbase service without automatic reminders is used.REMINDER_SERVICE: Reminder service is used
Catalog: Fortnox
Schema: FinanceInvoices
Label: {res:itgen_fnx_financialinvoicebynumber_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 FinancialInvoiceByNumber. 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 |
☐ |
|
Defines a selection based on a start date. Only available for invoices, orders, offers, vouchers and supplierinvoices (does not work on every table). |
lastmodified |
datetime |
☐ |
|
Retrieves all records since the provided timestamp (does not work on every table). |
Number |
string |
☑ |
|
The Fortnox invoice number |
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). |
Columns of Table Function
The columns of the table function FinancialInvoiceByNumber are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
NoxFinansInvoice__url |
string |
{res:itgen_fnx_noxfinansinvoice__url} |
☐ |
|
NoxFinansInvoice_BalanceIncludeFees |
float |
{res:itgen_fnx_noxfinansinvoice_balanceincludefees} |
☐ |
|
NoxFinansInvoice_BalanceIncludeFeesCurrency |
float |
{res:itgen_fnx_noxfinansinvoice_balanceincludefeescurrency} |
☐ |
|
NoxFinansInvoice_CurrentCapitalBalance |
float |
{res:itgen_fnx_noxfinansinvoice_currentcapitalbalance} |
☐ |
|
NoxFinansInvoice_CurrentCapitalBalanceCurrency |
float |
{res:itgen_fnx_noxfinansinvoice_currentcapitalbalancecurrency} |
☐ |
|
NoxFinansInvoice_InvoiceDocumentURL |
string |
{res:itgen_fnx_noxfinansinvoice_invoicedocumenturl} |
☐ |
|
NoxFinansInvoice_InvoiceNumber |
int32 |
{res:itgen_fnx_noxfinansinvoice_invoicenumber} |
☐ |
|
NoxFinansInvoice_NextEvent |
string |
{res:itgen_fnx_noxfinansinvoice_nextevent} |
☐ |
|
NoxFinansInvoice_NextEventDate |
datetime |
{res:itgen_fnx_noxfinansinvoice_nexteventdate} |
☐ |
|
NoxFinansInvoice_OCRNumber |
string |
{res:itgen_fnx_noxfinansinvoice_ocrnumber} |
☐ |
|
NoxFinansInvoice_Service |
string |
{res:itgen_fnx_noxfinansinvoice_service} |
☐ |
|
NoxFinansInvoice_ServiceName |
string |
{res:itgen_fnx_noxfinansinvoice_servicename} |
☐ |
|
NoxFinansInvoice_Status |
string |
{res:itgen_fnx_noxfinansinvoice_status} |
☐ |
|
03-06-2025 18:15 Version 24.1.110-BETA+5438
