purchases

PATCH /companies/{companySlug}/purchases/{purchaseId}/settled

Changed on

Marks the purchase as settled without payment. This is synonymous with "sett til oppgjort uten betaling" in the GUI. It is possible to change the date of settlement by sending a new settledDate.

Request

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

Response

OK

purchaseIdinteger

Id of given purchase.

transactionIdinteger
identifierstring

Invoice/sale number or similar.

datestring date required

Payment date, format yyyy-mm-dd

dueDatestring date

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

kind'cash_purchase' | 'supplier' required

Purchased with cash or through a supplier.

paidboolean required
currencystring required

ISO 4217 currency code

paymentAccountstring
paymentDatestring date

Payment date, format yyyy-mm-dd

kidstring

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

deletedboolean

Whether the purchase has been deleted or not

settledboolean

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

settledDatestring date

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

Example response

{
  "purchaseId": 2888156,
  "transactionId": 3458156,
  "date": "2018-04-03",
  "dueDate": "2018-04-03",
  "kind": "cash_purchase",
  "paid": true,
  "lines": [
    {
      "lineId": 2888156,
      "netPrice": 4500,
      "vat": 500,
      "account": "3000",
      "netPriceInCurrency": 4500,
      "vatInCurrency": 500,
      "projectId": 2815556
    }
  ],
  "supplier": {
    "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",
  "paymentAccount": "1920:10001",
  "paymentDate": "2018-04-03",
  "payments": [
    {
      "paymentId": 2888156,
      "date": "2018-04-03",
      "account": "1920:10001",
      "amount": 34000,
      "amountInNok": 500000,
      "currency": "NOK"
    }
  ],
  "purchaseAttachments": [
    {
      "uuid": "745b2f15-1234-4408-8bf2-b1d2d7610cb2",
      "filename": "invoice_24760.pdf",
      "identifier": "24760",
      "type": "invoice"
    }
  ],
  "kid": "5855454756",
  "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"
          }
        ]
      }
    }
  ],
  "settled": true,
  "settledDate": "2024-04-03"
}

Changes