Invoiless Docs

# Invoices

# Create Invoice

# HTTP Request

POST https://api.invoiless.com/v1/invoices

Example 1:

{
  "customer": {
    "internalId": "INTERNAL_USER_ID",
    "billTo": {
      "company": "Invoiless"
    }
  },
  "items": [
    {
      "name": "Demo product",
      "quantity": 1,
      "price": 42
    }
  ]
}

Example 2:

{
  "customer": "CUSTOMER_ID",
  "items": [
    {
      "name": "Demo product",
      "quantity": 1,
      "price": 42
    }
  ]
}

# Header Parameters

Name Type Description Required
scope-id string Scope id No

# Body Parameters

Name Type Description Required
slug string Invoice slug No
header string Invoice header text No
number string Invoice number No
date date Invoice date No
dueDate date Invoice due date No
currency string ISO 4217 (opens new window) currency code e.g. USD, EUR etc No
lang string Invoice language, possible values are en, fr, de, nl, es, bg, ro, ja, or mn No, default is en
status string Invoice status, possible values are Draft, Pending, Unpaid, Partial, Paid, or Refunded No, default is Draft
customer string, object Customer id or customer details with your internal user id Yes
shipTo bool Show or hide the ship to address No, default is false
items array Invoice line items Yes
extraCharges object Invoice extra charges No
discount object Invoice discount No
extraFields array Invoice extra fields No
taxes array Invoice taxes No
taxIncluded bool Tax is included in prices No, default is false
terms string Invoice terms No
notes string Invoice notes No
tags array[string] Invoice tags No

# Customer Parameters

Name Type Description Required
id string Customer id Yes
Name Type Description Required
internalId string The internal id is used to identify an individual customer in your application Yes
billTo object Bill to address Yes
shipTo object Ship to address No

# Bill To / Ship To Parameters

Either firstName and lastName, or company, is required.

Name Type Description Required
firstName string First name No
lastName string Last name No
company string Company name No
email string Email No
phone string Phone No
address string Address No
legal string Legal info (e.g. Company number) No

# Items Parameters

Name Type Description Required
item string Item id that refers to a global item No
name string Item name Yes
url string Item url No
description string Item description No
quantity number Item quantity Yes
unit string Item unit No
price number Item unit price Yes
discount object Item discount No
taxes array Item taxes No

# Item Discount Parameters

Name Type Description Required
name string Discount name No
value number Discount value Yes

# Item Taxes Parameters

Name Type Description Required
name string Tax name Yes
value number Tax value Yes

# Extra Charges Parameters

Name Type Description Required
type string Extra charges type, possible values are Flat or Percentage No, default is Percentage
value number Extra charges value Yes

# Discount Parameters

Name Type Description Required
type string Discount type, possible values are Flat or Percentage No, default is Percentage
value number Discount value Yes

# Extra Fields Parameters

Name Type Description Required
name string Extra field name Yes
type string Extra field type, possible values are Flat or Percentage No, default is Percentage
value number Extra field value Yes

# Taxes Parameters

Name Type Description Required
name string Tax name No
type string Tax type, possible values are Flat or Percentage No, default is Percentage
value number Tax value Yes

# Response HTTP/1.1 201 Created

{
  "id": "invoice_id",
  "url": "https://invoiless.com/i/invoice_id"
}

# Response Body

Name Type Description
id string Invoice id
url string Invoice preview url

# Update Invoice

# HTTP Request

PUT https://api.invoiless.com/v1/invoices/:id

# Path Parameters

Name Type Description Required
id string Invoice id Yes

# Get Invoice

# HTTP Request

GET https://api.invoiless.com/v1/invoices/:id

# Path Parameters

Name Type Description Required
id string Invoice id Yes

# Get Invoices

# HTTP Request

GET https://api.invoiless.com/v1/invoices

# Query Parameters

Name Type Description Required
page number Page number No, default is 1
limit number Page limit No , default is 50
search number Search by invoice number, customer name, or tags No

# Send Invoice

# HTTP Request

POST https://api.invoiless.com/v1/invoices/:id/send

# Path Parameters

Name Type Description Required
id string Invoice id Yes

# Body Parameters

Name Type Description Required
email string Email address No
subject string Email subject No
body string Email body No
date date Schedule send No

# Delete Invoice

# HTTP Request

DELETE https://api.invoiless.com/v1/invoices/:id

# Path Parameters

Name Type Description Required
id string Invoice id Yes

← Customers →