Record a payment

curl --request POST \
  --url https://api.envoi.no/v1/invoices/{id}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 1250,
  "paidOn": "2026-09-29"
}
'

import requests

url = "https://api.envoi.no/v1/invoices/{id}/payments"

payload = {
    "amount": 1250,
    "paidOn": "2026-09-29"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({amount: 1250, paidOn: '2026-09-29'})
};

fetch('https://api.envoi.no/v1/invoices/{id}/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.envoi.no/v1/invoices/{id}/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 1250,
    'paidOn' => '2026-09-29'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.envoi.no/v1/invoices/{id}/payments"

	payload := strings.NewReader("{\n  \"amount\": 1250,\n  \"paidOn\": \"2026-09-29\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.envoi.no/v1/invoices/{id}/payments")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1250,\n  \"paidOn\": \"2026-09-29\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.envoi.no/v1/invoices/{id}/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1250,\n  \"paidOn\": \"2026-09-29\"\n}"

response = http.request(request)
puts response.read_body

{
  "paymentId": "e7f1a2b3-c4d5-4e6f-8a9b-0c1d2e3f4a5b",
  "invoiceStatus": "paid",
  "paidAmount": 1250,
  "outstandingAmount": 0
}

Invoices

Record a payment

Records one payment on a sent invoice. Part payments are allowed; the invoice becomes paid when nothing is outstanding.

The payment’s id is derived from the API client’s grant and the Idempotency-Key, so one key names one payment for as long as the invoice exists. The same key on the same invoice answers 201 with the existing payment and records nothing twice, also after the key’s 7 days have passed. The same key on another invoice is 422 idempotency-key-reused, at any age.

POST

https://api.envoi.no

invoices

{id}

payments

Record a payment

curl --request POST \
  --url https://api.envoi.no/v1/invoices/{id}/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "amount": 1250,
  "paidOn": "2026-09-29"
}
'

import requests

url = "https://api.envoi.no/v1/invoices/{id}/payments"

payload = {
    "amount": 1250,
    "paidOn": "2026-09-29"
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({amount: 1250, paidOn: '2026-09-29'})
};

fetch('https://api.envoi.no/v1/invoices/{id}/payments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.envoi.no/v1/invoices/{id}/payments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 1250,
    'paidOn' => '2026-09-29'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.envoi.no/v1/invoices/{id}/payments"

	payload := strings.NewReader("{\n  \"amount\": 1250,\n  \"paidOn\": \"2026-09-29\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.envoi.no/v1/invoices/{id}/payments")
  .header("Idempotency-Key", "<idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1250,\n  \"paidOn\": \"2026-09-29\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.envoi.no/v1/invoices/{id}/payments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1250,\n  \"paidOn\": \"2026-09-29\"\n}"

response = http.request(request)
puts response.read_body

{
  "paymentId": "e7f1a2b3-c4d5-4e6f-8a9b-0c1d2e3f4a5b",
  "invoiceStatus": "paid",
  "paidAmount": 1250,
  "outstandingAmount": 0
}

Authorizations

Authorization

string

header

required

OAuth 2.0 client credentials. The token request also needs the audience form field (the Account ID), which OAuth tooling does not always send; see POST /v1/oauth/token.

Headers

Idempotency-Key

string

required

Required on every POST, at most 255 characters. Use a new UUID for each logical operation. The first request with a key runs, and its answer (any status below 500) is stored for 7 days. A retry with the same key, method, path and body gets the stored answer again with Idempotency-Replayed: true, and nothing runs twice. The same key with a different body or path is 422 idempotency-key-reused; the same key while the first request is still running is 409 idempotency-key-in-progress. A 5xx answer is not stored, so the same key may be retried. A key belongs to the API client's grant (one environment).

Maximum string length: 255

Path Parameters

string<uuid>

required

The invoice's id.

Body

application/json

The payment.

A payment to record.

amount

number

required

Amount paid, in kroner. Above zero and at most what is owed.

paidOn

string<date>

required

The date the money was paid; not in the future. Required.

Response

The payment and the invoice's new balance.

A recorded payment and the invoice's new balance.

paymentId

string<uuid>

required

The payment's id. The same Idempotency-Key on the same invoice always gives the same id.

invoiceStatus

string

required

The invoice's status after the payment, for example paid.

paidAmount

number

required

How much has been paid on the invoice in all.

outstandingAmount

number

required

How much is still owed.

Get started

Authentication

Invoices

Customers

Accounting

Record a payment

Authorizations

Headers

Path Parameters

Body

Response