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
    }
  }
}
'
{
  "status": true,
  "data": {
    "id": "<string>",
    "invoice_number": "<string>",
    "items": [
      {}
    ],
    "subtotal": "<string>",
    "total": "<string>",
    "charges": {},
    "note": "<string>",
    "status": "pending",
    "payment_schedule": {},
    "created_at": "2023-11-07T05:31:56Z"
  },
  "error": [
    "<unknown>"
  ],
  "message": "<string>"
}

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