FIfiken
products

GET /companies/{companySlug}/products

Changed on

Returns all products for given company

Request

  • Base URL
    https://api.fiken.no/api/v2
  • URL
    https://api.fiken.no/api/v2/companies/{companySlug}/products
  • Auth
    OAuth 2
    Authorization code: https://fiken.no/oauth/authorize
    Token URL: https://fiken.no/oauth/token

Query parameters

pageinteger

Returns the number of the page to return. Valid page values are integers from 0 to the total number of pages. Default value is 0.

pageSizeinteger

Defines the number of entries to return on each page. Maximum number of results that can be returned at one time are 100. Default value is 25.

createdDatestring date

Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

createdDateLestring date

Returns results that were created before or on the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

createdDateLtstring date

Returns results that were created strictly before the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

createdDateGestring date

Returns results that were created after or on the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

createdDateGtstring date

Returns results that were created strictly after the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

lastModifiedstring date

Filter based on date of last modification. Returns results that were last modified on the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

lastModifiedLestring date

Returns results that have been last modified before or on the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

lastModifiedLtstring date

Returns results that have been last modified strictly before the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

lastModifiedGestring date

Returns results that have been last modified after or on the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

lastModifiedGtstring date

Returns results that have been last modified strictly after the date provided as a parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

namestring

Find all results with product name equal to the specified parameter.

productNumberstring

Find all results with product number (varenummer) equal to the specified parameter.

activeboolean

Returns active (true) or inactive (false) products.

Response

OK

productIdinteger

Product Id.

createdDatestring date

Date that product was created in Fiken, format yyyy-mm-dd

lastModifiedDatestring date

Date that product was last modified in Fiken, format yyyy-mm-dd.

namestring required

Product name.

unitPriceinteger

The net unit price in cents.

costPriceinteger

Cost price in cents, including freight, customs duty and other non-recoverable costs. Excluding VAT if the company is VAT-registered, including VAT otherwise. Optional.

incomeAccountstring required

The accounting account that will receive the payment.

vatTypestring required

One of {"HIGH", "MEDIUM", "LOW", "EXEMPT", "EXEMPT_IMPORT_EXPORT", "EXEMPT_REVERSE", "OUTSIDE", "NONE"}. "HIGH" is the most common.

activeboolean required

If product is in use (True) or not (False).

productNumberstring
stocknumber float

Number of products available in stock. If not provided, stock value is set to null. Decimal values are accepted. For example 5.5

notestring

Optional field for additional information.

Example response

[
  {
    "productId": 2888156,
    "createdDate": "2018-04-03",
    "lastModifiedDate": "2018-04-03",
    "name": "Spade",
    "unitPrice": 300000,
    "costPrice": 150000,
    "incomeAccount": "3000",
    "vatType": "HIGH",
    "active": true,
    "productNumber": "125-1",
    "stock": 5
  }
]

Changes

  • 29111da67f94Revision changes
    • info

      added the optional property / to the response with the status

  • e093a0c9db87Revision changes
    • info

      added the new optional query request parameter createdDateGe

    • info

      added the new optional query request parameter createdDateGt

    • info

      added the new optional query request parameter createdDateLe

    • info

      added the new optional query request parameter createdDateLt

    • info

      added the new optional query request parameter lastModifiedGe

    • info

      added the new optional query request parameter lastModifiedGt

    • info

      added the new optional query request parameter lastModifiedLe

    • info

      added the new optional query request parameter lastModifiedLt

    • info

      the response property / became required for the status