FIfiken
offers

POST /companies/{companySlug}/offers/send

Changed on

Sends the specified document

Request

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

Request body

methodstring[] required

The method of sending. Has to be auto, email, ehf, efaktura, sms or letter. If several methods are provided they should be in prioritized order as Fiken will only send the invoice to the first successful available method. Method "auto" tries available methods for given customer based on the information registered for the customer. The order of priority is EHF, eFaktura, Sms, and email. Method "letter" means physical letter, printed and sent by our postal service partner (extra charge per letter, available for recipient addresses in Norway only). The option "includeDocumentAttachments" is not supported by method "letter", attachments are not included even if this option is set.

includeDocumentAttachmentsboolean required

Whether the document's attachment should be included when sending (True) or not (False).

recipientNamestring
recipientEmailstring
messagestring

Additional message to send with document.

emailSendOption'document_link' | 'attachment' | 'auto'

document_link, attachment or auto. Defaults to auto which uses customer/company settings.

mergeInvoiceAndAttachmentsboolean

If sending with emailSendOption = attachment, this merges them into a single document if true.

organizationNumberstring

Brreg organization number. Defaults to the customers organization number if not provided.

mobileNumberstring

Defaults to the customers phone number. Format should include the country code. If a Norwegian phone number, the country code is not necessary.

offerIdinteger required

Id of offer to send.

Example request

{
  "method": [
    "sms",
    "email"
  ],
  "recipientName": "Bjørn Bohler",
  "recipientEmail": "bjorn.bohler@gmail.com",
  "message": "Due upon receipt",
  "emailSendOption": "document_link",
  "organizationNumber": "913312465",
  "mobileNumber": "85262741",
  "offerId": 2888156
}

Response

Sent

Changes