Klyant: What Fields Do You Sync?
Introduction
In this article, we explore the data fields shared between Matters.Cloud and Klyant during integration. Understanding which fields are included is essential for ensuring seamless data synchronisation, accurate reporting, and a streamlined workflow.
By knowing which information is exchanged between these two platforms, you'll be better equipped to set up, troubleshoot, and optimise the integration for your firm's needs. This guide covers the key fields involved in the integration, offering clarity on how client, matter, invoice and financial data flows between Matters.Cloud and Klyant.
Data Fields: Clients
Clients are published from Matters.Cloud to Klyant both when they are first created and whenever updates are made.
Contact / Organisation | |||
| client.name | Contact & Organisation | first_name | |
| client.billing_email | Contact & Organisation | ||
| client.mobile_phone || business_phone | Contact & Organisation | mobile | |
| client.client_code | Contact & Organisation | reference | |
| client.last_name | Contact | last_name | |
| client.primary_address.address_1 | Contact & Organisation | address_1 | |
| client.primary_address.address_2 | Contact & Organisation | address_2 | |
| client.primary_address.locality | Contact & Organisation | city | |
| client.primary_address.region | Contact & Organisation | region | |
| client.primary_address.country | Contact & Organisation | country | |
| client.primary_address.postcode | Contact & Organisation | postcode | |
| client.party.business_phone | Contact & Organisation | telephone |
Data Fields: Matters
Matters are published from Matters.Cloud to Klyant when they are created and whenever updates are made.
matter.client_and_matter_code | matter_code |
| matter.client.klyant_id | client_id |
| matter.name | description |
| matter.open_date | date |
| matter.matter_type *It looks up the matter_type_id based on description. | matter_type_id |
Data Fields: Invoices
Invoices are published from Matters.Cloud to Klyant when they are either marked as sent, sent via email, or exported from the integrations page.
| invoice.invoice_number | invoice_number |
| invoice.matter.klyant_id | matter_id |
| invoice.invoice_type (note: where invoice_type = 'Invoice') | is_credit_note = false |
| invoice.invoice_date | invoice_date |
| invoice.get_invoice_number | invoice_description |
| invoice.amount | invoice_total |
| invoice.tax_amount | invoice_vat |
| invoice.subtotal_amount | invoice_net |
| invoice.invoice_date | date |
| invoice_item.item_type | nominal_code |
| invoice_item.description | line_detail |
| invoice_item.amount | line_net |
| item.tax_rate | line_vat_rate |
Data Fields: Credit Notes
Credit Notes are published from Matters.Cloud to Klyant when they are either marked as sent, sent via email, or exported from the integrations page.
| invoice.invoice_number | invoice_number |
| invoice.matter.klyant_id | matter_id |
| invoice.invoice_type (note: where invoice_type = 'Credit note') | is_credit_note = true |
| invoice.invoice_date | invoice_date |
| invoice.get_invoice_number | invoice_description |
| invoice.amount | invoice_total |
| invoice.tax_amount | invoice_vat |
| invoice.subtotal_amount | invoice_net |
| invoice.invoice_date | date |
| invoice_item.item_type | nominal_code |
| invoice_item.description | line_detail |
| invoice_item.amount | line_net |
| item.tax_rate | line_vat_rate |
Data Fields: Disbursements (Outlays)
Disbursements are published from Matters.Cloud to Klyant when they are posted or exported from the Integrations page.
| disbursement.reference | outlay_reference |
| disbursement.date | outlay_date |
| disbursement.narrative | outlay_description |
| disbursement.amount | outlay_total |
| "OUTLAY" | nominal_code |
| get_supplier_id(entity_id) | supplier_id |
| bank_account.klyant_bank_account_id | outlay_office_bank_id |
| disbursement.matter.klyant_id | line_items[].matter_id |
| disbursement.narrative | line_items[].line_detail |
| disbursement.amount | line_items[].line_net |
| disbursement.tax_rate | line_items[].line_vat_rate |
Data Fields: Client / Trust Transactions
Client / Trust Transactions are published from Matters.Cloud to Klyant when they are posted or exported from the Integrations page.
| trust_transaction.matter.klyant_id | matter_id |
| trust_transaction.description (or transaction_type if blank) | details |
| trust_transaction.reference (or transaction_type if blank) | reference |
| trust_transaction.debit (if > 0) or trust_transaction.credit | amount |
| trust_transaction.date | date |
| trust_transaction.transaction_type (Payment or Transfer from = 1, otherwise 0) | is_payment |
| trust_transaction.bank_account.klyant_bank_account_id | client_account_id |
Data Fields: Time Records
Time Records are published from Matters.Cloud to Klyant when the Export Time Records option is enabled in the integration settings.
| time_record.date | Date |
| time_record.hours | Duration |
| time_record.rate | Rate |
| time_record.user.email → matched against fee earner | fee_earner_id |
| time_record.narrative | Subject |
| time_record.billable_status | Non_Billable |
| time_record.klyant_id | Id |
Note: Optional: only use this option if creating bills directly within Klyant.