Create invoice

POST

https://api.jokoor.com/v1/pay/invoices

Last modified:2025-11-15 15:49:01

Maintainer:Not configured

OperationId:createInvoice

Create a new invoice for a customer. You can create invoices as drafts or immediately finalize them.

Customer Identification:

Provide customer_id to link to an existing customer (customer data will be auto-filled)

Or provide customer_email and customer_name to create/find customer automatically

Invoice Items:

Link to products via product_id (description and price will be auto-filled)

Or provide custom description and unit_price for ad-hoc items

Tax Calculation:

Specify tax_rate as a percentage (0-100)

Tax amount is calculated automatically: tax_amount = amount * (tax_rate / 100)

total_amount = amount + tax_amount

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201Created

application/json

Invoice created

Body

🟠400Bad Request

🟠401Unauthorized

Request Example

Shell

JavaScript

Java

Swift

cURL

Invoice with existing customerInvoice with new customerCreate as draft

curl --location --request POST 'https://api.jokoor.com/v1/pay/invoices' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "customer_id": "cus_abc123",
    "currency": "GMD",
    "tax_rate": 15,
    "due_date": "2024-12-31T23:59:59Z",
    "notes": "Payment due within 30 days",
    "items": [
        {
            "product_id": "prod_xyz789",
            "quantity": 2
        },
        {
            "description": "Consulting services",
            "unit_price": "500.00",
            "quantity": 5
        }
    ]
}'

Response Example

201 - Example 1

{
    "data": {
        "id": "string",
        "invoice_number": "string",
        "customer_id": "string",
        "customer_email": "user@example.com",
        "customer_name": "string",
        "customer_address": "string",
        "customer_phone": "string",
        "amount": "1000.00",
        "tax_rate": 15,
        "tax_amount": "150.00",
        "total_amount": "1150.00",
        "paid_amount": "500.00",
        "remaining_amount": "650.00",
        "currency": "GMD",
        "status": "draft",
        "payment_status": "unpaid",
        "due_date": "2019-08-24T14:15:22Z",
        "issued_date": "2019-08-24T14:15:22Z",
        "paid_date": "2019-08-24T14:15:22Z",
        "sent_at": "2019-08-24T14:15:22Z",
        "sent_count": 0,
        "notes": "string",
        "items": [
            {
                "product_id": "string",
                "description": "string",
                "quantity": 0,
                "unit_price": "string",
                "total": "string"
            }
        ],
        "payment_url": "string",
        "pdf_url": "string",
        "receipts": [
            {
                "id": "string",
                "receipt_number": "string",
                "receipt_url": "string",
                "amount": "string",
                "payment_date": "2019-08-24T14:15:22Z",
                "status": "string"
            }
        ],
        "metadata": {},
        "subscription_id": "string",
        "mode": "test",
        "livemode": true,
        "version": 0,
        "organization": {
            "id": "string",
            "name": "string",
            "logo_url": "string"
        },
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z"
    }
}

Modified at 2025-11-15 15:49:01

Delete payment link

List invoices