Skip to main content
POST
/
customer-invoices
Create Customer Invoice
curl --request POST \
  --url https://api.mijnklantportaal.nl/v1/customer-invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form customerId=cst_abc12345def678 \
  --form invoiceNumber=2014-001 \
  --form issuedAt=2024-04-31 \
  --form amount=12.95 \
  --form pdf='@example-file' \
  --form 'paidAt=2024-05-11 12:59:00' \
  --form sendNotification=true
{
  "id": "inv_abc12345def678",
  "customerId": "cst_abc12345def678",
  "invoiceNumber": "2024-001",
  "issuedAt": "2024-04-29",
  "currency": "EUR",
  "amount": "12.95",
  "paidAt": "2024-05-28T21:00:00+02:00",
  "createdAt": "2024-04-29T21:00:00+02:00",
  "links": {
    "customer": {
      "href": "https://api.mijnklantportaal.nl/v1/customers/cst_abc12345def678",
      "type": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

multipart/form-data
​
customerId
string
required

ID of the customer this invoice is meant for

Example:

"cst_abc12345def678"

​
invoiceNumber
string
required

Number of the invoice, as string

Example:

"2014-001"

​
issuedAt
string
required

Date when the invoice is issued, in YYYY-mm-dd format

Example:

"2024-04-31"

​
amount
string
required

Amount of the invoice, as string. Only Euro (EUR) is supported at the moment.

Example:

"12.95"

​
pdf
file
required

The PDF file of the invoice

​
paidAt
string

Date and time when the invoice is paid, in YYYY-mm-dd HH:mm:ss format. Leave empty when the invoice is still due.

Example:

"2024-05-11 12:59:00"

​
sendNotification
boolean

Indicates if MijnKlantportaal should send out the notification to inform the customer about the new invoice

Example:

true

Response

Returning the created Customer Invoice

Customer Invoice

​
id
string

ID of the invoice, always starting with inv_.

Example:

"inv_abc12345def678"

​
customerId
string

ID of the customer which the invoice belongs to.

Example:

"cst_abc12345def678"

​
invoiceNumber
string

Number of the invoice as string.

Example:

"2024-001"

​
issuedAt
string

Issue date of the invoice. Formatted as YYYY-mm-dd.

Example:

"2024-04-29"

​
currency
string

Currency of the invoice amount.

Example:

"EUR"

​
amount
string

Invoice amount as string.

Example:

"12.95"

​
paidAt
string | null

Date the invoice is marked as paid. Written in ATOM format.

Example:

"2024-05-28T21:00:00+02:00"

​
createdAt
string

Date and time when the invoice was added to MijnKlantportaal. Written in ATOM format.

Example:

"2024-04-29T21:00:00+02:00"

​
links
object