Webhook Schema Documentation
Schemas
Invoice, Estimate Recurring Template Functions
InvoicesCreated
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique invoice ID
InvoiceType String (INV|EST|REC) Invoice type, e.g standard invoice, estimate or recurring template
FromRecurring Boolean Indicates whether the invoice was created from a recurring template
RecurringParentId Integer (32 bit) The parent ID of the invoice template if the invoice was created from a recurring template
InvoicesUpdated
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique invoice ID
InvoiceType String (INV|EST|REC) Invoice type, e.g standard invoice, estimate or recurring template
InvoicesDeleted
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique invoice ID
InvoicesViewed
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique invoice ID
InvoiceType String (INV|EST|REC) Invoice type, e.g standard invoice, estimate or recurring template
ClientId Integer (32 bit) Unique client ID
ClientContactId Integer (32 bit) Unique client contact ID. The contact record associated with the client that viewied the item
InvoicesPaid
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique invoice ID
PaymentId Integer (32 bit) Unique payment record ID
PaymentMethod String Invoice type, e.g standard invoice, estimate or recurring template.
  • PAYPAL = PayPal
  • SAGEPAY = SagePay
  • WORLDPAY = Worldpay
  • PAYSENSE = PaymentSense
  • BITPAY = Bitpay (Bitcoin)
  • STRIPE = Stripe
EstimatesStatusChange
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique estimate ID
Status String (ACCEPTED|DECLINED) Estimate status, accepted or declined.
ClientId Integer (32 bit) Unique client ID
ClientContactId Integer (32 bit) Unique client contact ID. The contact record associated with the client that accepted or declined the estimate
Client Functions
ClientsCreated
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique client ID
ClientsUpdated
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique client ID
ClientsDeleted
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique client ID
ClientContactsCreated
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique client contact ID
ClientId Integer (32 bit) Unique client ID
ClientContactsUpdated
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique client contact ID
ClientId Integer (32 bit) Unique client ID
ClientContactsDeleted
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
Id Integer (32 bit) Unique client contact ID
ClientId Integer (32 bit) Unique client ID
Sales Payment Functions
PaymentsCreated
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the event occured
InvoiceId Integer (32 bit) Unique invoice ID to which the payment has been bound
PaymentId Integer (32 bit) Unique payment ID
CurrencyCode String Currency ISO code, e.g. GBP, EUR, USD etc
AmountPaid Double Total amount of the payment in currency
Authentication
TimeStamp Date Time (yyyy-MM-ddThh:MM:ss)
e.g. 2015-03-26T22:03:18
Date and time the webhook was created
Signature String Unique webhook signature, refer to the authentication section for more details
HookId String Unique GUID for the webhook. We recommend you store this value in your database and do not process a webhook more than once.
Quick File Limited - Copyright © 2017
QuickFile Accounting | Community | Knowledgebase