Client_NewDirectDebitCollection Schema
Documentation {..} JSON XML
Mandatory field
Optional field
Single journal line
NominalCode
Nominal Code
string
Maximum length: 5
Minimum length: 2
ItemDescription
Item Description (Max 150 characters)
string
Maximum length: 150
ItemNotes
Item Name (Max 250 characters)
string
Maximum length: 230
Minimum length: 0
Amount
ItemDebitAmount
double
Amount in currency to debit
ItemCreditAmount
double
Amount in currency to credit
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
SupplierDetails
CompanyName
string
Maximum length: 100
CompanyNumber
string
Maximum length: 10
SupplierReference
Your own account identifier (Optional)
string
Maximum length: 15
AddressLine1
string
Maximum length: 75
AddressLine2
string
Maximum length: 75
AddressLine3
string
Maximum length: 75
Town
string
Maximum length: 75
CountryISO
string
Maximum length: 2
Postcode
string
Maximum length: 15
ContactFirstName
string
Maximum length: 50
ContactSurname
string
Maximum length: 50
ContactTel
string
Maximum length: 20
ContactEmail
string
Maximum length: 100
Website
string
Maximum length: 50
VatNumber
string
Maximum length: 20
VatExempt
boolean
Set to true if the supplier is based in another EC member state and VAT will be subject to the reverse charge.
Preferences
DefaultCurrency
string
If not supplied will revert to account default.
DefaultTerm
int
If not supplied will revert to account default.
DefaultVatRate
double
If not supplied will revert to the current UK standard rate
DefaultNominalCode
int
The default nominal code (5000-9997) that purchases made with this supplier should be defaulted to. If not supplied will assume 5000 - General Purchases
Returns a list of project tags based in a string search
Header
Creates upto 100 new untagged bank transactions
Header
Available for use whereby the client has a Direct Debit Pre-authorisation in place.
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
SearchParameters
ReturnCount
How many records would you like the API to return (MAX 200).
int
Minimum inclusive value: 1
Maximum inclusive value: 200
TagName
string
Search by partial tag name.
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
Transaction
100
BankNominalCode
Nominal code of the bank account your are inserting to (1200-1299).
integer
Minimum inclusive value: 1200
Maximum inclusive value: 1299
Date
date
Reference
string
Maximum length: 100
Minimum length: 2
Notes
Optional transaction notes
string
Maximum length: 240
Minimum length: 2
Amount
For "money out" transactions enter as a negative value.
double
Maximum inclusive value: 20000000.00
Minimum inclusive value: -20000000.00
DuplicateFilterOn
boolean
Set to true by default. Automatically skips where a item is found with a matching date, reference and amount.
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
CollectionType
Determines if the funds are allocated to and held on a client account or collected against a specific invoiceID.
AllocateToInvoice
ClientID
integer
InvoiceID
integer
Provide a valid InvoiceID associated to the supplied ClientID. The full balance will be collected from the invoice.
ChargeAtDate
date
If a valid date is provided, charge will be collected on that date. Otherwise, charge will be collected immediatly.
PartialAmount
decimal
A partial amount in GBP to be collected.
AllocateToClientAccount
ClientID
integer
Amount
decimal
Amount in GBP to be collected.
PaymentName
Provide a name for your payment.
ChargeAtDate
date
If a valid date is provided, charge will be collected on that date. Otherwise, charge will be collected immediatly.
Endpoint: https://api.quickfile.co.uk/1_2/client/newdirectdebitcollection
Example Request:
We had a problem retrieving a JSON sample for this method, please retry later
Example Response:
Try out this method in the API sandbox
Example Request:
We had a problem retrieving an XML sample for this method, please retry later
Example Response:
Try out this method in the API sandbox
Other Client Methods
Client_Create
Create a new client record
Client_Delete
Delete a client record
Client_Get
Retrieve client and contact data
Client_InsertContacts
Create a new contact record for an existing client
Client_LogIn
Retrieve a passwordless login URL for a client
Client_NewDirectDebitCollection
Initiate a new Direct Debit collection request
Client_Search
Retrieve client records based on a set of search parameters
Client_Update
Update an existing client record
View all Client methods
Back
Quick File Limited - Copyright © 2024
QuickFile Accounting | Community | Knowledgebase