Skip to content

Commit

Permalink
Books addition + crm ids (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
dmick92 authored Oct 25, 2024
2 parents 2b2fdb1 + f3a8589 commit d4b047b
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 0 deletions.
1 change: 1 addition & 0 deletions pages/_meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"type": "separator",
"title": "Apps"
},
"books": "Books",
"catalyst": "Catalyst",
"commerce": "Commerce",
"creator": "Creator",
Expand Down
6 changes: 6 additions & 0 deletions pages/books/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"index": {
"display": "hidden"
},
"crmIds": "Fetch Records Using CRM IDs"
}
32 changes: 32 additions & 0 deletions pages/books/crmIds.md
Original file line number Diff line number Diff line change
@@ -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 |
16 changes: 16 additions & 0 deletions pages/books/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import {BooksIcon} from '../../components/zohoIcons'

import { Callout } from 'nextra/components'

import {DocumentCards} from '../../components/docList'

# <BooksIcon style={{marginBottom:'-8px'}} /> Books

<DocumentCards folder="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)
2 changes: 2 additions & 0 deletions pages/index.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { Cards, Card } from "nextra/components";
import {
BooksIcon,
CatalystIcon,
CrmIcon,
CommerceIcon,
Expand Down Expand Up @@ -27,6 +28,7 @@ Some scripts aren't app specific. Check out the Deluge section for generic Delug
### Apps

<Cards>
<Card icon={<BooksIcon />} title="Books" href="/books" />
<Card icon={<CatalystIcon />} title="Catalyst" href="/catalyst" />
<Card icon={<CommerceIcon />} title="Commerce" href="/commerce" />
<Card icon={<CreatorIcon />} title="Creator" href="/creator" />
Expand Down

0 comments on commit d4b047b

Please sign in to comment.