FIfiken
order confirmations

GET /companies/{companySlug}/orderConfirmations/{confirmationId}

Changed on

Returns order confirmation with specified id.

Request

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

Response

OK

confirmationIdinteger

offer ID

confirmationDraftUuidstring

UUID are represented as 32 hexadecimal (base-16) digits, displayed in 5 groups separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters.

datestring date

Date for offer

confirmationNumberinteger

Unique offer number generated by us.

netinteger

Net amount (in invoice currency) in cents.

vatinteger

VAT amount (in invoice currency) in cents.

grossinteger

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

commentstring

Comment/description

yourReferencestring
ourReferencestring
orderReferencestring

Reference if sending invoice via EHF.

discountnumber

The discount amount in the specified currency.

currencystring

ISO 4217 currency code, default value is NOK

contactIdinteger

Contact associated with offer.

contactPersonIdinteger

Contact person associated with the order confirmation. Must belong to given contact.

projectIdinteger
createdInvoiceinteger

If the order confirmation was used to create an invoice, the id of the associated invoice. Otherwise null is returned.

archivedboolean

If order confirmation has been archived or not.

internalCommentstring

Comment that is not shown on the order confirmation, but kept for internal use only

Example response

{
  "confirmationId": 2888156,
  "confirmationDraftUuid": "123e4567-e89b-12d3-a456-426655440000",
  "date": "2018-04-03",
  "confirmationNumber": 10001,
  "net": 25000,
  "vat": 5000,
  "gross": 30000,
  "discount": 2500,
  "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"
    }
  ],
  "contactId": 9688154,
  "contactPersonId": 9688154,
  "projectId": 2815556,
  "createdInvoice": 2815556
}

Changes

  • dff97b55851eRevision changes
    • breaking

      the response's property type changed from no type to integer for status

    • breaking

      the response's property type changed from no type to integer for status

    • breaking

      the response's property type changed from no type to integer for status

    • breaking

      the response's property type changed from no type to integer for status

  • e093a0c9db87Revision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status