From f3a8589541db48a25850e016ab8fa1afc112bb68 Mon Sep 17 00:00:00 2001 From: Doug Date: Thu, 24 Oct 2024 21:28:09 -0400 Subject: [PATCH] Books addition + crm ids --- pages/_meta.json | 1 + pages/books/_meta.json | 6 ++++++ pages/books/crmIds.md | 32 ++++++++++++++++++++++++++++++++ pages/books/index.mdx | 16 ++++++++++++++++ pages/index.mdx | 2 ++ 5 files changed, 57 insertions(+) create mode 100644 pages/books/_meta.json create mode 100644 pages/books/crmIds.md create mode 100644 pages/books/index.mdx diff --git a/pages/_meta.json b/pages/_meta.json index 1ebab7e..5f20eb4 100644 --- a/pages/_meta.json +++ b/pages/_meta.json @@ -11,6 +11,7 @@ "type": "separator", "title": "Apps" }, + "books": "Books", "catalyst": "Catalyst", "commerce": "Commerce", "creator": "Creator", diff --git a/pages/books/_meta.json b/pages/books/_meta.json new file mode 100644 index 0000000..e89670a --- /dev/null +++ b/pages/books/_meta.json @@ -0,0 +1,6 @@ +{ + "index": { + "display": "hidden" + }, + "crmIds": "Fetch Records Using CRM IDs" +} diff --git a/pages/books/crmIds.md b/pages/books/crmIds.md new file mode 100644 index 0000000..0606b95 --- /dev/null +++ b/pages/books/crmIds.md @@ -0,0 +1,32 @@ +--- +title: Fetch Records Using CRM IDs +description: Fetch a Books record using the CRM equivalents id. eg. Account == Customer, Contacts == Contact Person +--- + +# Fetch Records Using CRM IDs + +You can fetch Books records using the records CRM ID when using the Books to CRM integration. This allows you to fetch a Books contact record using the CRM account id, as well as other records. The Books API documentation only lists accounts, contacts, and vendors as module options but any integration module should work. + +## Prerequisites + +- Enable the Books to CRM integration. +- Create a Deluge script to access the data, or utilize it through the Books API. + +## Deluge Script + +```javascript +booksOrgId = "**************"; +contactId = "**************"; +connectionName = "**************"; + +customer = zoho.books.getRecords("Customers", booksOrgId, "zcrm_contact_id=" + contactId, connectionName); +``` + +## Known Id Options + +| Crm Module | Books Module | Field | +| ---------- | --------------- | --------------- | +| Accounts | Contacts | zcrm_account_id | +| Contacts | Contact Persons | zcrm_contact_id | +| Vendors | Contacts | zcrm_vendor_id | +| Products | Items | zcrm_product_id | diff --git a/pages/books/index.mdx b/pages/books/index.mdx new file mode 100644 index 0000000..84d7985 --- /dev/null +++ b/pages/books/index.mdx @@ -0,0 +1,16 @@ +import {BooksIcon} from '../../components/zohoIcons' + +import { Callout } from 'nextra/components' + +import {DocumentCards} from '../../components/docList' + +# Books + + + +## Quick Links + +- [API](https://www.zoho.com/books/api/v3) +- [Knowledge Base](https://www.zoho.com/ca/books/kb/general/) +- [Forums](https://help.zoho.com/portal/en/community/zoho-books) +- [Help Documentation](https://www.zoho.com/ca/books/help/getting-started/welcome.html) diff --git a/pages/index.mdx b/pages/index.mdx index 3795bea..5abfb4c 100644 --- a/pages/index.mdx +++ b/pages/index.mdx @@ -1,5 +1,6 @@ import { Cards, Card } from "nextra/components"; import { + BooksIcon, CatalystIcon, CrmIcon, CommerceIcon, @@ -27,6 +28,7 @@ Some scripts aren't app specific. Check out the Deluge section for generic Delug ### Apps + } title="Books" href="/books" /> } title="Catalyst" href="/catalyst" /> } title="Commerce" href="/commerce" /> } title="Creator" href="/creator" />