GET

Description

Retrieves a list of suppliers or a single supplier.

URL structure

https://api.fortnox.se/3/suppliers/{SupplierNumber}

Method

GET

Version

3

Response

The supplier register can return a list of records or a single record. By specifying a SupplierNumber in the URL, a single record will be returned. Not specifying a SupplierNumber will return a list of records.

<?xml version="1.0" encoding="UTF-8"?>
<Suppliers TotalResources="3" TotalPages="1" CurrentPage="1">
  <SupplierSubset url="https://api.fortnox.se/3/suppliers/3">
    <City>Helsingborg</City>
    <Email></Email>
    <Name>El &amp; Energi AB</Name>
    <OrganisationNumber>640904-6171</OrganisationNumber>
    <Phone></Phone>
    <SupplierNumber>3</SupplierNumber>
    <ZipCode>25200</ZipCode>
  </SupplierSubset>

  [...]

  <SupplierSubset url="https://api.fortnox.se/3/suppliers/4">
    <City>ÖRNSKÖLDSVIK</City>
    <Email></Email>
    <Name>Byggfirman AB</Name>
    <OrganisationNumber>870812-4923</OrganisationNumber>
    <Phone></Phone>
    <SupplierNumber>4</SupplierNumber>
    <ZipCode>891 33</ZipCode>
  </SupplierSubset>
</Suppliers>
<?xml version="1.0" encoding="UTF-8"?>
<Supplier url="https://api.fortnox.se/3/suppliers/4">
  <Active>true</Active>
  <Address1>Vattengränden</Address1>
  <Address2></Address2>
  <Bank></Bank>
  <BankAccountNumber></BankAccountNumber>
  <BG></BG>
  <BIC></BIC>
  <BranchCode></BranchCode>
  <City>ÖRNSKÖLDSVIK</City>
  <ClearingNumber></ClearingNumber>
  <Comments></Comments>
  <CostCenter></CostCenter>
  <Country>Sverige</Country>
  <CountryCode>SE</CountryCode>
  <Currency>SEK</Currency>
  <DisablePaymentFile>false</DisablePaymentFile>
  <Email></Email>
  <Fax></Fax>
  <IBAN></IBAN>
  <Name>Byggfirman AB</Name>
  <OrganisationNumber>870812-4923</OrganisationNumber>
  <OurReference></OurReference>
  <OurCustomerNumber></OurCustomerNumber>
  <PG></PG>
  <Phone1></Phone1>
  <Phone2></Phone2>
  <PreDefinedAccount></PreDefinedAccount>
  <Project></Project>
  <SupplierNumber>4</SupplierNumber>
  <TermsOfPayment></TermsOfPayment>
  <VATNumber></VATNumber>
  <VATType>NORMAL</VATType>
  <VisitingAddress></VisitingAddress>
  <VisitingCity></VisitingCity>
  <VisitingCountry></VisitingCountry>
  <VisitingCountryCode></VisitingCountryCode>
  <VisitingZipCode></VisitingZipCode>
  <WorkPlace></WorkPlace>
  <WWW></WWW>
  <YourReference></YourReference>
  <ZipCode>891 33</ZipCode>
</Supplier>
{
  "MetaInformation": {
    "@TotalResources": 3,
    "@TotalPages": 1,
    "@CurrentPage": 1
  },
  "Suppliers": [
    {
      "@url": "https://api.fortnox.se/3/suppliers/3",
      "City": "Helsingborg",
      "Email": "",
      "Name": "El & Energi AB",
      "OrganisationNumber": "640904-6171",
      "Phone": "",
      "SupplierNumber": "3",
      "ZipCode": "25200"
    },

    [...]

    {
      "@url": "https://api.fortnox.se/3/suppliers/4",
      "City": "ÖRNSKÖLDSVIK",
      "Email": "",
      "Name": "Byggfirman AB",
      "OrganisationNumber": "870812-4923",
      "Phone": "",
      "SupplierNumber": "4",
      "ZipCode": "891 33"
    }
  ]
}
{
  "Supplier": {
    "@url": "https://api.fortnox.se/3/suppliers/4",
    "Active": true,
    "Address1": "Vattengränden",
    "Address2": null,
    "Bank": null,
    "BankAccountNumber": null,
    "BG": null,
    "BIC": null,
    "BranchCode": null,
    "City": "ÖRNSKÖLDSVIK",
    "ClearingNumber": null,
    "Comments": null,
    "CostCenter": "",
    "Country": "Sverige",
    "CountryCode": "SE",
    "Currency": "SEK",
    "DisablePaymentFile": false,
    "Email": "",
    "Fax": null,
    "IBAN": null,
    "Name": "Byggfirman AB",
    "OrganisationNumber": "870812-4923",
    "OurReference": "",
    "OurCustomerNumber": null,
    "PG": null,
    "Phone1": null,
    "Phone2": null,
    "PreDefinedAccount": null,
    "Project": "",
    "SupplierNumber": "4",
    "TermsOfPayment": "",
    "VATNumber": "",
    "VATType": "NORMAL",
    "VisitingAddress": null,
    "VisitingCity": null,
    "VisitingCountry": null,
    "VisitingCountryCode": null,
    "VisitingZipCode": null,
    "WorkPlace": null,
    "WWW": "",
    "YourReference": "",
    "ZipCode": "891 33"
  }
}

POST

Description

Creates a supplier.

URL structure

https://api.fortnox.se/3/suppliers

Method

POST

Version

3

Request

The request body should contain a structure of a supplier, either in JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<Supplier>
  <Name>Taxi AB</Name>
</Supplier>
{
  "Supplier": {
    "Name": "Taxi AB"
  }
}

Response

The response should contain the created supplier in either JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<Supplier url="https://api.fortnox.se/3/suppliers/6">
  <Active>true</Active>
  <Address1></Address1>
  <Address2></Address2>
  <Bank></Bank>
  <BankAccountNumber></BankAccountNumber>
  <BG></BG>
  <BIC></BIC>
  <BranchCode></BranchCode>
  <City></City>
  <ClearingNumber></ClearingNumber>
  <Comments></Comments>
  <CostCenter></CostCenter>
  <Country></Country>
  <CountryCode></CountryCode>
  <Currency>SEK</Currency>
  <DisablePaymentFile>false</DisablePaymentFile>
  <Email></Email>
  <Fax></Fax>
  <IBAN></IBAN>
  <Name>Taxi AB</Name>
  <OrganisationNumber></OrganisationNumber>
  <OurReference></OurReference>
  <OurCustomerNumber></OurCustomerNumber>
  <PG></PG>
  <Phone1></Phone1>
  <Phone2></Phone2>
  <PreDefinedAccount></PreDefinedAccount>
  <Project></Project>
  <SupplierNumber>7</SupplierNumber>
  <TermsOfPayment></TermsOfPayment>
  <VATNumber></VATNumber>
  <VATType>NORMAL</VATType>
  <VisitingAddress></VisitingAddress>
  <VisitingCity></VisitingCity>
  <VisitingCountry></VisitingCountry>
  <VisitingCountryCode></VisitingCountryCode>
  <VisitingZipCode></VisitingZipCode>
  <WorkPlace></WorkPlace>
  <WWW></WWW>
  <YourReference></YourReference>
  <ZipCode></ZipCode>
</Supplier>
{
  "Supplier": {
    "@url": "https://api.fortnox.se/3/suppliers/6",
    "Active": true,
    "Address1": null,
    "Address2": null,
    "Bank": null,
    "BankAccountNumber": null,
    "BG": null,
    "BIC": null,
    "BranchCode": null,
    "City": null,
    "ClearingNumber": null,
    "Comments": null,
    "CostCenter": null,
    "Country": null,
    "CountryCode": null,
    "Currency": "SEK",
    "DisablePaymentFile": false,
    "Email": "",
    "Fax": null,
    "IBAN": null,
    "Name": "Taxi AB",
    "OrganisationNumber": "",
    "OurReference": "",
    "OurCustomerNumber": null,
    "PG": null,
    "Phone1": null,
    "Phone2": null,
    "PreDefinedAccount": null,
    "Project": "",
    "SupplierNumber": 6,
    "TermsOfPayment": "",
    "VATNumber": "",
    "VATType": "NORMAL",
    "VisitingAddress": null,
    "VisitingCity": null,
    "VisitingCountry": null,
    "VisitingCountryCode": null,
    "VisitingZipCode": null,
    "WorkPlace": null,
    "WWW": "",
    "YourReference": "",
    "ZipCode": null
  }
}

PUT

Description

Updates a supplier.

URL structure

https://api.fortnox.se/3/suppliers/{SupplierNumber}

Method

PUT

Version

3

Request

The request body should contain a structure of a supplier, either in JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<Supplier>
  <Active>false</Active>
</Supplier>
{
  "Supplier": {
    "Active": false
  }
}

Response

The response should contain the updated supplier in either JSON or XML.

<?xml version="1.0" encoding="UTF-8"?>
<Supplier url="https://api.fortnox.se/3/suppliers/6">
  <Active>false</Active>
  <Address1></Address1>
  <Address2></Address2>
  <Bank></Bank>
  <BankAccountNumber></BankAccountNumber>
  <BG></BG>
  <BIC></BIC>
  <BranchCode></BranchCode>
  <City></City>
  <ClearingNumber></ClearingNumber>
  <Comments></Comments>
  <CostCenter></CostCenter>
  <Country></Country>
  <CountryCode></CountryCode>
  <Currency>SEK</Currency>
  <DisablePaymentFile>false</DisablePaymentFile>
  <Email></Email>
  <Fax></Fax>
  <IBAN></IBAN>
  <Name>Taxi AB</Name>
  <OrganisationNumber></OrganisationNumber>
  <OurReference></OurReference>
  <OurCustomerNumber></OurCustomerNumber>
  <PG></PG>
  <Phone1></Phone1>
  <Phone2></Phone2>
  <PreDefinedAccount></PreDefinedAccount>
  <Project></Project>
  <SupplierNumber>7</SupplierNumber>
  <TermsOfPayment></TermsOfPayment>
  <VATNumber></VATNumber>
  <VATType>NORMAL</VATType>
  <VisitingAddress></VisitingAddress>
  <VisitingCity></VisitingCity>
  <VisitingCountry></VisitingCountry>
  <VisitingCountryCode></VisitingCountryCode>
  <VisitingZipCode></VisitingZipCode>
  <WorkPlace></WorkPlace>
  <WWW></WWW>
  <YourReference></YourReference>
  <ZipCode></ZipCode>
</Supplier>
{
  "Supplier": {
    "@url": "https://api.fortnox.se/3/suppliers/6",
    "Active": false,
    "Address1": null,
    "Address2": null,
    "Bank": null,
    "BankAccountNumber": null,
    "BG": null,
    "BIC": null,
    "BranchCode": null,
    "City": null,
    "ClearingNumber": null,
    "Comments": null,
    "CostCenter": null,
    "Country": null,
    "CountryCode": null,
    "Currency": "SEK",
    "DisablePaymentFile": false,
    "Email": "",
    "Fax": null,
    "IBAN": null,
    "Name": "Taxi AB",
    "OrganisationNumber": "",
    "OurReference": "",
    "OurCustomerNumber": null,
    "PG": null,
    "Phone1": null,
    "Phone2": null,
    "PreDefinedAccount": null,
    "Project": "",
    "SupplierNumber": "6",
    "TermsOfPayment": "",
    "VATNumber": "",
    "VATType": "NORMAL",
    "VisitingAddress": null,
    "VisitingCity": null,
    "VisitingCountry": null,
    "VisitingCountryCode": null,
    "VisitingZipCode": null,
    "WorkPlace": null,
    "WWW": "",
    "YourReference": "",
    "ZipCode": null
  }
}

Fields

Field Description Limits Type Searchable Sortable Required R/W
Active If active Boolean R/W
Address1 First address field  – String  – R/W
Address2 Second address field String R/W
Bank Bank of the supplier String R/W
BankAccountNumber Bank account number of the supplier Integer R/W
BG BG number for the supplier 0-9, – String R/W
BIC Bank Identifier Code String R/W
BranchCode Branch Code(SNI) String R/W
City City of the supplier address String Yes R/W
ClearingNumber Clearing number Integer R/W
Comments Comments String R/W
CostCenter Cost center code String R/W
Country Country of the supplier address String R
CountryCode Country code of the supplier address 2 chars String R/W
Currency Currency of the supplier 3 chars String R/W
DisablePaymentFile Payment file disabled for the supplier Bool R/W
Email Email of the supplier String Yes R/W
Fax Fax number String R/W
IBAN International Bank Account Number String R/W
Name Name of the supplier String Yes Yes Yes R/W
OrganisationNumber Organisation number of the supplier a-ö, 0-9, – String Yes R/W
OurReference Our reference for the supplier  – String R/W
OurCustomerNumber Our customer number for the supplier String R/W
PG PG number for the supplier String R/W
Phone1 Phone number for the supplier 0-9, +, (, ) String Yes R/W
Phone2 Phone number for the supplier 0-9, +, (, ) String Yes R/W
PreDefinedAccount Pre defined account of the supplier 4 chars String R/W
Project Project number String R/W
SupplierNumber The supplier number. If not provided, the next supplier number in the series will be used. String Yes Yes R/W*
TermsOfPayment The suppliers terms of payment String R/W
VATNumber VAT Number String R/W
VATType VAT Type REVERSE / NORMAL / UIF String R/W
VisitingAddress Visiting address String R/W
VisitingCity Visiting city String R/W
VisitingCountry Visiting country String R/W
VisitingCountryCode Visiting country code String R/W
VisitingZipCode Visiting zip code String R/W
WorkPlace Work place(CFAR) String R/W
WWW The suppliers website String R/W
YourReference Your reference for the supplier String R/W
ZipCode The zip code of the supplier address String Yes R/W

* Only writable during POST.