Skip to main content

Create a new invoice

POST 
/invoices

Create a new invoice for a customer with optional draft status

Request​

Body

required

Invoice details

    items object[]required
  • Array [
    • description stringrequired

    Possible values: >= 3 characters

    Description of the item

    qty integerrequired

    Possible values: >= 1

    Quantity of the item

    price numberrequired

    Price per unit

  • ]
    • due_date daterequired

    Due date for the invoice

    currency stringrequired

    Possible values: >= 3 characters, [NGN]

    Currency code for the invoice (only NGN is supported currently)

    customer objectrequired
    email emailrequired

    Customer's email address

    name stringrequired

    Possible values: >= 3 characters

    Customer's full name

    phone_number stringnullable

    Possible values: >= 3 characters

    Customer's phone number

    discount_type stringnullable

    Possible values: [percentage, fixed]

    Type of discount to apply

    discount_value numbernullable

    Value of the discount

    vat_percent numbernullable

    Possible values: <= 100

    VAT percentage to apply

    additional_info stringnullable

    Additional information to add to the invoice e.g payment details, additional instructions etc

    cc_emails email[]nullable

    Possible values: <= 10

    List of CC email addresses

    title stringnullable

    Possible values: >= 3 characters

    Title of the invoice

    save_as_draft booleannullable

    Whether to save the invoice as a draft

Responses​

Invoice created successfully

Schema
    message string
    data object
    subtotal number

    Subtotal amount before discounts and VAT

    total number

    Total amount after discounts and VAT

    discount number

    Discount amount applied

    vat number

    VAT amount

    vat_percent number

    VAT percentage applied

    reference string

    Unique reference for the invoice

    invoice_number string

    Invoice number

    created_at date-time

    Creation timestamp

    is_draft boolean

    Whether the invoice is saved as a draft

Loading...