FIfiken
credit notes

POST /companies/{companySlug}/creditNotes/partial

Changed on

Creates a new credit note that doesn't fully cover the total amount of the associated invoice.

Request

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

Request body

ourReferencestring

Optional

yourReferencestring

Optional - Your reference for invoice, free string format.

orderReferencestring

Reference if sending via EHF.

projectinteger

Optional - Project associated with the credit note.

currencystring

ISO 4217 currency code

issueDatestring date required

Date that the credit note is issued, format yyyy-mm-dd

invoiceIdinteger

Optional - Id of invoice that the credit note is associated with.

contactIdinteger

Id of contact that the credit note is associated with.

contactPersonIdinteger

Id of contact person that the credit note is associated with (Credit person must belong to the provided contact).

creditNoteTextstring
roundingType'none' | 'round_half' | 'round_whole' | 'round_down_half' | 'round_down_whole'

Type of øreavrunding (rounding) to apply to the total. 'none' means no rounding (default). 'round_half' rounds to nearest 50 øre, 'round_whole' rounds to nearest whole krone, 'round_down_half' rounds down to nearest 50 øre, 'round_down_whole' rounds down to nearest whole krone. Only applicable for NOK currency. Does not change the company's default rounding setting.

Example request

{
  "currency": "NOK",
  "issueDate": "2018-04-03",
  "invoiceId": 2888156,
  "contactId": 3588152,
  "contactPersonId": 3588152,
  "creditNoteText": "Invoice for services rendered during the Oslo Knitting Festival.",
  "lines": [
    {
      "incomeAccount": "3000",
      "vatType": "HIGH",
      "unitPrice": 4550,
      "quantity": 5,
      "discount": 25,
      "productId": 2888156,
      "description": "Goatskin, with extra-long suede cuffs",
      "comment": "One size fits all"
    }
  ],
  "roundingType": "none"
}

Response

Created

Changes