Create and send invoice

This endpoint creates an invoice, generates a PDF, and optionally emails it to the customer.

POST /invoice/create-send-invoice

cURL

curl -X POST https://qa-payments.mygigsters.com.au/api/v1/invoice/create-send-invoice \
  -u "YOUR_UUID:YOUR_SECRET" \
  -H "X-API-Version: 1.2" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Your Business Name",
  "logo": "https://app-qa-payments.mygigsters.com.au/assets/AppLogo1_black-BprEQ1v2.png",
  "address": "Your Business Address",
  "email": "[e-mail]",
  "reg_number": "33623510396",
  "bank": {
    "abn": "123456789",
    "bsb_number": "086568",
    "account_number": "77868647"
  },
  "customer": {
    "customer_name": "Jane Smith",
    "customer_email": "[e-mail]",
    "customer_address": "123, Melbourne, AU"
  },
  "invoice_number": "INV-0002",
  "reference": "Test reference",
  "reference_name": "Project Name",
  "date": "2025-11-26",
  "due_date": "2025-12-25",
  "gst_applicable": true,
  "gst": 10,
  "items": [
    {
      "description": "Product A",
      "quantity": 2,
      "unit_price": 5000
    },
    {
      "description": "Product B",
      "quantity": 3,
      "unit_price": 7500
    },
    {
      "description": "Product C",
      "quantity": 43,
      "unit_price": 1500
    }
  ],
  "type": "cost_of_sales",
  "notes": "Add notes here, if any",
  "send_email": false,
  "payment_link": true
}'

200

{
  "status": 200,
  "message": "Invoice created and sent successfully",
  "invoice_id": "d24152f8-7e53-4952-a0b2-e9895365bdea",
  "pdf_url": "https://qa-payments.mygigsters.com.au/api/v1/download-invoice?id=d24152f8-7e53-4952-a0b2-e9895365bdea",
  "payment_link": "https://pay-demo.airwallex.com/hkhixsm2kmf6"
}

​

Headers

X-API-Version · string · default: "1.2" · required

The API version to use. Supported versions are 1.1 and 1.2.

​

Request Body Parameters

name · string · required

Name of the business issuing the invoice.

logo · string

URL of the business logo image.

address · string · required

Address of the business.

email · string · required

Business email address.

reg_number · string · required

Registration number of the business (e.g., ABN for Australia, UEN for Singapore, or GST registration number).

bank · object · required

Bank details of the business. Object containing: bsb (string), and accountNumber (string).

customer · object · required

Customer details. Object containing: customerName (string), customerEmail (string), and customerAddress (string).

invoice_number · string · required

Unique identifier code for the invoice.

reference · string

Invoice reference code or brief memo.

reference_name · string

Name of the reference target (e.g. Project Name).

date · string · required

Date when the invoice is issued (Format: YYYY-MM-DD).

due_date · string · required

Due date for payment (Format: YYYY-MM-DD).

gst_applicable · boolean · required

Indicates whether Goods and Services Tax (GST) is applied to the items.

gst · number · required

GST percentage rate (e.g. 10 for 10% GST).

items · array · required

Array of invoice line items. Each element is an object containing: description (string), quantity (number), and unitPrice (number).

type · string

Type of invoice. Supported values: cost_of_sales or sales. Default is sales.

notes · string

Additional terms or notes shown on the PDF.

send_email · boolean · required

If set to true, the system automatically emails the invoice to the customer.

payment_link · boolean · required

If set to true, a payment link is automatically generated and embedded directly inside the invoice PDF.

​

Response Body

status · number

Indicates the status code of the response.

message · string

Confirmation message indicating the invoice was created successfully.

invoice_id · string

The unique ID of the created invoice (prefixed with inv_).

pdf_url · string

URL to download the generated invoice PDF file.

payment_link · string

URL to the generated checkout payment link (returned if paymentLink was true in the request).

​

Response Codes

Code	Description
200	Invoice created successfully and sent to the customer.
400	Bad Request. Invalid parameters or validation failure.
401	Unauthorized. Missing or invalid credentials.
409	Conflict. Duplicate idempotency key or invoice number already exists.
500	Internal Server Error.

cURL

curl -X POST https://qa-payments.mygigsters.com.au/api/v1/invoice/create-send-invoice \
  -u "YOUR_UUID:YOUR_SECRET" \
  -H "X-API-Version: 1.2" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Your Business Name",
  "logo": "https://app-qa-payments.mygigsters.com.au/assets/AppLogo1_black-BprEQ1v2.png",
  "address": "Your Business Address",
  "email": "[e-mail]",
  "reg_number": "33623510396",
  "bank": {
    "abn": "123456789",
    "bsb_number": "086568",
    "account_number": "77868647"
  },
  "customer": {
    "customer_name": "Jane Smith",
    "customer_email": "[e-mail]",
    "customer_address": "123, Melbourne, AU"
  },
  "invoice_number": "INV-0002",
  "reference": "Test reference",
  "reference_name": "Project Name",
  "date": "2025-11-26",
  "due_date": "2025-12-25",
  "gst_applicable": true,
  "gst": 10,
  "items": [
    {
      "description": "Product A",
      "quantity": 2,
      "unit_price": 5000
    },
    {
      "description": "Product B",
      "quantity": 3,
      "unit_price": 7500
    },
    {
      "description": "Product C",
      "quantity": 43,
      "unit_price": 1500
    }
  ],
  "type": "cost_of_sales",
  "notes": "Add notes here, if any",
  "send_email": false,
  "payment_link": true
}'

200

{
  "status": 200,
  "message": "Invoice created and sent successfully",
  "invoice_id": "d24152f8-7e53-4952-a0b2-e9895365bdea",
  "pdf_url": "https://qa-payments.mygigsters.com.au/api/v1/download-invoice?id=d24152f8-7e53-4952-a0b2-e9895365bdea",
  "payment_link": "https://pay-demo.airwallex.com/hkhixsm2kmf6"
}