Invoice_Create Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Create or Update an Invoice
Header
Document header container
MessageType
string
Enumerated value: Request
Enumerated value: Response
DeviceID
ID of the calling device where applicable. Use for mobile devices such as I-Phones and Android units
string
Minimum length: 0
Maximum length: 100
SubmissionNumber
string
A unique reference used for each API request. The Submission Number is seeded within the Authentication MD5 Value to prevent cloning.
Authentication
Account number, and an MD5 hash "Account number, API Key and Submission Number"
AccNumber
MD5Value
ApplicationID
Unique identiifier for the application making the request. Mandoatory from 10th Dec 2013
string
Minimum length: 1
Maximum length: 100
Body
InvoiceData
InvoiceID
integer
If InvoiceID is supplied an update will be applied to the existing invoice. If no InvoiceID is supplied a new invoice will be created.
InvoiceType
string
Enumerated value: INVOICE
Enumerated value: ESTIMATE
Enumerated value: RECURRING
ClientID
integer
Unique Client ID.
ClientContactName
string
Contact name to appear on the invoice. Omit node to apply default contact for the client.
ClientAddress
Supply a different client address to overide the default. Omit node to apply default address on file.
Address
string
Use br tags to denote carriage returns.
CountryISO
ISO 3166 Country Code
string
Maximum length: 2
Minimum length: 2
Currency
ISO 4217 Currency Code
string
Maximum length: 3
Discount
double
Optional discount percentage applied to invoice total.
TermDays
integer
Number of days permitted to pay the invoice.
Language
ISO 639-1 language code
string
Maximum length: 2
InvoiceDescription
A brief description of the invoice raised. If not supplied will assume the description of the first invoice item/task.
string
Maximum length: 35
Minimum length: 2
Terms
string
Additional invoice terms
Notes
string
Additional notes to appear on invoice.
VatCodes
Possible codes: exempt (VAT Exempt), oos (VAT Out of Scope), cisrc (CIS Reverse Charge), nisogs (EU supply of goods), niserv (EU supply of services).
Code
10string
Minimum length: 1
Maximum length: 30
ProjectTags
Provide up to 5 additional project tags
Tag
5string
Minimum length: 1
Maximum length: 30
InvoiceLines
ItemLines
Use for products and services priced using the quantity and unit cost model.
ItemLine
500 Invoice item line type.
ItemID
integer
Item ID from inventory. Enter zero to use a one-off item.
ItemName
Item Name (Short). Overides
string
Minimum length: 0
Maximum length: 20
ItemDescription
Item Description (Long). Overides
string
Maximum length: 1000
ItemNominalCode
Nominal Code
string
Maximum length: 5
Minimum length: 2
Tax1
Optional tax element to be levied on the item.
TaxName
Tax name, e.g. VAT
string
Maximum length: 7
Minimum length: 1
TaxPercentage
Tax percentage, e.g. 20.00
decimal
TaxAmount
Tax amount in currency
decimal
Tax2
Optional tax element to be levied on the item.
TaxName
Tax name, e.g. VAT
string
Minimum length: 1
Maximum length: 7
TaxPercentage
Tax percentage, e.g. 20.00
decimal
TaxAmount
Tax amount in currency
decimal
UnitCost
decimal
Qty
decimal
TaskLines
Use for itemising elements charged on an hourly rate at a fixed amount per hour.
TaskLine
500 Invoice task line type.
ItemID
integer
Item ID from inventory. Use zero for one-off item.
ItemName
Item Name (Short)
string
Maximum length: 20
Minimum length: 0
TaskDescription
Item Description (Long)
string
Maximum length: 1000
ItemNominalCode
Nominal Code
string
Maximum length: 5
Minimum length: 2
Tax1
Optional tax element to be levied on the item.
TaxName
Tax name, e.g. VAT
string
Maximum length: 7
Minimum length: 1
TaxPercentage
Tax percentage, e.g. 20.00
decimal
TaxAmount
Tax amount in currency
decimal
Tax2
Optional tax element to be levied on the item.
TaxName
Tax name, e.g. VAT
string
Minimum length: 1
Maximum length: 7
TaxPercentage
Tax percentage, e.g. 20.00
decimal
TaxAmount
double
Tax amount in currency
HourlyRate
double
Hours
double
Number of hours
Scheduling
SingleInvoiceData
Element for single invoice specific data.
InvoiceNumber
If invoice number is not supplied the system will auto-increment
string
Maximum length: 20
Minimum length: 1
PurchaseReference
string
Optional purchase reference number.
IssueDate
date
Date invoice was issued
RecurringInvoiceData
Element for specific recurring invoice data.
Interval
string
The preset interval between issuing invoices. 1WEEK equals weekly, 2WEEK equals fortnightly, 1MONTH equals monthly, etc...
Frequency
integer
How many intervals should the profile run for?
StartDate
date
When will the first invoice be issued?
ProRataDays
integer
Use to pro-rata the first payment for x number of days.
GoCardlessAutoBill
boolean
Set as true to use the pre-authorised Direct Debit details to automatically collect payment.
GoCardlessRequestAfter
Specify the number of days delay you would like to add before initiating a Direct Debit collection.
int
Maximum inclusive value: 60
SendByEmail
boolean
Send invoices by email when they are created from this recurring template.
SendByPost
boolean
Send invoices by post when they are created from this recurring template.
ActivateOnCreation
boolean
Activates the recurring profile on creation. By default this is set to false and the profile will remain in DRAFT status until it is activated in Quick File
CreditNote
Credit Note Meta data for negative invoices. See here for usage: https://community.quickfile.co.uk/t/creating-a-credit-note-using-the-api/23204
CreditNoteType
VOID, REFUND or HOLD
string
Enumerated value: VOID
Enumerated value: REFUND
Enumerated value: HOLD
ParentInvoiceId
int
The invoice ID you would like to set the credit note against
PaidFromAccount
For refunds enter the bank nominal (1200-1299) that the refund should be paid from.
int
Minimum inclusive value: 1200
Maximum inclusive value: 1299
Endpoint: https://api.quickfile.co.uk/1_2/invoice/create
Example Request:
We had a problem retrieving a JSON sample for this method, please retry later
Example Response:
Example Request:
We had a problem retrieving an XML sample for this method, please retry later
Example Response:
| Other Invoice Methods |
|---|
|
Create a new invoice, estimate or recurring invoice template
|
|
Delete an invoice, estimate or recurring invoice template
|
|
Retrieve a single invoice, estimate or recurring invoice template
|
|
Retrieve a URL to for an invoice or estimate PDF document
|
|
Search for invoices and estimates using a specific set of search parameters
|
|
Send an invoice or estimate by email or snail mail
|
|
Accepts or declines an estimate
|
|
Creates an invoice from a given estimate
|