v1

latestSwagger 2.02026-07-1361110219.8 KB
Invoice

Create an invoice

post/api/invoice/new

Headers

x-auth-keystring required
x-auth-secretstring required

Request body

ClientIdinteger

The client to whom this invoice is assigned

ClonedFromIdinteger

Indicate from which invoice this invoice has been cloned from

RecurringProfileIdinteger

Hold the id of the recurring profile

Numberstring

Unique invoice number

IssuedOnstring date-time

Indicates when the invoice was issued

Duedatestring date-time

Indicates when the invoice will be proclamed as due

PoNumberstring

Unique number generated by the buyer

Termsstring

Terms of agreement

Notesstring

Internal note regarding the invoice

Status'Draft' | 'Paid' | 'Unpaid' | 'Overdue' | 'Void'

Indicate the status of the invoice (paid/unpaid/overdue)

CurrencyIdinteger

Id of the currency for the invoice amounts

InvoiceCategoryIdinteger

Hold the id of the invoice category

ShouldSendRemindersboolean

Should send email reminders to client?

Response

OK

Idinteger

Invoice id

ClonedFromIdinteger

Indicate from which invoice this invoice has been cloned from

RecurringProfileIdinteger

Hold the id of the recurring profile

Numberstring

Unique invoice number

IssuedOnstring date-time

Indicates when the invoice was issued

Duedatestring date-time

Indicates when the invoice will be proclamed as due

PoNumberstring

Unique number generated by the buyer

DiscountAmountnumber double

Amount that goes as a discount

TaxAmountnumber double

Amount that goes to the tax

SubTotalAmountnumber double

Total amount of the invoice without tax

TotalAmountnumber double

Total amount of the invoice with tax

Termsstring

Terms of agreement

Notesstring

Internal note regarding the invoice

Status'Draft' | 'Paid' | 'Unpaid' | 'Overdue' | 'Void'

Indicate the status of the invoice (paid/unpaid/overdue)

EnablePartialPaymentsboolean

Indicate that the invoice allows the user to pay the invoice partially

AccessTokenstring

Security access token used for accessing the invoice anonymously

InvoiceCategoryIdinteger

Hold the id of the invoice category

ShouldSendRemindersboolean

Should send email reminders to client?