Skip to main content
POST
/
v1
/
invoices
Create invoice
curl --request POST \
  --url https://api.platnova.com/v1/invoices \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "email": "[email protected]",
  "note": "Thank you for your business",
  "items": [
    {
      "name": "Consulting",
      "unit_price": 150,
      "quantity": 2,
      "currency": "NGN",
      "total": 300
    },
    {
      "name": "Setup fee",
      "unit_price": 50,
      "quantity": 1,
      "currency": "NGN",
      "total": 50
    }
  ],
  "charges": {
    "discount": {
      "amount": "0",
      "type": "flat",
      "enabled": false
    },
    "tax": {
      "amount": "7.5",
      "type": "percentage",
      "enabled": true
    },
    "fee": {
      "amount": "0",
      "type": "flat",
      "enabled": false
    },
    "shipping": {
      "amount": "0",
      "type": "flat",
      "enabled": false
    }
  },
  "payment_schedule": {
    "type": "one_time",
    "due_date": "2026-02-15T23:59:59Z",
    "send_date": "2026-01-30T00:00:00Z",
    "payment_methods": [
      {
        "id": "bank_transfer",
        "value": "058"
      }
    ],
    "reminders": true,
    "reminder_timing": {
      "type": "before_due_date",
      "days": 3
    }
  }
}
'
import requests

url = "https://api.platnova.com/v1/invoices"

payload = {
    "email": "[email protected]",
    "note": "Thank you for your business",
    "items": [
        {
            "name": "Consulting",
            "unit_price": 150,
            "quantity": 2,
            "currency": "NGN",
            "total": 300
        },
        {
            "name": "Setup fee",
            "unit_price": 50,
            "quantity": 1,
            "currency": "NGN",
            "total": 50
        }
    ],
    "charges": {
        "discount": {
            "amount": "0",
            "type": "flat",
            "enabled": False
        },
        "tax": {
            "amount": "7.5",
            "type": "percentage",
            "enabled": True
        },
        "fee": {
            "amount": "0",
            "type": "flat",
            "enabled": False
        },
        "shipping": {
            "amount": "0",
            "type": "flat",
            "enabled": False
        }
    },
    "payment_schedule": {
        "type": "one_time",
        "due_date": "2026-02-15T23:59:59Z",
        "send_date": "2026-01-30T00:00:00Z",
        "payment_methods": [
            {
                "id": "bank_transfer",
                "value": "058"
            }
        ],
        "reminders": True,
        "reminder_timing": {
            "type": "before_due_date",
            "days": 3
        }
    }
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    email: '[email protected]',
    note: 'Thank you for your business',
    items: [
      {name: 'Consulting', unit_price: 150, quantity: 2, currency: 'NGN', total: 300},
      {name: 'Setup fee', unit_price: 50, quantity: 1, currency: 'NGN', total: 50}
    ],
    charges: {
      discount: {amount: '0', type: 'flat', enabled: false},
      tax: {amount: '7.5', type: 'percentage', enabled: true},
      fee: {amount: '0', type: 'flat', enabled: false},
      shipping: {amount: '0', type: 'flat', enabled: false}
    },
    payment_schedule: {
      type: 'one_time',
      due_date: '2026-02-15T23:59:59Z',
      send_date: '2026-01-30T00:00:00Z',
      payment_methods: [{id: 'bank_transfer', value: '058'}],
      reminders: true,
      reminder_timing: {type: 'before_due_date', days: 3}
    }
  })
};

fetch('https://api.platnova.com/v1/invoices', 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.platnova.com/v1/invoices",
  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([
    'email' => '[email protected]',
    'note' => 'Thank you for your business',
    'items' => [
        [
                'name' => 'Consulting',
                'unit_price' => 150,
                'quantity' => 2,
                'currency' => 'NGN',
                'total' => 300
        ],
        [
                'name' => 'Setup fee',
                'unit_price' => 50,
                'quantity' => 1,
                'currency' => 'NGN',
                'total' => 50
        ]
    ],
    'charges' => [
        'discount' => [
                'amount' => '0',
                'type' => 'flat',
                'enabled' => false
        ],
        'tax' => [
                'amount' => '7.5',
                'type' => 'percentage',
                'enabled' => true
        ],
        'fee' => [
                'amount' => '0',
                'type' => 'flat',
                'enabled' => false
        ],
        'shipping' => [
                'amount' => '0',
                'type' => 'flat',
                'enabled' => false
        ]
    ],
    'payment_schedule' => [
        'type' => 'one_time',
        'due_date' => '2026-02-15T23:59:59Z',
        'send_date' => '2026-01-30T00:00:00Z',
        'payment_methods' => [
                [
                                'id' => 'bank_transfer',
                                'value' => '058'
                ]
        ],
        'reminders' => true,
        'reminder_timing' => [
                'type' => 'before_due_date',
                'days' => 3
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-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.platnova.com/v1/invoices"

	payload := strings.NewReader("{\n  \"email\": \"[email protected]\",\n  \"note\": \"Thank you for your business\",\n  \"items\": [\n    {\n      \"name\": \"Consulting\",\n      \"unit_price\": 150,\n      \"quantity\": 2,\n      \"currency\": \"NGN\",\n      \"total\": 300\n    },\n    {\n      \"name\": \"Setup fee\",\n      \"unit_price\": 50,\n      \"quantity\": 1,\n      \"currency\": \"NGN\",\n      \"total\": 50\n    }\n  ],\n  \"charges\": {\n    \"discount\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    },\n    \"tax\": {\n      \"amount\": \"7.5\",\n      \"type\": \"percentage\",\n      \"enabled\": true\n    },\n    \"fee\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    },\n    \"shipping\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    }\n  },\n  \"payment_schedule\": {\n    \"type\": \"one_time\",\n    \"due_date\": \"2026-02-15T23:59:59Z\",\n    \"send_date\": \"2026-01-30T00:00:00Z\",\n    \"payment_methods\": [\n      {\n        \"id\": \"bank_transfer\",\n        \"value\": \"058\"\n      }\n    ],\n    \"reminders\": true,\n    \"reminder_timing\": {\n      \"type\": \"before_due_date\",\n      \"days\": 3\n    }\n  }\n}")

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

	req.Header.Add("X-API-KEY", "<api-key>")
	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.platnova.com/v1/invoices")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"email\": \"[email protected]\",\n  \"note\": \"Thank you for your business\",\n  \"items\": [\n    {\n      \"name\": \"Consulting\",\n      \"unit_price\": 150,\n      \"quantity\": 2,\n      \"currency\": \"NGN\",\n      \"total\": 300\n    },\n    {\n      \"name\": \"Setup fee\",\n      \"unit_price\": 50,\n      \"quantity\": 1,\n      \"currency\": \"NGN\",\n      \"total\": 50\n    }\n  ],\n  \"charges\": {\n    \"discount\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    },\n    \"tax\": {\n      \"amount\": \"7.5\",\n      \"type\": \"percentage\",\n      \"enabled\": true\n    },\n    \"fee\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    },\n    \"shipping\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    }\n  },\n  \"payment_schedule\": {\n    \"type\": \"one_time\",\n    \"due_date\": \"2026-02-15T23:59:59Z\",\n    \"send_date\": \"2026-01-30T00:00:00Z\",\n    \"payment_methods\": [\n      {\n        \"id\": \"bank_transfer\",\n        \"value\": \"058\"\n      }\n    ],\n    \"reminders\": true,\n    \"reminder_timing\": {\n      \"type\": \"before_due_date\",\n      \"days\": 3\n    }\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.platnova.com/v1/invoices")

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

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"email\": \"[email protected]\",\n  \"note\": \"Thank you for your business\",\n  \"items\": [\n    {\n      \"name\": \"Consulting\",\n      \"unit_price\": 150,\n      \"quantity\": 2,\n      \"currency\": \"NGN\",\n      \"total\": 300\n    },\n    {\n      \"name\": \"Setup fee\",\n      \"unit_price\": 50,\n      \"quantity\": 1,\n      \"currency\": \"NGN\",\n      \"total\": 50\n    }\n  ],\n  \"charges\": {\n    \"discount\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    },\n    \"tax\": {\n      \"amount\": \"7.5\",\n      \"type\": \"percentage\",\n      \"enabled\": true\n    },\n    \"fee\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    },\n    \"shipping\": {\n      \"amount\": \"0\",\n      \"type\": \"flat\",\n      \"enabled\": false\n    }\n  },\n  \"payment_schedule\": {\n    \"type\": \"one_time\",\n    \"due_date\": \"2026-02-15T23:59:59Z\",\n    \"send_date\": \"2026-01-30T00:00:00Z\",\n    \"payment_methods\": [\n      {\n        \"id\": \"bank_transfer\",\n        \"value\": \"058\"\n      }\n    ],\n    \"reminders\": true,\n    \"reminder_timing\": {\n      \"type\": \"before_due_date\",\n      \"days\": 3\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "status": true,
  "data": {
    "id": "<string>",
    "invoice_number": "<string>",
    "items": [
      {}
    ],
    "subtotal": "<string>",
    "total": "<string>",
    "charges": {},
    "note": "<string>",
    "payment_schedule": {},
    "created_at": "2023-11-07T05:31:56Z"
  },
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}
{
  "status": true,
  "data": {},
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}
{
  "error": {
    "email": [
      "This field is required"
    ],
    "items": [
      "This field is required"
    ],
    "payment_schedule": [
      "This field is required"
    ]
  }
}

​
Overview

Create an invoice for a customer. Invoices allow you to bill customers and track payments. This endpoint creates a new invoice that can be sent to customers for payment.

Authorizations

​
X-API-KEY
string
header
required

API key for authentication.

Body

application/json
​
email
string<email>
required

Email of the user (customer) in the entity to invoice

​
items
object[]
required
Minimum array length: 1
​
payment_schedule
object
required
​
charges
object
​
note
string

Response

Invoice created successfully

​
status
boolean
​
data
object
​
error
any[]
​
message
string