FIfiken
contacts

GET /companies/{companySlug}/contacts

Changed on

Retrieves all contacts for the specified company.

Request

  • Base URL
    https://api.fiken.no/api/v2
  • URL
    https://api.fiken.no/api/v2/companies/{companySlug}/contacts
  • 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.

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"

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"

supplierNumberinteger

Find all results with the supplier number equal to the specified parameter.

customerNumberinteger

Find all results with the customer number equal to the specified parameter.

memberNumberinteger

Find all results with the member number equal to the specified parameter.

memberNumberStringstring

Find all results with the member number equal to the specified parameter.

namestring

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

organizationNumberstring

Find all results with the organization number equal to the specified parameter.

emailstring

Find all results with the email equal to the specified parameter.

customerboolean

Returns all contacts that are customers. If filter is set for both supplier and customer = true, only contacts that are both supplier and customer will be returned.

supplierboolean

Returns all contacts that are suppliers. If filter is set for both supplier and customer = true, only contacts that are both supplier and customer will be returned.

inactiveboolean

Return all active contacts (false) or all inactive contacts (true).

groupstring

Return contacts in contact group, exact match only. Groups are only used for customers, not suppliers.

sortBy'lastModified asc' | 'lastModified desc' | 'createdDate asc' | 'createdDate desc'

Sorts results in either ascending (asc) or descending (desc) order based on the parameter value.

phoneNumberstring

Find all results with the phone number equal to the specified parameter.

Response

OK

contactIdinteger
createdDatestring date

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

lastModifiedDatestring date

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

namestring required
emailstring
organizationNumberstring

Brreg organization number.

customerNumberinteger
customerAccountCodestring

Format 1500:XXXXX

phoneNumberstring
memberNumbernumber

A number that can be used to connect a contact to your own data. This field is no longer used and instead memberNumberString should be used.

memberNumberStringstring

A number/id that can be used to connect a contact to your own data.

supplierNumberinteger
supplierAccountCodestring

Format 2400:XXXXX

customerboolean

True if the contact is a customer. It is possible for a contact to be both customer and supplier.

supplierboolean

True if the contact is a supplier. It is possible for a contact to be both supplier and customer.

bankAccountNumberstring
currencystring

ISO 4217 currency code. Default foreign currency to use when creating invoice to this contact (USD, EUR, SEK etc)

languagestring nullable

The language to use when sending documents to this contact. NORWEGIAN or ENGLISH. Defaults to NORWEGIAN.

inactiveboolean

Whether the contact has been deactivated (true) or is active (false)

daysUntilInvoicingDueDateinteger

Default number of days until due date for invoices.

discountnumber

Discount value should be a percent with a value between 0 and 100. Decimal values such as 25.5 are also allowed.

groupsstring[]

Example response

[
  {
    "contactId": 2747365,
    "createdDate": "2018-04-03",
    "lastModifiedDate": "2018-04-03",
    "name": "Fiken AS",
    "email": "kontakt@fiken.gmail",
    "organizationNumber": "913312465",
    "customerNumber": 51248,
    "customerAccountCode": "1500:20001",
    "phoneNumber": "62158537",
    "memberNumber": 5464,
    "memberNumberString": "5464",
    "supplierAccountCode": "2400:20001",
    "bankAccountNumber": "11112233334",
    "contactPerson": [
      {
        "contactPersonId": 2747365,
        "name": "Betty Boop",
        "email": "bb@gmail.com",
        "phoneNumber": "98573564",
        "address": {
          "streetAddress": "Karl Johan 34",
          "streetAddressLine2": "H0405",
          "city": "Oslo",
          "postCode": "0550",
          "country": "Norway"
        }
      }
    ],
    "notes": [
      {
        "author": "Betty Boop",
        "note": "Garage 45"
      }
    ],
    "currency": "NOK",
    "language": "Norwegian",
    "inactive": true,
    "daysUntilInvoicingDueDate": 15,
    "discount": 25,
    "address": {
      "streetAddress": "Karl Johan 34",
      "streetAddressLine2": "H0405",
      "city": "Oslo",
      "postCode": "0550",
      "country": "Norway"
    },
    "documents": [
      {
        "uuid": "745b2f15-1234-4408-8bf2-b1d2d7610cb2",
        "filename": "invoice_24760.pdf",
        "identifier": "24760",
        "type": "invoice"
      }
    ]
  }
]

Changes

  • 2473dacdb89cRevision changes
    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

  • dff97b55851eRevision changes
    • info

      added the new optional query request parameter memberNumberString

    • info

      added the new optional query request parameter phoneNumber

    • info

      query request parameter memberNumber was deprecated

    • info

      added the optional property / to the response with the status

    • info

      added the optional write-only property items/memberNumberString to the response with the status

    • info

      response property items/memberNumber deprecated