Create Invoice

POST

/api/Invoices

curl --request POST \
  --url https://example.com/api/Invoices \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "invoiceNumber": "example", "memberId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "clientName": "example", "clientDetail": "example", "clientEmail": "hello@example.com", "issueDate": "2026-04-15T12:00:00Z", "dueDate": "2026-04-15T12:00:00Z", "tax": 1, "currency": "example", "notes": "example", "lineItems": [ { "description": "example", "quantity": 1, "unitPrice": 1 } ] }'

Creates a new invoice in Draft status. Use the Send endpoint to issue it. Subtotal is computed from line items; Total is Subtotal + Tax.

Authorizations

• Bearer

Request Body

Invoice creation payload.

object

merchantId

required

string format: uuid

invoiceNumber

string

nullable <= 50 characters

memberId

string format: uuid

nullable

clientName

required

string

>= 1 characters <= 200 characters

clientDetail

string

nullable <= 200 characters

clientEmail

string format: email

nullable <= 256 characters

issueDate

required

string format: date-time

dueDate

string format: date-time

nullable

tax

number format: double

currency

string

nullable <= 3 characters

notes

string

nullable <= 2000 characters

lineItems

required

Array<object>

>= 1 items

object

description

required

string

>= 1 characters <= 500 characters

quantity

number format: double

unitPrice

number format: double

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "invoiceNumber": "example",
  "memberId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "clientName": "example",
  "clientDetail": "example",
  "clientEmail": "hello@example.com",
  "issueDate": "2026-04-15T12:00:00Z",
  "dueDate": "2026-04-15T12:00:00Z",
  "tax": 1,
  "currency": "example",
  "notes": "example",
  "lineItems": [
    {
      "description": "example",
      "quantity": 1,
      "unitPrice": 1
    }
  ]
}

object

merchantId

required

string format: uuid

invoiceNumber

string

nullable <= 50 characters

memberId

string format: uuid

nullable

clientName

required

string

>= 1 characters <= 200 characters

clientDetail

string

nullable <= 200 characters

clientEmail

string format: email

nullable <= 256 characters

issueDate

required

string format: date-time

dueDate

string format: date-time

nullable

tax

number format: double

currency

string

nullable <= 3 characters

notes

string

nullable <= 2000 characters

lineItems

required

Array<object>

>= 1 items

object

description

required

string

>= 1 characters <= 500 characters

quantity

number format: double

unitPrice

number format: double

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "invoiceNumber": "example",
  "memberId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "clientName": "example",
  "clientDetail": "example",
  "clientEmail": "hello@example.com",
  "issueDate": "2026-04-15T12:00:00Z",
  "dueDate": "2026-04-15T12:00:00Z",
  "tax": 1,
  "currency": "example",
  "notes": "example",
  "lineItems": [
    {
      "description": "example",
      "quantity": 1,
      "unitPrice": 1
    }
  ]
}

object

merchantId

required

string format: uuid

invoiceNumber

string

nullable <= 50 characters

memberId

string format: uuid

nullable

clientName

required

string

>= 1 characters <= 200 characters

clientDetail

string

nullable <= 200 characters

clientEmail

string format: email

nullable <= 256 characters

issueDate

required

string format: date-time

dueDate

string format: date-time

nullable

tax

number format: double

currency

string

nullable <= 3 characters

notes

string

nullable <= 2000 characters

lineItems

required

Array<object>

>= 1 items

object

description

required

string

>= 1 characters <= 500 characters

quantity

number format: double

unitPrice

number format: double

Example ^generated

{
  "merchantId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "invoiceNumber": "example",
  "memberId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "clientName": "example",
  "clientDetail": "example",
  "clientEmail": "hello@example.com",
  "issueDate": "2026-04-15T12:00:00Z",
  "dueDate": "2026-04-15T12:00:00Z",
  "tax": 1,
  "currency": "example",
  "notes": "example",
  "lineItems": [
    {
      "description": "example",
      "quantity": 1,
      "unitPrice": 1
    }
  ]
}

Responses

201

Invoice created successfully.

Media type application/json

object

id

string format: uuid

merchantId

string format: uuid

invoiceNumber

string

nullable

memberId

string format: uuid

nullable

clientName

string

nullable

clientDetail

string

nullable

clientEmail

string

nullable

status

string

Allowed values: Draft Sent Paid Overdue Void

issueDate

string format: date-time

dueDate

string format: date-time

nullable

sentAt

string format: date-time

nullable

paidAt

string format: date-time

nullable

subtotal

number format: double

tax

number format: double

total

number format: double

currency

string

nullable

notes

string

nullable

lineItems

Array<object>

nullable

object

id

string format: uuid

description

string

nullable

quantity

number format: double

unitPrice

number format: double

total

number format: double

sortOrder

integer format: int32

createdAt

string format: date-time

updatedAt

string format: date-time

Example

{
  "status": "Draft"
}

400

Validation failed — check the errors object.

Media type application/json

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}