Client_Create Schema
| Documentation | {..} JSON | XML |
| Mandatory field | Optional field |
Method for creating a new client.
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
ClientDetails
CompanyName
string
Maximum length: 100
AccountReference
Your own account identifier (Optional)
string
Maximum length: 30
AddressLine1
string
Maximum length: 75
AddressLine2
string
Maximum length: 75
AddressLine3
string
Maximum length: 75
Town
string
Maximum length: 75
CountryISO
string
Maximum length: 3
Postcode
string
Maximum length: 15
VatNumber
string
Maximum length: 20
VatExempt
boolean
GoCardlessMandateID
string
Optional GoCardless Direct Debit mandate ID
AllowAttachPDF
boolean
Set this to allow invoices/statements and estimates to be attached to emails in PDF format
Preferences
DefaultSendMethod
What default send method would you like to use for outbound invoices?
string
Enumerated value: EMAIL
Enumerated value: SNAILMAIL
DefaultCurrency
If not supply will revert to account default.
string
Maximum length: 3
DefaultTerm
int
If not supply will revert to account default.
PaymentRestrictions
A list of restricted payment processors for this client
PaymentRestriction
10string
Enumerated value: PAYPAL
Enumerated value: GOCARDLESS
Enumerated value: PAYMENTSENSE
Enumerated value: BITPAY
Enumerated value: STRIPE
Enumerated value: WORLDPAY
Enumerated value: SAGEPAY
TradingStyleId
int
The Trading Style ID where multiple trading styles are defined on the account. To locate the ID click to edit the trading style within the web application.
ClientContacts
DefaultContact
Client contact container
FirstName
string
Surname
string
Email
string
Password
string
Minimum length: 6
Maximum length: 20
TelephoneNumbers
Telephone
2string
AdditionalContacts
AdditionalContact
10 Client contact container
FirstName
string
Surname
string
Email
string
Password
string
Minimum length: 6
Maximum length: 20
TelephoneNumbers
Telephone
2string
Endpoint: https://api.quickfile.co.uk/1_2/client/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 Client Methods |
|---|
|
Create a new client record
|
|
Delete a client record
|
|
Retrieve client and contact data
|
|
Create a new contact record for an existing client
|
|
Retrieve a passwordless login URL for a client
|
|
Initiate a new Direct Debit collection request
|
|
Retrieve client records based on a set of search parameters
|
|
Update an existing client record
|