Shipment methods


We provide a service that will determine what are the available shipment methods for a recipient.

To select sending methods for your document, you create a JSON object with dynamic properties that represent your options.

You currently have 8 different sending options - paper, email, avtaleGiro, ehf, eFaktura, vipps, sms and copy email.

All these option can be added in any combination. However, there is one requirement of at least having either paper, email, avtaleGiro or ehf.

Let’s go through the different options.

Paper

The value of the paper property is just an empty object.

The address will be fetched from the recipient found in the document being sent.

1
2
3
{
    "paper": {}
}

Email

The value of the email property is a list of address objects.

You at least need to have one address in the list if you have the email property in the main object.

1
2
3
4
5
6
7
{
    "email": [
        {
            "address": "example@sendregning.no"
        }
    ]
}

AvtaleGiro

The value of the avtaleGiro property is just an empty object.

If eFaktura is available it can be sent together with avtaleGiro (see eFaktura shipment description).

1
2
3
{
    "avtaleGiro": {}
}

EHF

The value of the ehf property is an object that could contain the organisation number.

If omitted - an organisation number must exist for the recipient.

If organisation number is set, then it will be prioritized ahead of the recipient organisation number.

1
2
3
4
5
{
    "ehf": {
        "organisationNumber": "976098897"
    }
}

eFaktura

The value of the eFaktura property is an object with optional boolean property avtaleGiro (if also available).

1
2
3
4
5
{
    "eFaktura": {
      "avtaleGiro" : true
    }
}

Vipps

The value of the vipps property is an object that must contain the mobile number for the recipient.

1
2
3
4
5
{
    "vipps": {
        "mobileNumber": "11111111"
    }
}

SMS

The value of the sms property is a list of mobileNumber-message objects.

You at least need to have one mobileNumber-message object in the list if you have the sms property in the main object.

A link to a pdf of the document will be added as a suffix to the text message.

1
2
3
4
5
6
7
8
{
    "sms": [
        {
            "mobileNumber": "11111111",
            "message": "sms text"
        }
    ]
}

Copy

Currently, we only support copy on email.

These emails are formulated a bit different and the document has a copy watermark.

At least one email object needs to be added to the list if the email property is set.

1
2
3
4
5
6
7
8
9
{
    "copy": {
        "email": [
            {
                "address": "copy@sendregning.no"
            }
        ]
    }
}