Please enable JavaScript to view this site.

Made in EU
Fortnox Forums

Fortnox API Data Model

Navigation: Catalog: Fortnox > Schemas > Schema: Contracts > Tables

ContractByDocumentNumber

Retrieve a single contract

Catalog: Fortnox

Schema: Contracts

Label: {res:itgen_fnx_contractbydocumentnumber_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 ContractByDocumentNumber. 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

DocumentNumber

string

☑

 

identifies the contract

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).

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 ContractByDocumentNumber are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

Contract__url

string

{res:itgen_fnx_contract__url}

☐

 

Contract__urlTaxReductionList

string

{res:itgen_fnx_contract__urltaxreductionlist}

☐

 

Contract_Active

boolean

{res:itgen_fnx_contract_active}

☐

 

Contract_AdministrationFee

double

{res:itgen_fnx_contract_administrationfee}

☐

 

Contract_BasisTaxReduction

double

{res:itgen_fnx_contract_basistaxreduction}

☐

 

Contract_Comments

string(1024)

{res:itgen_fnx_contract_comments}

☐

 

Contract_Continuous

boolean

{res:itgen_fnx_contract_continuous}

☐

 

Contract_ContractDate

datetime

{res:itgen_fnx_contract_contractdate}

☐

 

Contract_ContractLength

int32

{res:itgen_fnx_contract_contractlength}

☐

 

Contract_ContributionPercent

double

{res:itgen_fnx_contract_contributionpercent}

☐

 

Contract_ContributionValue

double

{res:itgen_fnx_contract_contributionvalue}

☐

 

Contract_CostCenter

string

{res:itgen_fnx_contract_costcenter}

☐

 

Contract_Currency

string

{res:itgen_fnx_contract_currency}

☐

 

Contract_CustomerName

string

{res:itgen_fnx_contract_customername}

☐

 

Contract_CustomerNumber

string

{res:itgen_fnx_contract_customernumber}

☐

 

Contract_DocumentNumber

string

{res:itgen_fnx_contract_documentnumber}

☐

 

Contract_EmailInformation_EmailAddressBCC

string

{res:itgen_fnx_contract_emailinformation_emailaddressbcc}

☐

 

Contract_EmailInformation_EmailAddressCC

string

{res:itgen_fnx_contract_emailinformation_emailaddresscc}

☐

 

Contract_EmailInformation_EmailAddressFrom

string

{res:itgen_fnx_contract_emailinformation_emailaddressfrom}

☐

 

Contract_EmailInformation_EmailAddressTo

string

{res:itgen_fnx_contract_emailinformation_emailaddressto}

☐

 

Contract_EmailInformation_EmailBody

string

{res:itgen_fnx_contract_emailinformation_emailbody}

☐

 

Contract_EmailInformation_EmailSubject

string

{res:itgen_fnx_contract_emailinformation_emailsubject}

☐

 

Contract_ExternalInvoiceReference1

string

{res:itgen_fnx_contract_externalinvoicereference1}

☐

 

Contract_ExternalInvoiceReference2

string

{res:itgen_fnx_contract_externalinvoicereference2}

☐

 

Contract_Freight

double

{res:itgen_fnx_contract_freight}

☐

 

Contract_Gross

double

{res:itgen_fnx_contract_gross}

☐

 

Contract_HouseWork

boolean

{res:itgen_fnx_contract_housework}

☐

 

Contract_InvoiceDiscount

double

{res:itgen_fnx_contract_invoicediscount}

☐

 

Contract_InvoiceInterval

int32

{res:itgen_fnx_contract_invoiceinterval}

☐

 

Contract_InvoicesRemaining

string

{res:itgen_fnx_contract_invoicesremaining}

☐

 

Contract_Language

string

{res:itgen_fnx_contract_language}

☐

 

Contract_LastInvoiceDate

string

{res:itgen_fnx_contract_lastinvoicedate}

☐

 

Contract_Net

double

{res:itgen_fnx_contract_net}

☐

 

Contract_OurReference

string(25)

{res:itgen_fnx_contract_ourreference}

☐

 

Contract_PeriodEnd

datetime

{res:itgen_fnx_contract_periodend}

☐

 

Contract_PeriodStart

datetime

{res:itgen_fnx_contract_periodstart}

☐

 

Contract_PriceList

string

{res:itgen_fnx_contract_pricelist}

☐

 

Contract_PrintTemplate

string

{res:itgen_fnx_contract_printtemplate}

☐

 

Contract_Project

string

{res:itgen_fnx_contract_project}

☐

 

Contract_Remarks

string(1024)

{res:itgen_fnx_contract_remarks}

☐

 

Contract_RoundOff

double

{res:itgen_fnx_contract_roundoff}

☐

 

Contract_TaxReduction

double

{res:itgen_fnx_contract_taxreduction}

☐

 

Contract_TaxReductionType

string

{res:itgen_fnx_contract_taxreductiontype}

☐

 

Contract_TemplateName

string

{res:itgen_fnx_contract_templatename}

☐

 

Contract_TemplateNumber

int32

{res:itgen_fnx_contract_templatenumber}

☐

 

Contract_TermsOfDelivery

string

{res:itgen_fnx_contract_termsofdelivery}

☐

 

Contract_TermsOfPayment

string

{res:itgen_fnx_contract_termsofpayment}

☐

 

Contract_Total

double

{res:itgen_fnx_contract_total}

☐

 

Contract_TotalToPay

double

{res:itgen_fnx_contract_totaltopay}

☐

 

Contract_TotalVAT

double

{res:itgen_fnx_contract_totalvat}

☐

 

Contract_VatIncluded

boolean

{res:itgen_fnx_contract_vatincluded}

☐

 

Contract_WayOfDelivery

string

{res:itgen_fnx_contract_wayofdelivery}

☐

 

Contract_YourOrderNumber

string(75)

{res:itgen_fnx_contract_yourordernumber}

☐

 

Contract_YourReference

string

{res:itgen_fnx_contract_yourreference}

☐

 

 

03-06-2025 18:15 Version 24.1.110-BETA+5438

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer