Sign in
credit notes

Returns all credit notes for given company

get/companies/{companySlug}/creditNotes

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.

issueDatestring date

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

issueDateLestring 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"

issueDateLtstring 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"

issueDateGestring 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"

issueDateGtstring 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"

customerIdinteger

Returns only credit notes sent to specified customer. Must be the contactId provided by a GET contacts call.

settledboolean

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

creditNoteDraftUuidstring uuid

Filter based on the UUID of the credit note draft that was used to create a given invoice. Applies only to "uavhengig kreditnotaer".

Response

OK

creditNoteIdinteger required

Id of credit note

creditNoteNumberinteger required

Unique credit note number generated by us.

kidstring

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

netinteger required

Net amount (in creditNote currency) in cents.

vatinteger required

VAT amount (in creditNote currency) in cents.

grossinteger required

Gross amount (= net+VAT) (in creditNote currency) in cents.

netInNokinteger required

Net amount in NOK (in cents)

vatInNokinteger required

VAT amount in NOK (in cents)

grossInNokinteger required

Gross amount in NOK (in cents)

creditNoteTextstring

Comment/description printed above the credit note lines.

yourReferencestring
ourReferencestring
orderReferencestring

Reference if sending via EHF.

currencystring

ISO 4217 currency code

issueDatestring date

Issue date of the credit note, format yyyy-mm-dd

lastModifiedDatestring date

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

settledboolean

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

associatedInvoiceIdinteger

Id of associated invoice

creditNoteDraftUuidstring

The UUID of the credit note draft used to create the credit note. Credit notes created directly from invoices (POST / creditNotes/full and POST /creditNotes/partial) will not have a draft uuid as no draft is created in this case.

Example response

[
  {
    "creditNoteId": 2888156,
    "creditNoteNumber": 10001,
    "kid": "5855454756",
    "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"
        }
      ]
    },
    "net": 25000,
    "vat": 5000,
    "gross": 30000,
    "netInNok": 25000,
    "vatInNok": 5000,
    "grossInNok": 30000,
    "address": {
      "streetAddress": "Karl Johan 34",
      "streetAddressLine2": "H0405",
      "city": "Oslo",
      "postCode": "0550",
      "country": "Norway"
    },
    "lines": [
      {
        "net": 4500,
        "vat": 500,
        "vatType": "HIGH",
        "gross": 5000,
        "netInNok": 4500,
        "vatInNok": 500,
        "grossInNok": 5000,
        "vatInPercent": 25,
        "unitPrice": 4550,
        "quantity": 5,
        "discount": 25,
        "productId": 2888156,
        "productName": "Gardening Gloves VI2",
        "description": "Goatskin, with extra-long suede cuffs",
        "comment": "One size fits all",
        "incomeAccount": "3000"
      }
    ],
    "currency": "NOK",
    "issueDate": "2018-04-03",
    "lastModifiedDate": "2024-04-03",
    "settled": true,
    "associatedInvoiceId": 2888156,
    "creditNoteDraftUuid": "123e4567-e89b-12d3-a456-426655440000",
    "creditNotePdf": {
      "uuid": "745b2f15-1234-4408-8bf2-b1d2d7610cb2",
      "filename": "invoice_24760.pdf",
      "identifier": "24760",
      "type": "invoice"
    },
    "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"
          }
        ]
      }
    },
    "sale": {
      "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

No recorded changes to this endpoint across all 1 revision of this API.