Create an invoice / Overriding tax calculations on an invoice

POST 
/api/v3/invoice

Requirements

• You must specify an existing customer_id, customer_token, or customer_external_key value.
• You must specify at least one line item.
• Each line item must refer to an existing item_id value.

Notes

• The response/id value is the invoice_id value of the newly created invoice.
• The Location: header will provide a direct API link to the newly created invoice.
• Additionally, you can override the tax configurations in your account and specify a specific tax amount to charge when creating an invoice.

Request

application/json

Body

refnumber string

Invoice reference number

external_key string

External key value

customer_id integer

Customer ID #

date date

Invoice date

currency_id integer

Currency ID #

class_id integer

Class ID #

paycycle string

Payment cycle

Possible values: [evy, dly, 1wk, 2wk, 116, 4wk, 8wk, 30d, mon, 2mn, 12w, fst, lst, qtr, six, yrl, 2yr, 3yr, 4yr, 5yr, 10y, one]

terms_id integer

Terms ID #

admin_id integer

Admin/Worker ID number

bill_addr1 string

Billing address line 1

bill_addr2 string

Billing address line 2

bill_addr3 string

(Deprecated)

bill_city string

Billing address city

bill_state string

Billing address state

bill_postcode string

Billing address postal code

bill_country string

Billing address country

bill_notes string

(deprecated)

ship_addr1 string

Shipping address line 1

ship_addr2 string

Shipping address line 2

ship_addr3 string

(Deprecated)

ship_city string

Shipping address city

ship_state string

Shipping address state

ship_postcode string

Shipping address postal code

ship_country string

Shipping address country

ship_notes string

(deprecated)

no_dunning boolean

Is invoice exempt from dunning?

no_latefees boolean

Is invoice exempt from late fees?

no_procfees boolean

Is invoice exempt from processing fees?

memo string

Memo/notes to customer

custom_1 string

Custom field #1

custom_2 string

Custom field #2

custom_3 string

Custom field #3

custom_4 string

Custom field #4

custom_5 string

Custom field #5

custom_6 string

Custom field #6

custom_7 string

Custom field #7

custom_8 string

Custom field #8

custom_9 string

Custom field #9

custom_10 string

Custom field #10

custom_11 string

Custom field #11

custom_12 string

Custom field #12

custom_13 string

Custom field #13

custom_14 string

Custom field #14

custom_15 string

Custom field #15

custom_16 string

Custom field #16

custom_17 string

Custom field #17

custom_18 string

Custom field #18

custom_19 string

Custom field #19

custom_20 string

Custom field #20

line_items

object[]

A list of line items for the invoice

Array [

item_id integer

Item ID # for this line

paycycle string

Payment cycle

descrip string

Description

line_rate float

Rate

line_quantity float

Quantity

custom_1 string

Custom field #1

custom_2 string

Custom field #2

custom_3 string

Custom field #3

custom_4 string

Custom field #4

custom_5 string

Custom field #5

custom_6 string

Custom field #6

custom_7 string

Custom field #7

custom_8 string

Custom field #8

custom_9 string

Custom field #9

custom_10 string

Custom field #10

]

tags string[]

A list of tags

Responses

201

Object was created successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object

id integer

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": {
    "id": 0
  }
}

Example 1

{
  "code": 201,
  "status": "OK",
  "message": "",
  "details": {},
  "response": {
    "id": 1234
  }
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

Loading...