FIfiken
sales

GET /companies/{companySlug}/sales

Changed on

Returns all sales for given company

Request

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

datestring date

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

dateLestring date

Filter based on date less than or equal to parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

dateLtstring date

Filter based on date strictly less than parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

dateGestring date

Filter based on date greater than or equal to parameter value. Dates are represented as strings formatted as YYYY-MM-DD. Example: January 1st, 1970: "1970-01-01"

dateGtstring date

Filter based on date strictly greater than 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"

saleNumberstring

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

settledboolean

When set to true, returns only sales that have been settled. Otherwise false returns all sales that have not been fully settled.

contactIdinteger

Find all results for a given contact. Must be the contactId provided by a GET contacts call.

Response

OK

saleIdinteger

Sale Id

lastModifiedDatestring date

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

transactionIdinteger
saleNumberstring

Identifier for sale.

datestring date

Due date of the invoice, format yyyy-mm-dd

kind'cash_sale' | 'invoice' | 'external_invoice'

Either cash_sale, invoice, or external_invoice.

netAmountinteger

Total net amount of the sale to be paid.

vatAmountinteger

VAT amount on sale.

settledboolean

If the sale as been marked as settled (True) or not (False).

settledDatestring date

Date the the sale was marked as settled, format yyyy-mm-dd

writeOffboolean

If a loss has been registered for this sale (tapsføring av salg).

totalPaidinteger

Total amount paid in NOK

totalPaidInCurrencyinteger

Total amount paid in other currency.

outstandingBalanceinteger
outstandingBalanceInCurrencyinteger

Outstanding balance in other currency.

currencystring

ISO 4217 currency code

dueDatestring date

Due date of the invoice, format yyyy-mm-dd

kidstring

Norwegian KID number. Number from 2 to 25 digits long.

paymentAccountstring
paymentDatestring date

Payment date of the invoice, format yyyy-mm-dd

deletedboolean

Whether the sale has been deleted or not

Example response

[
  {
    "saleId": 2888156,
    "lastModifiedDate": "2018-04-03",
    "transactionId": 3458156,
    "saleNumber": "XK455L",
    "date": "2018-04-03",
    "kind": "external_invoice",
    "netAmount": 4500,
    "vatAmount": 5400,
    "settled": true,
    "settledDate": "2023-04-03",
    "totalPaid": 524500,
    "totalPaidInCurrency": 634550,
    "outstandingBalance": 145,
    "outstandingBalanceInCurrency": 65,
    "lines": [
      {
        "lineId": 2888156,
        "netPrice": 4500,
        "vat": 500,
        "account": "3000",
        "netPriceInCurrency": 4500,
        "vatInCurrency": 500,
        "projectId": 2815556
      }
    ],
    "customer": {
      "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"
        }
      ]
    },
    "currency": "NOK",
    "dueDate": "2018-04-03",
    "kid": "5855454756",
    "paymentAccount": "1920:10001",
    "salePayments": [
      {
        "paymentId": 2888156,
        "date": "2018-04-03",
        "account": "1920:10001",
        "amount": 34000,
        "amountInNok": 500000,
        "currency": "NOK"
      }
    ],
    "saleAttachments": [
      {
        "uuid": "745b2f15-1234-4408-8bf2-b1d2d7610cb2",
        "filename": "invoice_24760.pdf",
        "identifier": "24760",
        "type": "invoice"
      }
    ],
    "paymentDate": "2018-04-03",
    "project": {
      "projectId": 73408306,
      "startDate": "2018-04-03",
      "endDate": "2018-04-03",
      "contact": {
        "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"
          }
        ]
      }
    },
    "notes": [
      {
        "author": "James Jones",
        "note": "Invoice sent after telephone conversation with customer"
      }
    ]
  }
]

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

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

    • info

      the response optional property /// became not write-only for the status

  • dff97b55851eRevision changes
    • info

      added the new optional query request parameter contactId

    • info

      added the new optional query request parameter date

    • info

      added the new optional query request parameter dateGe

    • info

      added the new optional query request parameter dateGt

    • info

      added the new optional query request parameter dateLe

    • info

      added the new optional query request parameter dateLt

    • info

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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

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

    • info

      the response optional property /// became not read-only for the status

    • info

      the response optional property / became read-only for the status

    • info

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

    • info

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

    • info

      the response property /// became required for the status

    • info

      response property items/customer/memberNumber deprecated

    • info

      response property items/project/contact/memberNumber deprecated