Please enable JavaScript to view this site.

Made in EU
Fortnox Forums

Fortnox API Data Model

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

OfferByDocumentNumber

Retrieve a single offer

Catalog: Fortnox

Schema: Offers

Label: {res:itgen_fnx_offerbydocumentnumber_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 OfferByDocumentNumber. 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 offer

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

Name

Data Type

Label

Required

Documentation

Offer__url

string

{res:itgen_fnx_offer__url}

☐

 

Offer__urlTaxReductionList

string

{res:itgen_fnx_offer__urltaxreductionlist}

☐

 

Offer_Address1

string(1024)

{res:itgen_fnx_offer_address1}

☐

 

Offer_Address2

string(1024)

{res:itgen_fnx_offer_address2}

☐

 

Offer_AdministrationFee

double

{res:itgen_fnx_offer_administrationfee}

☐

 

Offer_AdministrationFeeVAT

double

{res:itgen_fnx_offer_administrationfeevat}

☐

 

Offer_BasisTaxReduction

double

{res:itgen_fnx_offer_basistaxreduction}

☐

 

Offer_Cancelled

boolean

{res:itgen_fnx_offer_cancelled}

☐

 

Offer_City

string(1024)

{res:itgen_fnx_offer_city}

☐

 

Offer_Comments

string(1024)

{res:itgen_fnx_offer_comments}

☐

 

Offer_ContributionPercent

double

{res:itgen_fnx_offer_contributionpercent}

☐

 

Offer_ContributionValue

double

{res:itgen_fnx_offer_contributionvalue}

☐

 

Offer_CopyRemarks

boolean

{res:itgen_fnx_offer_copyremarks}

☐

 

Offer_CostCenter

string

{res:itgen_fnx_offer_costcenter}

☐

 

Offer_Country

string

{res:itgen_fnx_offer_country}

☐

 

Offer_Currency

string

{res:itgen_fnx_offer_currency}

☐

 

Offer_CurrencyRate

double

{res:itgen_fnx_offer_currencyrate}

☐

 

Offer_CurrencyUnit

int32

{res:itgen_fnx_offer_currencyunit}

☐

 

Offer_CustomerName

string

{res:itgen_fnx_offer_customername}

☐

 

Offer_CustomerNumber

string

{res:itgen_fnx_offer_customernumber}

☐

 

Offer_DeliveryAddress1

string(1024)

{res:itgen_fnx_offer_deliveryaddress1}

☐

 

Offer_DeliveryAddress2

string(1024)

{res:itgen_fnx_offer_deliveryaddress2}

☐

 

Offer_DeliveryCity

string(1024)

{res:itgen_fnx_offer_deliverycity}

☐

 

Offer_DeliveryCountry

string

{res:itgen_fnx_offer_deliverycountry}

☐

 

Offer_DeliveryDate

datetime

{res:itgen_fnx_offer_deliverydate}

☐

 

Offer_DeliveryName

string(1024)

{res:itgen_fnx_offer_deliveryname}

☐

 

Offer_DeliveryZipCode

string

{res:itgen_fnx_offer_deliveryzipcode}

☐

 

Offer_DocumentNumber

string

{res:itgen_fnx_offer_documentnumber}

☐

 

Offer_EmailInformation_EmailAddressBCC

string

{res:itgen_fnx_offer_emailinformation_emailaddressbcc}

☐

 

Offer_EmailInformation_EmailAddressCC

string

{res:itgen_fnx_offer_emailinformation_emailaddresscc}

☐

 

Offer_EmailInformation_EmailAddressFrom

string

{res:itgen_fnx_offer_emailinformation_emailaddressfrom}

☐

 

Offer_EmailInformation_EmailAddressTo

string

{res:itgen_fnx_offer_emailinformation_emailaddressto}

☐

 

Offer_EmailInformation_EmailBody

string(20000)

{res:itgen_fnx_offer_emailinformation_emailbody}

☐

 

Offer_EmailInformation_EmailSubject

string(100)

{res:itgen_fnx_offer_emailinformation_emailsubject}

☐

 

Offer_ExpireDate

datetime

{res:itgen_fnx_offer_expiredate}

☐

 

Offer_Freight

double

{res:itgen_fnx_offer_freight}

☐

 

Offer_FreightVAT

double

{res:itgen_fnx_offer_freightvat}

☐

 

Offer_Gross

double

{res:itgen_fnx_offer_gross}

☐

 

Offer_HouseWork

boolean

{res:itgen_fnx_offer_housework}

☐

 

Offer_InvoiceReference

string

{res:itgen_fnx_offer_invoicereference}

☐

 

Offer_Language

string

{res:itgen_fnx_offer_language}

☐

 

Offer_Net

double

{res:itgen_fnx_offer_net}

☐

 

Offer_NotCompleted

boolean

{res:itgen_fnx_offer_notcompleted}

☐

 

Offer_OfferDate

datetime

{res:itgen_fnx_offer_offerdate}

☐

 

Offer_OrderReference

string

{res:itgen_fnx_offer_orderreference}

☐

 

Offer_OrganisationNumber

string

{res:itgen_fnx_offer_organisationnumber}

☐

 

Offer_OurReference

string

{res:itgen_fnx_offer_ourreference}

☐

 

Offer_Phone1

string

{res:itgen_fnx_offer_phone1}

☐

 

Offer_Phone2

string

{res:itgen_fnx_offer_phone2}

☐

 

Offer_PriceList

string

{res:itgen_fnx_offer_pricelist}

☐

 

Offer_PrintTemplate

string

{res:itgen_fnx_offer_printtemplate}

☐

 

Offer_Project

string

{res:itgen_fnx_offer_project}

☐

 

Offer_Remarks

string

{res:itgen_fnx_offer_remarks}

☐

 

Offer_RoundOff

double

{res:itgen_fnx_offer_roundoff}

☐

 

Offer_Sent

boolean

{res:itgen_fnx_offer_sent}

☐

 

Offer_TaxReduction

int32

{res:itgen_fnx_offer_taxreduction}

☐

 

Offer_TaxReductionType

string

{res:itgen_fnx_offer_taxreductiontype}

☐

 

Offer_TermsOfDelivery

string

{res:itgen_fnx_offer_termsofdelivery}

☐

 

Offer_TermsOfPayment

string

{res:itgen_fnx_offer_termsofpayment}

☐

 

Offer_Total

double

{res:itgen_fnx_offer_total}

☐

 

Offer_TotalToPay

double

{res:itgen_fnx_offer_totaltopay}

☐

 

Offer_TotalVAT

double

{res:itgen_fnx_offer_totalvat}

☐

 

Offer_VATIncluded

boolean

{res:itgen_fnx_offer_vatincluded}

☐

 

Offer_WayOfDelivery

string

{res:itgen_fnx_offer_wayofdelivery}

☐

 

Offer_YourReference

string

{res:itgen_fnx_offer_yourreference}

☐

 

Offer_YourReferenceNumber

string

{res:itgen_fnx_offer_yourreferencenumber}

☐

 

Offer_ZipCode

string

{res:itgen_fnx_offer_zipcode}

☐

 

 

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