FIfiken
recurring invoices

PUT /companies/{companySlug}/recurringInvoices/{recurringInvoiceId}/jobs/{jobId}/recipients

Changed on

Replaces the delivery configuration of a single job — exactly how invoices generated by the job are sent. Any channel not included in the request is turned off, and the job must end up with at least one recipient (otherwise the request is rejected). EHF, eFaktura and SMS are mutually exclusive. EHF requires the customer to have an organization number and a supported currency; eFaktura requires an approved eFaktura agreement for the company. Vipps is no longer available and cannot be set.

Request

  • Base URL
    https://api.fiken.no/api/v2
  • URL
    https://api.fiken.no/api/v2/companies/{companySlug}/recurringInvoices/{recurringInvoiceId}/jobs/{jobId}/recipients
  • Auth
    OAuth 2
    Authorization code: https://fiken.no/oauth/authorize
    Token URL: https://fiken.no/oauth/token

Request body

emailsstring[]

Ad-hoc email addresses that do not belong to a contact person. On GET, recipients whose email matches one of the customer's contact persons are reported under contactPersonIds instead. On PUT these replace the job's email recipients (together with contactPersonIds).

contactPersonIdsinteger[]

Contact persons of the job's customer who receive the invoice. On GET, recipients whose email matches one of the customer's contact persons are reported here. On PUT, each contact person's email is added as a recipient (together with emails); all must belong to the customer and have an email.

ehfboolean

Send as EHF. Requires the customer to have an organization number and a supported currency.

efakturaboolean

Send as eFaktura. Requires an approved eFaktura agreement for the company.

letterboolean

Send as letter to the customer's registered address.

smsPhoneNumberstring nullable

Phone number to notify by SMS. Omit or null to not send by SMS.

Response

OK

Changes