Retainer Invoices | Zoho Books

<html> <head> <title>Retainer Invoices | Zoho Books | API Documentation</title> <meta name="description" content=""> <meta name="theme-color" content="#fff"> <meta charset="utf-8"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"> <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1"> <link href="/books/help/books-line-style.ico" rel="shortcut icon"> <link rel="preload" as="font" href="https://webfonts.zoho.com/css?family=Roboto+Mono:100,300,400,500,700/Inter:100,200,300,400,500,600,700,800,900"> <link href="/books/api/v3/styles/style.css" rel="stylesheet" media="screen"> <link href="/books/api/v3/styles/vendor.css" rel="stylesheet" media="screen"> <script type="text/javascript" src="/books/api/v3/js/darkmode.js"></script> <script type="text/javascript"> (function (p, o, s, t, m, a, n) { !p[s] && (p[s] = function () { (p[t] || (p[t] = [])).push(arguments); }); !o.getElementById(s + t) && o.getElementsByTagName("head")[0].appendChild(( (n = o.createElement("script")), (n.id = s + t), (n.async = 1), (n.src = m), n )); }(window, document, "_pm", "PostmanRunObject", "https://run.pstmn.io/button.js")); </script> </head> <body class="index"> <div class="top-wrapper"> <div class="top-band"> <span class='navbar-toggle' onclick="showresource('tocify-wrapper')"> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </span> <div class="innerwrapper"> <a href="https://books.zoho.com/home" target="_blank" class="brand-logo"> <img name="logo" src="/books/api/v3/images/books.svg" alt="Zoho Books" id="logo"> <span class="brand-name">Books</span> </a> <span class="title">API Docs</span> <div id="search-bar-wrapper"> <input id="search-bar" name="search" placeholder="Search Documentation" type="search" aria-label="Search" autocomplete="off"> <button style="background: url('/books/api/v3/images/close-rounded.svg') no-repeat scroll;" id="close-search-icon"></button> <div id="search-shortcut-icon">/</div> <div id="search-result"></div> <div id="search-result-empty">No Results Found</div> </div> <button onclick="showaction()" class="search-close close-icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 342.4 342.4" class="icon"><path d="M193.8 171.2 320.3 45.1c6.3-6.2 6.3-16.4 0-22.6-6.2-6.3-16.4-6.3-22.6 0L171.2 148.6 45.1 22.1c-6.2-6.3-16.4-6.3-22.6 0-6.3 6.2-6.3 16.4 0 22.6l126.1 126.5L22.1 297.3c-6.3 6.2-6.3 16.4 0 22.6 3.1 3.1 7.2 4.7 11.3 4.7 4.1 0 8.2-1.6 11.3-4.7l126.5-126.1 126.1 126.5c3.1 3.1 7.2 4.7 11.3 4.7 4.1 0 8.2-1.6 11.3-4.7 6.3-6.2 6.3-16.4 0-22.6L193.8 171.2z"/></svg> </button> <button class="navbar-links" type="button" data-target="#navbarLinks" aria-controls="navbarLinks" aria-expanded="false" aria-label="Toggle Top navigation" onclick="toggleNavbar(this)"> API Docs </button> <div class="navbar-top"> <div class="theme-toggle-label" id="dark-mode-toggle"> <div class="toggle-icon sun"><svg fill=currentColor xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve"><circle transform="rotate(-45.001 255.998 256.004)" cx="256" cy="256" r="128.5"/><path d="M486.4 231h-30.1c-13.8 0-25 11.2-25 25s11.2 25 25 25h30.1c13.8 0 25-11.2 25-25s-11.2-25-25-25zM80.7 256c0-13.8-11.2-25-25-25H25.6c-13.8 0-25 11.2-25 25s11.2 25 25 25h30.1c13.8 0 25-11.2 25-25zM415.3 379.9c-9.8-9.8-25.6-9.8-35.4 0-9.8 9.8-9.8 25.6 0 35.4l21.3 21.3c4.9 4.9 11.3 7.3 17.7 7.3 6.4 0 12.8-2.4 17.7-7.3 9.8-9.8 9.8-25.6 0-35.4l-21.3-21.3zM96.7 132.1c4.9 4.9 11.3 7.3 17.7 7.3s12.8-2.4 17.7-7.3c9.8-9.8 9.8-25.6 0-35.4l-21.3-21.3c-9.8-9.8-25.6-9.8-35.4 0-9.8 9.8-9.8 25.6 0 35.4l21.3 21.3zM397.6 139.4c6.4 0 12.8-2.4 17.7-7.3l21.3-21.3c9.8-9.8 9.8-25.6 0-35.4-9.8-9.8-25.6-9.8-35.4 0l-21.3 21.3c-9.8 9.8-9.8 25.6 0 35.4 4.9 4.9 11.3 7.3 17.7 7.3zM96.7 379.9l-21.3 21.3c-9.8 9.8-9.8 25.6 0 35.4 4.9 4.9 11.3 7.3 17.7 7.3s12.8-2.4 17.7-7.3l21.3-21.3c9.8-9.8 9.8-25.6 0-35.4-9.8-9.7-25.6-9.7-35.4 0zM256 80.7c13.8 0 25-11.2 25-25V25.6c0-13.8-11.2-25-25-25s-25 11.2-25 25v30.1c0 13.8 11.2 25 25 25zM256 431.3c-13.8 0-25 11.2-25 25v30.1c0 13.8 11.2 25 25 25s25-11.2 25-25v-30.1c0-13.8-11.2-25-25-25z"/></svg> </div> <div class="toggle-icon moon"><svg fill=currentColor xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve"><path d="M232.8 108.6c0-37.8 8.3-73.6 23.1-105.9C121.4 8.8 14.1 119.8 14.1 255.9c0 140 113.5 253.4 253.4 253.4 102.2 0 190.2-60.5 230.3-147.6-3.9.2-7.8.3-11.7.3-139.9 0-253.3-113.5-253.3-253.4z"/></svg> </div> </div> <div class="list-item"> <button type="button" class="dropdown-toggle" data-target="#navbarDropdown" aria-controls="navbarDropdown" aria-expanded="false" aria-haspopup="true" onclick="toggleNavbar(this)"> Resources </button> <div class="dropdown-menus"> <div class="dropdown-item"> <a href="/books/kb/general/?source=apidoc" target="_blank" rel="noopener noreferrer">FAQ</a> </div> <div class="dropdown-item"> <a href="/books/help/getting-started/welcome.html?source=apidoc" target="_blank" rel="noopener noreferrer">Help Docs</a> </div> <div class="dropdown-divider"></div> <div class="dropdown-item"> <a href="/books/support/?source=apidoc" target="_blank" rel="noopener noreferrer">All Resources</a> </div> </div> </div> <div class="nav-separator"></div> <div class="access-btn"> <a role="button" href="https://books.zoho.com/home" target="_blank" class="topbar-btn access" style="display:none;">Access Zoho Books</a> <a role="button" href="/books/login" target="_blank" class="topbar-btn signin">Sign In</a> </div> </div> </div> </div> </div> <div id="mobile-search"> <button class="btn p-0 ml-auto search-trigger ze-toggler" type="button" data-target="#searchForm" aria-controls="searchForm" aria-expanded="false" aria-label="Open Help Search" onclick="showaction()"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" data-ember-extension="1" class="icon"><path d="M469.5 470.9l-116.6-139c67.6-66.7 73.8-175.6 11.7-249.6-65.3-78-181.8-88.2-259.7-22.9C67.2 91.1 44 135.5 39.7 184.6c-4.3 49.1 10.7 96.9 42.4 134.6 31.6 37.7 76.1 60.9 125.1 65.2 5.5.5 11 .7 16.4.7 38.2 0 75.1-11.8 106.3-33.9l116.6 139.1c3 3.5 7.2 5.4 11.5 5.4 3.4 0 6.8-1.2 9.6-3.5 6.4-5.5 7.3-14.9 1.9-21.3zm-364.4-171C78.6 268.3 66 228.3 69.6 187.2s23-78.3 54.6-104.8c28.9-24.2 64.1-36 99.1-36 44.1 0 87.9 18.8 118.4 55.1 54.7 65.2 46.1 162.8-19.1 217.5-31.6 26.5-71.6 39.1-112.7 35.5-41.1-3.6-78.3-23-104.8-54.6z" fill="#9392a1"></path></svg> </button> </div> <div class="fixed-band">Retainer Invoices</div> <div class="main-wrapper"> <div class="main-outer-wrapper"> <div class="tocify-wrapper"> <div> <button type="button" class="btn close-icon" data-target="#sidebarMenu" aria-controls="sidebarMenu" aria-expanded="true" aria-label="Close Sidebar Menu" onclick="showresource('tocify-wrapper')"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 342.4 342.4" class="icon"><path d="M193.8 171.2 320.3 45.1c6.3-6.2 6.3-16.4 0-22.6-6.2-6.3-16.4-6.3-22.6 0L171.2 148.6 45.1 22.1c-6.2-6.3-16.4-6.3-22.6 0-6.3 6.2-6.3 16.4 0 22.6l126.1 126.5L22.1 297.3c-6.3 6.2-6.3 16.4 0 22.6 3.1 3.1 7.2 4.7 11.3 4.7 4.1 0 8.2-1.6 11.3-4.7l126.5-126.1 126.1 126.5c3.1 3.1 7.2 4.7 11.3 4.7 4.1 0 8.2-1.6 11.3-4.7 6.3-6.2 6.3-16.4 0-22.6L193.8 171.2z"/></svg> </button> <ul> <li class="nested-menu" id='introduction-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Introduction</a> <ul class='panel -acc-wrapper'> <li class='item overview' id='overview-item'> <a href="/books/api/v3/introduction/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item organization-id' id='organization-id-item'> <a href="/books/api/v3/introduction/#organization-id" onclick="toggleAccordionMenu(this)">Organization ID</a> </li> <li class='item multidc' id='multidc-item'> <a href="/books/api/v3/introduction/#multidc" onclick="toggleAccordionMenu(this)">Multiple Data Centers</a> </li> <li class='item api-call-limit' id='api-call-limit-item'> <a href="/books/api/v3/introduction/#api-call-limit" onclick="toggleAccordionMenu(this)">API Call Limit</a> </li> </ul> </li> <li class="nested-menu" id='oauth-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >OAuth</a> <ul class='panel -acc-wrapper'> <li class='item overview' id='overview-item'> <a href="/books/api/v3/oauth/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> </ul> </li> <li class="nested-menu" id='http-methods-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >HTTP Methods</a> <ul class='panel -acc-wrapper'> <li class='item overview' id='overview-item'> <a href="/books/api/v3/http-methods/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> </ul> </li> <li class="nested-menu" id='response-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Response</a> <ul class='panel -acc-wrapper'> <li class='item overview' id='overview-item'> <a href="/books/api/v3/response/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> </ul> </li> <li class="nested-menu" id='errors-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Errors</a> <ul class='panel -acc-wrapper'> <li class='item overview' id='overview-item'> <a href="/books/api/v3/errors/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> </ul> </li> <li class="nested-menu" id='pagination-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Pagination</a> <ul class='panel -acc-wrapper'> <li class='item overview' id='overview-item'> <a href="/books/api/v3/pagination/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> </ul> </li> <li class="nested-menu" id='contacts-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Contacts</a> <ul class='panel -acc-wrapper'> <li class='item contacts-overview' id='contacts-overview-item'> <a href="/books/api/v3/contacts/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-contact' id='create-a-contact-item'> <a href="/books/api/v3/contacts/#create-a-contact" onclick="toggleAccordionMenu(this)">Create a Contact</a> </li> <li class='item update-a-contact-using-a-custom-fields-unique-value' id='update-a-contact-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/contacts/#update-a-contact-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a contact using a custom field's unique value</a> </li> <li class='item list-contacts' id='list-contacts-item'> <a href="/books/api/v3/contacts/#list-contacts" onclick="toggleAccordionMenu(this)">List Contacts</a> </li> <li class='item update-a-contact' id='update-a-contact-item'> <a href="/books/api/v3/contacts/#update-a-contact" onclick="toggleAccordionMenu(this)">Update a Contact</a> </li> <li class='item get-contact' id='get-contact-item'> <a href="/books/api/v3/contacts/#get-contact" onclick="toggleAccordionMenu(this)">Get Contact</a> </li> <li class='item delete-a-contact' id='delete-a-contact-item'> <a href="/books/api/v3/contacts/#delete-a-contact" onclick="toggleAccordionMenu(this)">Delete a Contact</a> </li> <li class='item mark-as-active' id='mark-as-active-item'> <a href="/books/api/v3/contacts/#mark-as-active" onclick="toggleAccordionMenu(this)">Mark as Active</a> </li> <li class='item mark-as-inactive' id='mark-as-inactive-item'> <a href="/books/api/v3/contacts/#mark-as-inactive" onclick="toggleAccordionMenu(this)">Mark as Inactive</a> </li> <li class='item enable-portal-access' id='enable-portal-access-item'> <a href="/books/api/v3/contacts/#enable-portal-access" onclick="toggleAccordionMenu(this)">Enable Portal Access</a> </li> <li class='item enable-payment-reminders' id='enable-payment-reminders-item'> <a href="/books/api/v3/contacts/#enable-payment-reminders" onclick="toggleAccordionMenu(this)">Enable Payment Reminders</a> </li> <li class='item disable-payment-reminders' id='disable-payment-reminders-item'> <a href="/books/api/v3/contacts/#disable-payment-reminders" onclick="toggleAccordionMenu(this)">Disable Payment Reminders</a> </li> <li class='item email-statement' id='email-statement-item'> <a href="/books/api/v3/contacts/#email-statement" onclick="toggleAccordionMenu(this)">Email Statement</a> </li> <li class='item get-statement-mail-content' id='get-statement-mail-content-item'> <a href="/books/api/v3/contacts/#get-statement-mail-content" onclick="toggleAccordionMenu(this)">Get Statement Mail Content</a> </li> <li class='item email-contact' id='email-contact-item'> <a href="/books/api/v3/contacts/#email-contact" onclick="toggleAccordionMenu(this)">Email Contact</a> </li> <li class='item list-comments' id='list-comments-item'> <a href="/books/api/v3/contacts/#list-comments" onclick="toggleAccordionMenu(this)">List Comments</a> </li> <li class='item add-additional-address' id='add-additional-address-item'> <a href="/books/api/v3/contacts/#add-additional-address" onclick="toggleAccordionMenu(this)">Add Additional Address</a> </li> <li class='item get-contact-addresses' id='get-contact-addresses-item'> <a href="/books/api/v3/contacts/#get-contact-addresses" onclick="toggleAccordionMenu(this)">Get Contact Addresses</a> </li> <li class='item edit-additional-address' id='edit-additional-address-item'> <a href="/books/api/v3/contacts/#edit-additional-address" onclick="toggleAccordionMenu(this)">Edit Additional Address</a> </li> <li class='item delete-additional-address' id='delete-additional-address-item'> <a href="/books/api/v3/contacts/#delete-additional-address" onclick="toggleAccordionMenu(this)">Delete Additional Address</a> </li> <li class='item list-refunds' id='list-refunds-item'> <a href="/books/api/v3/contacts/#list-refunds" onclick="toggleAccordionMenu(this)">List Refunds</a> </li> <li class='item track-1099' id='track-1099-item'> <a href="/books/api/v3/contacts/#track-1099" onclick="toggleAccordionMenu(this)">Track 1099</a> </li> <li class='item untrack-1099' id='untrack-1099-item'> <a href="/books/api/v3/contacts/#untrack-1099" onclick="toggleAccordionMenu(this)">Untrack 1099</a> </li> </ul> </li> <li class="nested-menu" id='contact-persons-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Contact Persons</a> <ul class='panel -acc-wrapper'> <li class='item contact-persons-overview' id='contact-persons-overview-item'> <a href="/books/api/v3/contact-persons/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-contact-person' id='create-a-contact-person-item'> <a href="/books/api/v3/contact-persons/#create-a-contact-person" onclick="toggleAccordionMenu(this)">Create a contact person</a> </li> <li class='item update-a-contact-person' id='update-a-contact-person-item'> <a href="/books/api/v3/contact-persons/#update-a-contact-person" onclick="toggleAccordionMenu(this)">Update a contact person</a> </li> <li class='item delete-a-contact-person' id='delete-a-contact-person-item'> <a href="/books/api/v3/contact-persons/#delete-a-contact-person" onclick="toggleAccordionMenu(this)">Delete a contact person</a> </li> <li class='item list-contact-persons' id='list-contact-persons-item'> <a href="/books/api/v3/contact-persons/#list-contact-persons" onclick="toggleAccordionMenu(this)">List contact persons</a> </li> <li class='item get-a-contact-person' id='get-a-contact-person-item'> <a href="/books/api/v3/contact-persons/#get-a-contact-person" onclick="toggleAccordionMenu(this)">Get a contact person</a> </li> <li class='item mark-as-primary-contact-person' id='mark-as-primary-contact-person-item'> <a href="/books/api/v3/contact-persons/#mark-as-primary-contact-person" onclick="toggleAccordionMenu(this)">Mark as primary contact person</a> </li> </ul> </li> <li class="nested-menu" id='estimates-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Estimates</a> <ul class='panel -acc-wrapper'> <li class='item estimates-overview' id='estimates-overview-item'> <a href="/books/api/v3/estimates/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-an-estimate' id='create-an-estimate-item'> <a href="/books/api/v3/estimates/#create-an-estimate" onclick="toggleAccordionMenu(this)">Create an Estimate</a> </li> <li class='item update-an-estimate-using-a-custom-fields-unique-value' id='update-an-estimate-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/estimates/#update-an-estimate-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">update an Estimate using a custom field's unique value</a> </li> <li class='item list-estimates' id='list-estimates-item'> <a href="/books/api/v3/estimates/#list-estimates" onclick="toggleAccordionMenu(this)">List estimates</a> </li> <li class='item update-an-estimate' id='update-an-estimate-item'> <a href="/books/api/v3/estimates/#update-an-estimate" onclick="toggleAccordionMenu(this)">Update an Estimate</a> </li> <li class='item get-an-estimate' id='get-an-estimate-item'> <a href="/books/api/v3/estimates/#get-an-estimate" onclick="toggleAccordionMenu(this)">Get an estimate</a> </li> <li class='item delete-an-estimate' id='delete-an-estimate-item'> <a href="/books/api/v3/estimates/#delete-an-estimate" onclick="toggleAccordionMenu(this)">Delete an Estimate</a> </li> <li class='item update-custom-field-in-existing-estimates' id='update-custom-field-in-existing-estimates-item'> <a href="/books/api/v3/estimates/#update-custom-field-in-existing-estimates" onclick="toggleAccordionMenu(this)">Update custom field in existing estimates</a> </li> <li class='item mark-an-estimate-as-sent' id='mark-an-estimate-as-sent-item'> <a href="/books/api/v3/estimates/#mark-an-estimate-as-sent" onclick="toggleAccordionMenu(this)">Mark an estimate as sent</a> </li> <li class='item mark-an-estimate-as-accepted' id='mark-an-estimate-as-accepted-item'> <a href="/books/api/v3/estimates/#mark-an-estimate-as-accepted" onclick="toggleAccordionMenu(this)">Mark an estimate as accepted</a> </li> <li class='item mark-an-estimate-as-declined' id='mark-an-estimate-as-declined-item'> <a href="/books/api/v3/estimates/#mark-an-estimate-as-declined" onclick="toggleAccordionMenu(this)">Mark an estimate as declined</a> </li> <li class='item submit-an-estimate-for-approval' id='submit-an-estimate-for-approval-item'> <a href="/books/api/v3/estimates/#submit-an-estimate-for-approval" onclick="toggleAccordionMenu(this)">Submit an estimate for approval</a> </li> <li class='item approve-an-estimate' id='approve-an-estimate-item'> <a href="/books/api/v3/estimates/#approve-an-estimate" onclick="toggleAccordionMenu(this)">Approve an estimate.</a> </li> <li class='item email-an-estimate' id='email-an-estimate-item'> <a href="/books/api/v3/estimates/#email-an-estimate" onclick="toggleAccordionMenu(this)">Email an estimate</a> </li> <li class='item get-estimate-email-content' id='get-estimate-email-content-item'> <a href="/books/api/v3/estimates/#get-estimate-email-content" onclick="toggleAccordionMenu(this)">Get estimate email content</a> </li> <li class='item email-multiple-estimates' id='email-multiple-estimates-item'> <a href="/books/api/v3/estimates/#email-multiple-estimates" onclick="toggleAccordionMenu(this)">Email multiple estimates</a> </li> <li class='item bulk-export-estimates' id='bulk-export-estimates-item'> <a href="/books/api/v3/estimates/#bulk-export-estimates" onclick="toggleAccordionMenu(this)">Bulk export estimates</a> </li> <li class='item bulk-print-estimates' id='bulk-print-estimates-item'> <a href="/books/api/v3/estimates/#bulk-print-estimates" onclick="toggleAccordionMenu(this)">Bulk print estimates</a> </li> <li class='item update-billing-address' id='update-billing-address-item'> <a href="/books/api/v3/estimates/#update-billing-address" onclick="toggleAccordionMenu(this)">Update billing address</a> </li> <li class='item update-shipping-address' id='update-shipping-address-item'> <a href="/books/api/v3/estimates/#update-shipping-address" onclick="toggleAccordionMenu(this)">Update shipping address</a> </li> <li class='item list-estimate-template' id='list-estimate-template-item'> <a href="/books/api/v3/estimates/#list-estimate-template" onclick="toggleAccordionMenu(this)">List estimate template</a> </li> <li class='item update-estimate-template' id='update-estimate-template-item'> <a href="/books/api/v3/estimates/#update-estimate-template" onclick="toggleAccordionMenu(this)">Update estimate template</a> </li> <li class='item add-comments' id='add-comments-item'> <a href="/books/api/v3/estimates/#add-comments" onclick="toggleAccordionMenu(this)">Add Comments</a> </li> <li class='item list-estimate-comments-and-history' id='list-estimate-comments-and-history-item'> <a href="/books/api/v3/estimates/#list-estimate-comments-and-history" onclick="toggleAccordionMenu(this)">List estimate comments & history</a> </li> <li class='item update-comment' id='update-comment-item'> <a href="/books/api/v3/estimates/#update-comment" onclick="toggleAccordionMenu(this)">Update comment</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/estimates/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> </ul> </li> <li class="nested-menu" id='sales-order-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Sales Order</a> <ul class='panel -acc-wrapper'> <li class='item sales-order-overview' id='sales-order-overview-item'> <a href="/books/api/v3/sales-order/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-sales-order' id='create-a-sales-order-item'> <a href="/books/api/v3/sales-order/#create-a-sales-order" onclick="toggleAccordionMenu(this)">Create a sales order</a> </li> <li class='item update-a-sales-order-using-a-custom-fields-unique-value' id='update-a-sales-order-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/sales-order/#update-a-sales-order-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a sales order using a custom field's unique value</a> </li> <li class='item list-sales-orders' id='list-sales-orders-item'> <a href="/books/api/v3/sales-order/#list-sales-orders" onclick="toggleAccordionMenu(this)">List sales orders</a> </li> <li class='item update-a-sales-order' id='update-a-sales-order-item'> <a href="/books/api/v3/sales-order/#update-a-sales-order" onclick="toggleAccordionMenu(this)">Update a sales order</a> </li> <li class='item get-a-sales-order' id='get-a-sales-order-item'> <a href="/books/api/v3/sales-order/#get-a-sales-order" onclick="toggleAccordionMenu(this)">Get a sales order</a> </li> <li class='item delete-a-sales-order' id='delete-a-sales-order-item'> <a href="/books/api/v3/sales-order/#delete-a-sales-order" onclick="toggleAccordionMenu(this)">Delete a sales order</a> </li> <li class='item update-custom-field-in-existing-salesorders' id='update-custom-field-in-existing-salesorders-item'> <a href="/books/api/v3/sales-order/#update-custom-field-in-existing-salesorders" onclick="toggleAccordionMenu(this)">Update custom field in existing salesorders</a> </li> <li class='item mark-a-sales-order-as-open' id='mark-a-sales-order-as-open-item'> <a href="/books/api/v3/sales-order/#mark-a-sales-order-as-open" onclick="toggleAccordionMenu(this)">Mark a sales order as open</a> </li> <li class='item mark-a-sales-order-as-void' id='mark-a-sales-order-as-void-item'> <a href="/books/api/v3/sales-order/#mark-a-sales-order-as-void" onclick="toggleAccordionMenu(this)">Mark a sales order as void</a> </li> <li class='item update-a-sales-order-sub-status' id='update-a-sales-order-sub-status-item'> <a href="/books/api/v3/sales-order/#update-a-sales-order-sub-status" onclick="toggleAccordionMenu(this)">Update a sales order sub status</a> </li> <li class='item email-a-sales-order' id='email-a-sales-order-item'> <a href="/books/api/v3/sales-order/#email-a-sales-order" onclick="toggleAccordionMenu(this)">Email a sales order</a> </li> <li class='item get-sales-order-email-content' id='get-sales-order-email-content-item'> <a href="/books/api/v3/sales-order/#get-sales-order-email-content" onclick="toggleAccordionMenu(this)">Get sales order email content</a> </li> <li class='item submit-a-sales-order-for-approval' id='submit-a-sales-order-for-approval-item'> <a href="/books/api/v3/sales-order/#submit-a-sales-order-for-approval" onclick="toggleAccordionMenu(this)">Submit a sales order for approval</a> </li> <li class='item approve-a-sales-order' id='approve-a-sales-order-item'> <a href="/books/api/v3/sales-order/#approve-a-sales-order" onclick="toggleAccordionMenu(this)">Approve a sales order.</a> </li> <li class='item bulk-export-sales-orders' id='bulk-export-sales-orders-item'> <a href="/books/api/v3/sales-order/#bulk-export-sales-orders" onclick="toggleAccordionMenu(this)">Bulk export sales orders</a> </li> <li class='item bulk-print-sales-orders' id='bulk-print-sales-orders-item'> <a href="/books/api/v3/sales-order/#bulk-print-sales-orders" onclick="toggleAccordionMenu(this)">Bulk print sales orders</a> </li> <li class='item update-billing-address' id='update-billing-address-item'> <a href="/books/api/v3/sales-order/#update-billing-address" onclick="toggleAccordionMenu(this)">Update billing address</a> </li> <li class='item update-shipping-address' id='update-shipping-address-item'> <a href="/books/api/v3/sales-order/#update-shipping-address" onclick="toggleAccordionMenu(this)">Update shipping address</a> </li> <li class='item list-sales-order-templates' id='list-sales-order-templates-item'> <a href="/books/api/v3/sales-order/#list-sales-order-templates" onclick="toggleAccordionMenu(this)">List sales order templates</a> </li> <li class='item update-sales-order-template' id='update-sales-order-template-item'> <a href="/books/api/v3/sales-order/#update-sales-order-template" onclick="toggleAccordionMenu(this)">Update sales order template</a> </li> <li class='item add-attachment-to-a-sales-order' id='add-attachment-to-a-sales-order-item'> <a href="/books/api/v3/sales-order/#add-attachment-to-a-sales-order" onclick="toggleAccordionMenu(this)">Add attachment to a sales order</a> </li> <li class='item update-attachment-preference' id='update-attachment-preference-item'> <a href="/books/api/v3/sales-order/#update-attachment-preference" onclick="toggleAccordionMenu(this)">Update attachment preference</a> </li> <li class='item get-a-sales-order-attachment' id='get-a-sales-order-attachment-item'> <a href="/books/api/v3/sales-order/#get-a-sales-order-attachment" onclick="toggleAccordionMenu(this)">Get a sales order attachment</a> </li> <li class='item delete-an-attachment' id='delete-an-attachment-item'> <a href="/books/api/v3/sales-order/#delete-an-attachment" onclick="toggleAccordionMenu(this)">Delete an attachment</a> </li> <li class='item add-comment' id='add-comment-item'> <a href="/books/api/v3/sales-order/#add-comment" onclick="toggleAccordionMenu(this)">Add comment</a> </li> <li class='item list-sales-order-comments-and-history' id='list-sales-order-comments-and-history-item'> <a href="/books/api/v3/sales-order/#list-sales-order-comments-and-history" onclick="toggleAccordionMenu(this)">List sales order comments & history</a> </li> <li class='item update-comment' id='update-comment-item'> <a href="/books/api/v3/sales-order/#update-comment" onclick="toggleAccordionMenu(this)">Update comment</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/sales-order/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> </ul> </li> <li class="nested-menu" id='invoices-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Invoices</a> <ul class='panel -acc-wrapper'> <li class='item invoices-overview' id='invoices-overview-item'> <a href="/books/api/v3/invoices/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-an-invoice' id='create-an-invoice-item'> <a href="/books/api/v3/invoices/#create-an-invoice" onclick="toggleAccordionMenu(this)">Create an invoice</a> </li> <li class='item update-an-invoice-using-a-custom-fields-unique-value' id='update-an-invoice-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/invoices/#update-an-invoice-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update an invoice using a custom field's unique value</a> </li> <li class='item list-invoices' id='list-invoices-item'> <a href="/books/api/v3/invoices/#list-invoices" onclick="toggleAccordionMenu(this)">List invoices</a> </li> <li class='item update-an-invoice' id='update-an-invoice-item'> <a href="/books/api/v3/invoices/#update-an-invoice" onclick="toggleAccordionMenu(this)">Update an invoice</a> </li> <li class='item get-an-invoice' id='get-an-invoice-item'> <a href="/books/api/v3/invoices/#get-an-invoice" onclick="toggleAccordionMenu(this)">Get an invoice</a> </li> <li class='item delete-an-invoice' id='delete-an-invoice-item'> <a href="/books/api/v3/invoices/#delete-an-invoice" onclick="toggleAccordionMenu(this)">Delete an invoice</a> </li> <li class='item mark-an-invoice-as-sent' id='mark-an-invoice-as-sent-item'> <a href="/books/api/v3/invoices/#mark-an-invoice-as-sent" onclick="toggleAccordionMenu(this)">Mark an invoice as sent</a> </li> <li class='item void-an-invoice' id='void-an-invoice-item'> <a href="/books/api/v3/invoices/#void-an-invoice" onclick="toggleAccordionMenu(this)">Void an invoice</a> </li> <li class='item mark-as-draft' id='mark-as-draft-item'> <a href="/books/api/v3/invoices/#mark-as-draft" onclick="toggleAccordionMenu(this)">Mark as draft</a> </li> <li class='item email-invoices' id='email-invoices-item'> <a href="/books/api/v3/invoices/#email-invoices" onclick="toggleAccordionMenu(this)">Email invoices</a> </li> <li class='item create-an-instant-invoice' id='create-an-instant-invoice-item'> <a href="/books/api/v3/invoices/#create-an-instant-invoice" onclick="toggleAccordionMenu(this)">Create an instant invoice</a> </li> <li class='item submit-an-invoice-for-approval' id='submit-an-invoice-for-approval-item'> <a href="/books/api/v3/invoices/#submit-an-invoice-for-approval" onclick="toggleAccordionMenu(this)">Submit an invoice for approval</a> </li> <li class='item approve-an-invoice' id='approve-an-invoice-item'> <a href="/books/api/v3/invoices/#approve-an-invoice" onclick="toggleAccordionMenu(this)">Approve an invoice.</a> </li> <li class='item email-an-invoice' id='email-an-invoice-item'> <a href="/books/api/v3/invoices/#email-an-invoice" onclick="toggleAccordionMenu(this)">Email an invoice</a> </li> <li class='item get-invoice-email-content' id='get-invoice-email-content-item'> <a href="/books/api/v3/invoices/#get-invoice-email-content" onclick="toggleAccordionMenu(this)">Get invoice email content</a> </li> <li class='item remind-customer' id='remind-customer-item'> <a href="/books/api/v3/invoices/#remind-customer" onclick="toggleAccordionMenu(this)">Remind Customer</a> </li> <li class='item get-payment-reminder-mail-content' id='get-payment-reminder-mail-content-item'> <a href="/books/api/v3/invoices/#get-payment-reminder-mail-content" onclick="toggleAccordionMenu(this)">Get payment reminder mail content</a> </li> <li class='item bulk-invoice-reminder' id='bulk-invoice-reminder-item'> <a href="/books/api/v3/invoices/#bulk-invoice-reminder" onclick="toggleAccordionMenu(this)">Bulk invoice reminder</a> </li> <li class='item bulk-export-invoices' id='bulk-export-invoices-item'> <a href="/books/api/v3/invoices/#bulk-export-invoices" onclick="toggleAccordionMenu(this)">Bulk export Invoices</a> </li> <li class='item bulk-print-invoices' id='bulk-print-invoices-item'> <a href="/books/api/v3/invoices/#bulk-print-invoices" onclick="toggleAccordionMenu(this)">Bulk print invoices</a> </li> <li class='item disable-payment-reminder' id='disable-payment-reminder-item'> <a href="/books/api/v3/invoices/#disable-payment-reminder" onclick="toggleAccordionMenu(this)">Disable payment reminder</a> </li> <li class='item enable-payment-reminder' id='enable-payment-reminder-item'> <a href="/books/api/v3/invoices/#enable-payment-reminder" onclick="toggleAccordionMenu(this)">Enable payment reminder</a> </li> <li class='item write-off-invoice' id='write-off-invoice-item'> <a href="/books/api/v3/invoices/#write-off-invoice" onclick="toggleAccordionMenu(this)">Write off invoice</a> </li> <li class='item cancel-write-off' id='cancel-write-off-item'> <a href="/books/api/v3/invoices/#cancel-write-off" onclick="toggleAccordionMenu(this)">Cancel write off</a> </li> <li class='item update-billing-address' id='update-billing-address-item'> <a href="/books/api/v3/invoices/#update-billing-address" onclick="toggleAccordionMenu(this)">Update billing address</a> </li> <li class='item update-shipping-address' id='update-shipping-address-item'> <a href="/books/api/v3/invoices/#update-shipping-address" onclick="toggleAccordionMenu(this)">Update shipping address</a> </li> <li class='item list-invoice-templates' id='list-invoice-templates-item'> <a href="/books/api/v3/invoices/#list-invoice-templates" onclick="toggleAccordionMenu(this)">List invoice templates</a> </li> <li class='item update-invoice-template' id='update-invoice-template-item'> <a href="/books/api/v3/invoices/#update-invoice-template" onclick="toggleAccordionMenu(this)">Update invoice template</a> </li> <li class='item list-invoice-payments' id='list-invoice-payments-item'> <a href="/books/api/v3/invoices/#list-invoice-payments" onclick="toggleAccordionMenu(this)">List invoice payments</a> </li> <li class='item list-credits-applied' id='list-credits-applied-item'> <a href="/books/api/v3/invoices/#list-credits-applied" onclick="toggleAccordionMenu(this)">List credits applied</a> </li> <li class='item apply-credits' id='apply-credits-item'> <a href="/books/api/v3/invoices/#apply-credits" onclick="toggleAccordionMenu(this)">Apply credits</a> </li> <li class='item delete-a-payment' id='delete-a-payment-item'> <a href="/books/api/v3/invoices/#delete-a-payment" onclick="toggleAccordionMenu(this)">Delete a payment</a> </li> <li class='item delete-applied-credit' id='delete-applied-credit-item'> <a href="/books/api/v3/invoices/#delete-applied-credit" onclick="toggleAccordionMenu(this)">Delete applied credit</a> </li> <li class='item add-attachment-to-an-invoice' id='add-attachment-to-an-invoice-item'> <a href="/books/api/v3/invoices/#add-attachment-to-an-invoice" onclick="toggleAccordionMenu(this)">Add attachment to an invoice</a> </li> <li class='item update-attachment-preference' id='update-attachment-preference-item'> <a href="/books/api/v3/invoices/#update-attachment-preference" onclick="toggleAccordionMenu(this)">Update attachment preference</a> </li> <li class='item get-an-invoice-attachment' id='get-an-invoice-attachment-item'> <a href="/books/api/v3/invoices/#get-an-invoice-attachment" onclick="toggleAccordionMenu(this)">Get an invoice attachment</a> </li> <li class='item delete-an-attachment' id='delete-an-attachment-item'> <a href="/books/api/v3/invoices/#delete-an-attachment" onclick="toggleAccordionMenu(this)">Delete an attachment</a> </li> <li class='item delete-the-expense-receipt' id='delete-the-expense-receipt-item'> <a href="/books/api/v3/invoices/#delete-the-expense-receipt" onclick="toggleAccordionMenu(this)">Delete the expense receipt</a> </li> <li class='item update-custom-field-in-existing-invoices' id='update-custom-field-in-existing-invoices-item'> <a href="/books/api/v3/invoices/#update-custom-field-in-existing-invoices" onclick="toggleAccordionMenu(this)">Update custom field in existing invoices</a> </li> <li class='item add-comment' id='add-comment-item'> <a href="/books/api/v3/invoices/#add-comment" onclick="toggleAccordionMenu(this)">Add comment</a> </li> <li class='item list-invoice-comments-and-history' id='list-invoice-comments-and-history-item'> <a href="/books/api/v3/invoices/#list-invoice-comments-and-history" onclick="toggleAccordionMenu(this)">List invoice comments & history</a> </li> <li class='item update-comment' id='update-comment-item'> <a href="/books/api/v3/invoices/#update-comment" onclick="toggleAccordionMenu(this)">Update comment</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/invoices/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> <li class='item generate-payment-link' id='generate-payment-link-item'> <a href="/books/api/v3/invoices/#generate-payment-link" onclick="toggleAccordionMenu(this)">Generate payment link</a> </li> </ul> </li> <li class="nested-menu" id='recurring-invoices-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Recurring Invoices</a> <ul class='panel -acc-wrapper'> <li class='item recurring-invoices-overview' id='recurring-invoices-overview-item'> <a href="/books/api/v3/recurring-invoices/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-recurring-invoice' id='create-a-recurring-invoice-item'> <a href="/books/api/v3/recurring-invoices/#create-a-recurring-invoice" onclick="toggleAccordionMenu(this)">Create a Recurring Invoice</a> </li> <li class='item update-a-recurring-invoice-using-a-custom-fields-unique-value' id='update-a-recurring-invoice-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/recurring-invoices/#update-a-recurring-invoice-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a recurring invoice using a custom field's unique value</a> </li> <li class='item list-all-recurring-invoice' id='list-all-recurring-invoice-item'> <a href="/books/api/v3/recurring-invoices/#list-all-recurring-invoice" onclick="toggleAccordionMenu(this)">List all Recurring Invoice</a> </li> <li class='item update-recurring-invoice' id='update-recurring-invoice-item'> <a href="/books/api/v3/recurring-invoices/#update-recurring-invoice" onclick="toggleAccordionMenu(this)">Update Recurring Invoice</a> </li> <li class='item get-a-recurring-invoice' id='get-a-recurring-invoice-item'> <a href="/books/api/v3/recurring-invoices/#get-a-recurring-invoice" onclick="toggleAccordionMenu(this)">Get a Recurring Invoice</a> </li> <li class='item delete-a-recurring-invoice' id='delete-a-recurring-invoice-item'> <a href="/books/api/v3/recurring-invoices/#delete-a-recurring-invoice" onclick="toggleAccordionMenu(this)">Delete a Recurring Invoice</a> </li> <li class='item stop-a-recurring-invoice' id='stop-a-recurring-invoice-item'> <a href="/books/api/v3/recurring-invoices/#stop-a-recurring-invoice" onclick="toggleAccordionMenu(this)">Stop a Recurring Invoice</a> </li> <li class='item resume-a-recurring-invoice' id='resume-a-recurring-invoice-item'> <a href="/books/api/v3/recurring-invoices/#resume-a-recurring-invoice" onclick="toggleAccordionMenu(this)">Resume a Recurring Invoice</a> </li> <li class='item update-recurring-invoice-template' id='update-recurring-invoice-template-item'> <a href="/books/api/v3/recurring-invoices/#update-recurring-invoice-template" onclick="toggleAccordionMenu(this)">Update Recurring Invoice template</a> </li> <li class='item list-recurring-invoice-history' id='list-recurring-invoice-history-item'> <a href="/books/api/v3/recurring-invoices/#list-recurring-invoice-history" onclick="toggleAccordionMenu(this)">List Recurring Invoice History</a> </li> </ul> </li> <li class="nested-menu" id='credit-notes-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Credit Notes</a> <ul class='panel -acc-wrapper'> <li class='item credit-notes-overview' id='credit-notes-overview-item'> <a href="/books/api/v3/credit-notes/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-credit-note' id='create-a-credit-note-item'> <a href="/books/api/v3/credit-notes/#create-a-credit-note" onclick="toggleAccordionMenu(this)">Create a credit note</a> </li> <li class='item update-a-credit-note-using-a-custom-fields-unique-value' id='update-a-credit-note-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/credit-notes/#update-a-credit-note-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a credit note using a custom field's unique value</a> </li> <li class='item list-all-credit-notes' id='list-all-credit-notes-item'> <a href="/books/api/v3/credit-notes/#list-all-credit-notes" onclick="toggleAccordionMenu(this)">List all Credit Notes</a> </li> <li class='item update-a-credit-note' id='update-a-credit-note-item'> <a href="/books/api/v3/credit-notes/#update-a-credit-note" onclick="toggleAccordionMenu(this)">Update a credit note</a> </li> <li class='item get-a-credit-note' id='get-a-credit-note-item'> <a href="/books/api/v3/credit-notes/#get-a-credit-note" onclick="toggleAccordionMenu(this)">Get a credit note</a> </li> <li class='item delete-a-credit-note' id='delete-a-credit-note-item'> <a href="/books/api/v3/credit-notes/#delete-a-credit-note" onclick="toggleAccordionMenu(this)">Delete a credit note</a> </li> <li class='item email-a-credit-note' id='email-a-credit-note-item'> <a href="/books/api/v3/credit-notes/#email-a-credit-note" onclick="toggleAccordionMenu(this)">Email a credit note</a> </li> <li class='item get-email-content' id='get-email-content-item'> <a href="/books/api/v3/credit-notes/#get-email-content" onclick="toggleAccordionMenu(this)">Get email content</a> </li> <li class='item void-a-credit-note' id='void-a-credit-note-item'> <a href="/books/api/v3/credit-notes/#void-a-credit-note" onclick="toggleAccordionMenu(this)">Void a Credit Note</a> </li> <li class='item convert-credit-note-to-draft' id='convert-credit-note-to-draft-item'> <a href="/books/api/v3/credit-notes/#convert-credit-note-to-draft" onclick="toggleAccordionMenu(this)">Convert Credit Note to Draft.</a> </li> <li class='item convert-to-open' id='convert-to-open-item'> <a href="/books/api/v3/credit-notes/#convert-to-open" onclick="toggleAccordionMenu(this)">Convert to Open</a> </li> <li class='item submit-a-credit-note-for-approval' id='submit-a-credit-note-for-approval-item'> <a href="/books/api/v3/credit-notes/#submit-a-credit-note-for-approval" onclick="toggleAccordionMenu(this)">Submit a credit note for approval</a> </li> <li class='item approve-a-credit-note' id='approve-a-credit-note-item'> <a href="/books/api/v3/credit-notes/#approve-a-credit-note" onclick="toggleAccordionMenu(this)">Approve a credit note.</a> </li> <li class='item email-history' id='email-history-item'> <a href="/books/api/v3/credit-notes/#email-history" onclick="toggleAccordionMenu(this)">Email history</a> </li> <li class='item update-billing-address' id='update-billing-address-item'> <a href="/books/api/v3/credit-notes/#update-billing-address" onclick="toggleAccordionMenu(this)">Update billing address</a> </li> <li class='item update-shipping-address' id='update-shipping-address-item'> <a href="/books/api/v3/credit-notes/#update-shipping-address" onclick="toggleAccordionMenu(this)">Update Shipping address</a> </li> <li class='item list-credit-note-template' id='list-credit-note-template-item'> <a href="/books/api/v3/credit-notes/#list-credit-note-template" onclick="toggleAccordionMenu(this)">List credit note template</a> </li> <li class='item update-a-credit-note-template' id='update-a-credit-note-template-item'> <a href="/books/api/v3/credit-notes/#update-a-credit-note-template" onclick="toggleAccordionMenu(this)">Update a credit note template</a> </li> <li class='item credit-to-an-invoice' id='credit-to-an-invoice-item'> <a href="/books/api/v3/credit-notes/#credit-to-an-invoice" onclick="toggleAccordionMenu(this)">Credit to an invoice</a> </li> <li class='item list-invoices-credited' id='list-invoices-credited-item'> <a href="/books/api/v3/credit-notes/#list-invoices-credited" onclick="toggleAccordionMenu(this)">List invoices credited</a> </li> <li class='item delete-invoices-credited' id='delete-invoices-credited-item'> <a href="/books/api/v3/credit-notes/#delete-invoices-credited" onclick="toggleAccordionMenu(this)">Delete invoices credited</a> </li> <li class='item add-a-comment' id='add-a-comment-item'> <a href="/books/api/v3/credit-notes/#add-a-comment" onclick="toggleAccordionMenu(this)">Add a comment</a> </li> <li class='item list-credit-note-comments-and-history' id='list-credit-note-comments-and-history-item'> <a href="/books/api/v3/credit-notes/#list-credit-note-comments-and-history" onclick="toggleAccordionMenu(this)">List credit note comments & history</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/credit-notes/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a Comment</a> </li> <li class='item list-credit-note-refunds' id='list-credit-note-refunds-item'> <a href="/books/api/v3/credit-notes/#list-credit-note-refunds" onclick="toggleAccordionMenu(this)">List credit note refunds</a> </li> <li class='item refund-credit-note' id='refund-credit-note-item'> <a href="/books/api/v3/credit-notes/#refund-credit-note" onclick="toggleAccordionMenu(this)">Refund credit note</a> </li> <li class='item list-refunds-of-a-credit-note' id='list-refunds-of-a-credit-note-item'> <a href="/books/api/v3/credit-notes/#list-refunds-of-a-credit-note" onclick="toggleAccordionMenu(this)">List refunds of a credit note</a> </li> <li class='item update-credit-note-refund' id='update-credit-note-refund-item'> <a href="/books/api/v3/credit-notes/#update-credit-note-refund" onclick="toggleAccordionMenu(this)">Update credit note refund</a> </li> <li class='item get-credit-note-refund' id='get-credit-note-refund-item'> <a href="/books/api/v3/credit-notes/#get-credit-note-refund" onclick="toggleAccordionMenu(this)">Get credit note refund</a> </li> <li class='item delete-credit-note-refund' id='delete-credit-note-refund-item'> <a href="/books/api/v3/credit-notes/#delete-credit-note-refund" onclick="toggleAccordionMenu(this)">Delete credit note refund</a> </li> </ul> </li> <li class="nested-menu" id='customer-payments-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Customer Payments</a> <ul class='panel -acc-wrapper'> <li class='item customer-payments-overview' id='customer-payments-overview-item'> <a href="/books/api/v3/customer-payments/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-payment' id='create-a-payment-item'> <a href="/books/api/v3/customer-payments/#create-a-payment" onclick="toggleAccordionMenu(this)">Create a payment</a> </li> <li class='item update-a-payment-using-a-custom-fields-unique-value' id='update-a-payment-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/customer-payments/#update-a-payment-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a payment using a custom field's unique value</a> </li> <li class='item list-customer-payments' id='list-customer-payments-item'> <a href="/books/api/v3/customer-payments/#list-customer-payments" onclick="toggleAccordionMenu(this)">List Customer Payments</a> </li> <li class='item update-a-payment' id='update-a-payment-item'> <a href="/books/api/v3/customer-payments/#update-a-payment" onclick="toggleAccordionMenu(this)">Update a payment</a> </li> <li class='item retrieve-a-payment' id='retrieve-a-payment-item'> <a href="/books/api/v3/customer-payments/#retrieve-a-payment" onclick="toggleAccordionMenu(this)">Retrieve a payment</a> </li> <li class='item delete-a-payment' id='delete-a-payment-item'> <a href="/books/api/v3/customer-payments/#delete-a-payment" onclick="toggleAccordionMenu(this)">Delete a payment</a> </li> <li class='item refund-an-excess-customer-payment' id='refund-an-excess-customer-payment-item'> <a href="/books/api/v3/customer-payments/#refund-an-excess-customer-payment" onclick="toggleAccordionMenu(this)">Refund an excess customer payment</a> </li> <li class='item list-refunds-of-a-customer-payment' id='list-refunds-of-a-customer-payment-item'> <a href="/books/api/v3/customer-payments/#list-refunds-of-a-customer-payment" onclick="toggleAccordionMenu(this)">List refunds of a customer payment</a> </li> <li class='item update-custom-field-in-existing-customerpayments' id='update-custom-field-in-existing-customerpayments-item'> <a href="/books/api/v3/customer-payments/#update-custom-field-in-existing-customerpayments" onclick="toggleAccordionMenu(this)">Update custom field in existing customerpayments</a> </li> <li class='item update-a-refund' id='update-a-refund-item'> <a href="/books/api/v3/customer-payments/#update-a-refund" onclick="toggleAccordionMenu(this)">Update a refund</a> </li> <li class='item details-of-a-refund' id='details-of-a-refund-item'> <a href="/books/api/v3/customer-payments/#details-of-a-refund" onclick="toggleAccordionMenu(this)">Details of a refund</a> </li> <li class='item delete-a-refund' id='delete-a-refund-item'> <a href="/books/api/v3/customer-payments/#delete-a-refund" onclick="toggleAccordionMenu(this)">Delete a Refund</a> </li> </ul> </li> <li class="nested-menu" id='expenses-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Expenses</a> <ul class='panel -acc-wrapper'> <li class='item expenses-overview' id='expenses-overview-item'> <a href="/books/api/v3/expenses/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-an-expense' id='create-an-expense-item'> <a href="/books/api/v3/expenses/#create-an-expense" onclick="toggleAccordionMenu(this)">Create an Expense</a> </li> <li class='item update-an-expense-using-a-custom-fields-unique-value' id='update-an-expense-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/expenses/#update-an-expense-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update an expense using a custom field's unique value</a> </li> <li class='item list-expenses' id='list-expenses-item'> <a href="/books/api/v3/expenses/#list-expenses" onclick="toggleAccordionMenu(this)">List Expenses</a> </li> <li class='item update-an-expense' id='update-an-expense-item'> <a href="/books/api/v3/expenses/#update-an-expense" onclick="toggleAccordionMenu(this)">Update an Expense</a> </li> <li class='item get-an-expense' id='get-an-expense-item'> <a href="/books/api/v3/expenses/#get-an-expense" onclick="toggleAccordionMenu(this)">Get an Expense</a> </li> <li class='item delete-an-expense' id='delete-an-expense-item'> <a href="/books/api/v3/expenses/#delete-an-expense" onclick="toggleAccordionMenu(this)">Delete an Expense</a> </li> <li class='item list-expense-history-and-comments' id='list-expense-history-and-comments-item'> <a href="/books/api/v3/expenses/#list-expense-history-and-comments" onclick="toggleAccordionMenu(this)">List expense History & Comments</a> </li> <li class='item create-an-employee' id='create-an-employee-item'> <a href="/books/api/v3/expenses/#create-an-employee" onclick="toggleAccordionMenu(this)">Create an employee</a> </li> <li class='item list-employees' id='list-employees-item'> <a href="/books/api/v3/expenses/#list-employees" onclick="toggleAccordionMenu(this)">List employees</a> </li> <li class='item get-an-employee' id='get-an-employee-item'> <a href="/books/api/v3/expenses/#get-an-employee" onclick="toggleAccordionMenu(this)">Get an employee</a> </li> <li class='item delete-an-employee' id='delete-an-employee-item'> <a href="/books/api/v3/expenses/#delete-an-employee" onclick="toggleAccordionMenu(this)">Delete an employee</a> </li> <li class='item add-receipt-to-an-expense' id='add-receipt-to-an-expense-item'> <a href="/books/api/v3/expenses/#add-receipt-to-an-expense" onclick="toggleAccordionMenu(this)">Add receipt to an expense.</a> </li> <li class='item get-an-expense-receipt' id='get-an-expense-receipt-item'> <a href="/books/api/v3/expenses/#get-an-expense-receipt" onclick="toggleAccordionMenu(this)">Get an expense receipt</a> </li> <li class='item delete-a-receipt' id='delete-a-receipt-item'> <a href="/books/api/v3/expenses/#delete-a-receipt" onclick="toggleAccordionMenu(this)">Delete a receipt</a> </li> </ul> </li> <li class="nested-menu" id='recurring-expenses-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Recurring Expenses</a> <ul class='panel -acc-wrapper'> <li class='item recurring-expenses-overview' id='recurring-expenses-overview-item'> <a href="/books/api/v3/recurring-expenses/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-recurring-expense' id='create-a-recurring-expense-item'> <a href="/books/api/v3/recurring-expenses/#create-a-recurring-expense" onclick="toggleAccordionMenu(this)">Create a recurring expense</a> </li> <li class='item update-an-recurring-expense-using-a-custom-fields-unique-value' id='update-an-recurring-expense-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/recurring-expenses/#update-an-recurring-expense-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update an recurring expense using a custom field's unique value</a> </li> <li class='item list-recurring-expenses' id='list-recurring-expenses-item'> <a href="/books/api/v3/recurring-expenses/#list-recurring-expenses" onclick="toggleAccordionMenu(this)">List recurring expenses</a> </li> <li class='item update-a-recurring-expense' id='update-a-recurring-expense-item'> <a href="/books/api/v3/recurring-expenses/#update-a-recurring-expense" onclick="toggleAccordionMenu(this)">Update a recurring expense</a> </li> <li class='item get-a-recurring-expense' id='get-a-recurring-expense-item'> <a href="/books/api/v3/recurring-expenses/#get-a-recurring-expense" onclick="toggleAccordionMenu(this)">Get a recurring expense</a> </li> <li class='item delete-a-recurring-expense' id='delete-a-recurring-expense-item'> <a href="/books/api/v3/recurring-expenses/#delete-a-recurring-expense" onclick="toggleAccordionMenu(this)">Delete a recurring expense</a> </li> <li class='item stop-a-recurring-expense' id='stop-a-recurring-expense-item'> <a href="/books/api/v3/recurring-expenses/#stop-a-recurring-expense" onclick="toggleAccordionMenu(this)">Stop a recurring expense</a> </li> <li class='item resume-a-recurring-expense' id='resume-a-recurring-expense-item'> <a href="/books/api/v3/recurring-expenses/#resume-a-recurring-expense" onclick="toggleAccordionMenu(this)">Resume a recurring Expense</a> </li> <li class='item list-child-expenses-created' id='list-child-expenses-created-item'> <a href="/books/api/v3/recurring-expenses/#list-child-expenses-created" onclick="toggleAccordionMenu(this)">List child expenses created</a> </li> <li class='item list-recurring-expense-history' id='list-recurring-expense-history-item'> <a href="/books/api/v3/recurring-expenses/#list-recurring-expense-history" onclick="toggleAccordionMenu(this)">List recurring expense history</a> </li> </ul> </li> <li class="nested-menu" id='retainer-invoices-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Retainer Invoices</a> <ul class='panel -acc-wrapper'> <li class='item retainer-invoices-overview' id='retainer-invoices-overview-item'> <a href="/books/api/v3/retainer-invoices/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-retainerinvoice' id='create-a-retainerinvoice-item'> <a href="/books/api/v3/retainer-invoices/#create-a-retainerinvoice" onclick="toggleAccordionMenu(this)">Create a retainerinvoice</a> </li> <li class='item list-a-retainer-invoices' id='list-a-retainer-invoices-item'> <a href="/books/api/v3/retainer-invoices/#list-a-retainer-invoices" onclick="toggleAccordionMenu(this)">List a retainer invoices</a> </li> <li class='item update-a-retainerinvoice' id='update-a-retainerinvoice-item'> <a href="/books/api/v3/retainer-invoices/#update-a-retainerinvoice" onclick="toggleAccordionMenu(this)">update a retainerinvoice</a> </li> <li class='item get-a-retainer-invoice' id='get-a-retainer-invoice-item'> <a href="/books/api/v3/retainer-invoices/#get-a-retainer-invoice" onclick="toggleAccordionMenu(this)">Get a retainer invoice</a> </li> <li class='item delete-a-retainer-invoice' id='delete-a-retainer-invoice-item'> <a href="/books/api/v3/retainer-invoices/#delete-a-retainer-invoice" onclick="toggleAccordionMenu(this)">Delete a retainer invoice</a> </li> <li class='item mark-a-retainer-invoice-as-sent' id='mark-a-retainer-invoice-as-sent-item'> <a href="/books/api/v3/retainer-invoices/#mark-a-retainer-invoice-as-sent" onclick="toggleAccordionMenu(this)">Mark a retainer invoice as sent</a> </li> <li class='item update-retainer-invoice-template' id='update-retainer-invoice-template-item'> <a href="/books/api/v3/retainer-invoices/#update-retainer-invoice-template" onclick="toggleAccordionMenu(this)">Update retainer invoice template</a> </li> <li class='item void-a-retainer-invoice' id='void-a-retainer-invoice-item'> <a href="/books/api/v3/retainer-invoices/#void-a-retainer-invoice" onclick="toggleAccordionMenu(this)">Void a retainer invoice</a> </li> <li class='item mark-as-draft' id='mark-as-draft-item'> <a href="/books/api/v3/retainer-invoices/#mark-as-draft" onclick="toggleAccordionMenu(this)">Mark as draft</a> </li> <li class='item submit-a-retainer-invoice-for-approval' id='submit-a-retainer-invoice-for-approval-item'> <a href="/books/api/v3/retainer-invoices/#submit-a-retainer-invoice-for-approval" onclick="toggleAccordionMenu(this)">Submit a retainer invoice for approval</a> </li> <li class='item approve-a-retainer-invoice' id='approve-a-retainer-invoice-item'> <a href="/books/api/v3/retainer-invoices/#approve-a-retainer-invoice" onclick="toggleAccordionMenu(this)">Approve a retainer invoice.</a> </li> <li class='item email-a-retainer-invoice' id='email-a-retainer-invoice-item'> <a href="/books/api/v3/retainer-invoices/#email-a-retainer-invoice" onclick="toggleAccordionMenu(this)">Email a retainer invoice</a> </li> <li class='item get-retainer-invoice-email-content' id='get-retainer-invoice-email-content-item'> <a href="/books/api/v3/retainer-invoices/#get-retainer-invoice-email-content" onclick="toggleAccordionMenu(this)">Get retainer invoice email content</a> </li> <li class='item update-billing-address' id='update-billing-address-item'> <a href="/books/api/v3/retainer-invoices/#update-billing-address" onclick="toggleAccordionMenu(this)">Update billing address</a> </li> <li class='item list-retainer-invoice-templates' id='list-retainer-invoice-templates-item'> <a href="/books/api/v3/retainer-invoices/#list-retainer-invoice-templates" onclick="toggleAccordionMenu(this)">List retainer invoice templates</a> </li> <li class='item add-attachment-to-a-retainer-invoice' id='add-attachment-to-a-retainer-invoice-item'> <a href="/books/api/v3/retainer-invoices/#add-attachment-to-a-retainer-invoice" onclick="toggleAccordionMenu(this)">Add attachment to a retainer invoice</a> </li> <li class='item get-a-retainer-invoice-attachment' id='get-a-retainer-invoice-attachment-item'> <a href="/books/api/v3/retainer-invoices/#get-a-retainer-invoice-attachment" onclick="toggleAccordionMenu(this)">Get a retainer invoice attachment</a> </li> <li class='item delete-an-attachment' id='delete-an-attachment-item'> <a href="/books/api/v3/retainer-invoices/#delete-an-attachment" onclick="toggleAccordionMenu(this)">Delete an attachment</a> </li> <li class='item add-comment' id='add-comment-item'> <a href="/books/api/v3/retainer-invoices/#add-comment" onclick="toggleAccordionMenu(this)">Add comment</a> </li> <li class='item list-retainer-invoice-comments-and-history' id='list-retainer-invoice-comments-and-history-item'> <a href="/books/api/v3/retainer-invoices/#list-retainer-invoice-comments-and-history" onclick="toggleAccordionMenu(this)">List retainer invoice comments & history</a> </li> <li class='item update-comment' id='update-comment-item'> <a href="/books/api/v3/retainer-invoices/#update-comment" onclick="toggleAccordionMenu(this)">Update comment</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/retainer-invoices/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> </ul> </li> <li class="nested-menu" id='purchase-order-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Purchase Order</a> <ul class='panel -acc-wrapper'> <li class='item purchase-order-overview' id='purchase-order-overview-item'> <a href="/books/api/v3/purchase-order/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-purchase-order' id='create-a-purchase-order-item'> <a href="/books/api/v3/purchase-order/#create-a-purchase-order" onclick="toggleAccordionMenu(this)">Create a purchase order</a> </li> <li class='item update-a-purchase-order-using-a-custom-fields-unique-value' id='update-a-purchase-order-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/purchase-order/#update-a-purchase-order-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a purchase order using a custom field's unique value</a> </li> <li class='item list-purchase-orders' id='list-purchase-orders-item'> <a href="/books/api/v3/purchase-order/#list-purchase-orders" onclick="toggleAccordionMenu(this)">List purchase orders</a> </li> <li class='item update-a-purchase-order' id='update-a-purchase-order-item'> <a href="/books/api/v3/purchase-order/#update-a-purchase-order" onclick="toggleAccordionMenu(this)">Update a purchase order</a> </li> <li class='item get-a-purchase-order' id='get-a-purchase-order-item'> <a href="/books/api/v3/purchase-order/#get-a-purchase-order" onclick="toggleAccordionMenu(this)">Get a purchase order</a> </li> <li class='item delete-purchase-order' id='delete-purchase-order-item'> <a href="/books/api/v3/purchase-order/#delete-purchase-order" onclick="toggleAccordionMenu(this)">Delete purchase order</a> </li> <li class='item update-custom-field-in-existing-purchaseorders' id='update-custom-field-in-existing-purchaseorders-item'> <a href="/books/api/v3/purchase-order/#update-custom-field-in-existing-purchaseorders" onclick="toggleAccordionMenu(this)">Update custom field in existing purchaseorders</a> </li> <li class='item mark-a-purchase-order-as-open' id='mark-a-purchase-order-as-open-item'> <a href="/books/api/v3/purchase-order/#mark-a-purchase-order-as-open" onclick="toggleAccordionMenu(this)">Mark a purchase order as open</a> </li> <li class='item mark-as-billed' id='mark-as-billed-item'> <a href="/books/api/v3/purchase-order/#mark-as-billed" onclick="toggleAccordionMenu(this)">Mark as billed</a> </li> <li class='item cancel-a-purchase-order' id='cancel-a-purchase-order-item'> <a href="/books/api/v3/purchase-order/#cancel-a-purchase-order" onclick="toggleAccordionMenu(this)">Cancel a purchase order</a> </li> <li class='item submit-a-purchase-order-for-approval' id='submit-a-purchase-order-for-approval-item'> <a href="/books/api/v3/purchase-order/#submit-a-purchase-order-for-approval" onclick="toggleAccordionMenu(this)">Submit a purchase order for approval</a> </li> <li class='item approve-a-purchase-order' id='approve-a-purchase-order-item'> <a href="/books/api/v3/purchase-order/#approve-a-purchase-order" onclick="toggleAccordionMenu(this)">Approve a purchase order</a> </li> <li class='item email-a-purchase-order' id='email-a-purchase-order-item'> <a href="/books/api/v3/purchase-order/#email-a-purchase-order" onclick="toggleAccordionMenu(this)">Email a purchase order</a> </li> <li class='item get-purchase-order-email-content' id='get-purchase-order-email-content-item'> <a href="/books/api/v3/purchase-order/#get-purchase-order-email-content" onclick="toggleAccordionMenu(this)">Get purchase order email content</a> </li> <li class='item update-billing-address' id='update-billing-address-item'> <a href="/books/api/v3/purchase-order/#update-billing-address" onclick="toggleAccordionMenu(this)">Update billing address</a> </li> <li class='item list-purchase-order-templates' id='list-purchase-order-templates-item'> <a href="/books/api/v3/purchase-order/#list-purchase-order-templates" onclick="toggleAccordionMenu(this)">List purchase order templates</a> </li> <li class='item update-purchase-order-template' id='update-purchase-order-template-item'> <a href="/books/api/v3/purchase-order/#update-purchase-order-template" onclick="toggleAccordionMenu(this)">Update purchase order template</a> </li> <li class='item add-attachment-to-a-purchase-order' id='add-attachment-to-a-purchase-order-item'> <a href="/books/api/v3/purchase-order/#add-attachment-to-a-purchase-order" onclick="toggleAccordionMenu(this)">Add attachment to a purchase order</a> </li> <li class='item update-attachment-preference' id='update-attachment-preference-item'> <a href="/books/api/v3/purchase-order/#update-attachment-preference" onclick="toggleAccordionMenu(this)">Update attachment preference</a> </li> <li class='item get-a-purchase-order-attachment' id='get-a-purchase-order-attachment-item'> <a href="/books/api/v3/purchase-order/#get-a-purchase-order-attachment" onclick="toggleAccordionMenu(this)">Get a purchase order attachment</a> </li> <li class='item delete-an-attachment' id='delete-an-attachment-item'> <a href="/books/api/v3/purchase-order/#delete-an-attachment" onclick="toggleAccordionMenu(this)">Delete an attachment</a> </li> <li class='item add-comment' id='add-comment-item'> <a href="/books/api/v3/purchase-order/#add-comment" onclick="toggleAccordionMenu(this)">Add comment</a> </li> <li class='item list-purchase-order-comments-and-history' id='list-purchase-order-comments-and-history-item'> <a href="/books/api/v3/purchase-order/#list-purchase-order-comments-and-history" onclick="toggleAccordionMenu(this)">List purchase order comments & history</a> </li> <li class='item update-comment' id='update-comment-item'> <a href="/books/api/v3/purchase-order/#update-comment" onclick="toggleAccordionMenu(this)">Update comment</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/purchase-order/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> </ul> </li> <li class="nested-menu" id='bills-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Bills</a> <ul class='panel -acc-wrapper'> <li class='item bills-overview' id='bills-overview-item'> <a href="/books/api/v3/bills/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-bill' id='create-a-bill-item'> <a href="/books/api/v3/bills/#create-a-bill" onclick="toggleAccordionMenu(this)">Create a bill</a> </li> <li class='item update-a-bill-using-a-custom-fields-unique-value' id='update-a-bill-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/bills/#update-a-bill-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a bill using a custom field's unique value</a> </li> <li class='item list-bills' id='list-bills-item'> <a href="/books/api/v3/bills/#list-bills" onclick="toggleAccordionMenu(this)">List bills</a> </li> <li class='item update-a-bill' id='update-a-bill-item'> <a href="/books/api/v3/bills/#update-a-bill" onclick="toggleAccordionMenu(this)">Update a bill</a> </li> <li class='item get-a-bill' id='get-a-bill-item'> <a href="/books/api/v3/bills/#get-a-bill" onclick="toggleAccordionMenu(this)">Get a bill</a> </li> <li class='item delete-a-bill' id='delete-a-bill-item'> <a href="/books/api/v3/bills/#delete-a-bill" onclick="toggleAccordionMenu(this)">Delete a bill</a> </li> <li class='item update-custom-field-in-existing-bills' id='update-custom-field-in-existing-bills-item'> <a href="/books/api/v3/bills/#update-custom-field-in-existing-bills" onclick="toggleAccordionMenu(this)">Update custom field in existing bills</a> </li> <li class='item void-a-bill' id='void-a-bill-item'> <a href="/books/api/v3/bills/#void-a-bill" onclick="toggleAccordionMenu(this)">Void a bill</a> </li> <li class='item mark-a-bill-as-open' id='mark-a-bill-as-open-item'> <a href="/books/api/v3/bills/#mark-a-bill-as-open" onclick="toggleAccordionMenu(this)">Mark a bill as open</a> </li> <li class='item submit-a-bill-for-approval' id='submit-a-bill-for-approval-item'> <a href="/books/api/v3/bills/#submit-a-bill-for-approval" onclick="toggleAccordionMenu(this)">Submit a bill for approval</a> </li> <li class='item approve-a-bill' id='approve-a-bill-item'> <a href="/books/api/v3/bills/#approve-a-bill" onclick="toggleAccordionMenu(this)">Approve a bill</a> </li> <li class='item update-billing-address' id='update-billing-address-item'> <a href="/books/api/v3/bills/#update-billing-address" onclick="toggleAccordionMenu(this)">Update billing address</a> </li> <li class='item list-bill-payments' id='list-bill-payments-item'> <a href="/books/api/v3/bills/#list-bill-payments" onclick="toggleAccordionMenu(this)">List bill payments</a> </li> <li class='item apply-credits' id='apply-credits-item'> <a href="/books/api/v3/bills/#apply-credits" onclick="toggleAccordionMenu(this)">Apply credits</a> </li> <li class='item delete-a-payment' id='delete-a-payment-item'> <a href="/books/api/v3/bills/#delete-a-payment" onclick="toggleAccordionMenu(this)">Delete a payment</a> </li> <li class='item add-attachment-to-a-bill' id='add-attachment-to-a-bill-item'> <a href="/books/api/v3/bills/#add-attachment-to-a-bill" onclick="toggleAccordionMenu(this)">Add attachment to a bill</a> </li> <li class='item get-a-bill-attachment' id='get-a-bill-attachment-item'> <a href="/books/api/v3/bills/#get-a-bill-attachment" onclick="toggleAccordionMenu(this)">Get a bill attachment</a> </li> <li class='item delete-an-attachment' id='delete-an-attachment-item'> <a href="/books/api/v3/bills/#delete-an-attachment" onclick="toggleAccordionMenu(this)">Delete an attachment</a> </li> <li class='item add-comment' id='add-comment-item'> <a href="/books/api/v3/bills/#add-comment" onclick="toggleAccordionMenu(this)">Add comment</a> </li> <li class='item list-bill-comments-and-history' id='list-bill-comments-and-history-item'> <a href="/books/api/v3/bills/#list-bill-comments-and-history" onclick="toggleAccordionMenu(this)">List bill comments & history</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/bills/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> <li class='item convert-po-to-bill' id='convert-po-to-bill-item'> <a href="/books/api/v3/bills/#convert-po-to-bill" onclick="toggleAccordionMenu(this)">Convert PO to Bill</a> </li> </ul> </li> <li class="nested-menu" id='recurring-bills-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Recurring Bills</a> <ul class='panel -acc-wrapper'> <li class='item recurring-bills-overview' id='recurring-bills-overview-item'> <a href="/books/api/v3/recurring-bills/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-recurring-bill' id='create-a-recurring-bill-item'> <a href="/books/api/v3/recurring-bills/#create-a-recurring-bill" onclick="toggleAccordionMenu(this)">Create a recurring bill</a> </li> <li class='item update-a-recurring-bill-using-a-custom-fields-unique-value' id='update-a-recurring-bill-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/recurring-bills/#update-a-recurring-bill-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a recurring bill using a custom field's unique value</a> </li> <li class='item list-recurring-bills' id='list-recurring-bills-item'> <a href="/books/api/v3/recurring-bills/#list-recurring-bills" onclick="toggleAccordionMenu(this)">List recurring bills</a> </li> <li class='item update-a-recurring-bill' id='update-a-recurring-bill-item'> <a href="/books/api/v3/recurring-bills/#update-a-recurring-bill" onclick="toggleAccordionMenu(this)">Update a recurring bill</a> </li> <li class='item get-a-recurring-bill' id='get-a-recurring-bill-item'> <a href="/books/api/v3/recurring-bills/#get-a-recurring-bill" onclick="toggleAccordionMenu(this)">Get a recurring bill</a> </li> <li class='item delete-a-recurring-bill' id='delete-a-recurring-bill-item'> <a href="/books/api/v3/recurring-bills/#delete-a-recurring-bill" onclick="toggleAccordionMenu(this)">Delete a recurring bill</a> </li> <li class='item stop-a-recurring-bill' id='stop-a-recurring-bill-item'> <a href="/books/api/v3/recurring-bills/#stop-a-recurring-bill" onclick="toggleAccordionMenu(this)">Stop a recurring bill</a> </li> <li class='item resume-a-recurring-bill' id='resume-a-recurring-bill-item'> <a href="/books/api/v3/recurring-bills/#resume-a-recurring-bill" onclick="toggleAccordionMenu(this)">Resume a recurring Bill</a> </li> <li class='item list-recurring-bill-history' id='list-recurring-bill-history-item'> <a href="/books/api/v3/recurring-bills/#list-recurring-bill-history" onclick="toggleAccordionMenu(this)">List recurring bill history</a> </li> </ul> </li> <li class="nested-menu" id='vendor-credits-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Vendor Credits</a> <ul class='panel -acc-wrapper'> <li class='item vendor-credits-overview' id='vendor-credits-overview-item'> <a href="/books/api/v3/vendor-credits/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-vendor-credit' id='create-a-vendor-credit-item'> <a href="/books/api/v3/vendor-credits/#create-a-vendor-credit" onclick="toggleAccordionMenu(this)">Create a vendor credit</a> </li> <li class='item list-vendor-credits' id='list-vendor-credits-item'> <a href="/books/api/v3/vendor-credits/#list-vendor-credits" onclick="toggleAccordionMenu(this)">List vendor credits</a> </li> <li class='item update-vendor-credit' id='update-vendor-credit-item'> <a href="/books/api/v3/vendor-credits/#update-vendor-credit" onclick="toggleAccordionMenu(this)">Update vendor credit</a> </li> <li class='item get-vendor-credit' id='get-vendor-credit-item'> <a href="/books/api/v3/vendor-credits/#get-vendor-credit" onclick="toggleAccordionMenu(this)">Get vendor credit</a> </li> <li class='item delete-vendor-credit' id='delete-vendor-credit-item'> <a href="/books/api/v3/vendor-credits/#delete-vendor-credit" onclick="toggleAccordionMenu(this)">Delete vendor credit</a> </li> <li class='item convert-to-open' id='convert-to-open-item'> <a href="/books/api/v3/vendor-credits/#convert-to-open" onclick="toggleAccordionMenu(this)">Convert to open</a> </li> <li class='item void-vendor-credit' id='void-vendor-credit-item'> <a href="/books/api/v3/vendor-credits/#void-vendor-credit" onclick="toggleAccordionMenu(this)">Void vendor credit</a> </li> <li class='item submit-a-vendor-credit-for-approval' id='submit-a-vendor-credit-for-approval-item'> <a href="/books/api/v3/vendor-credits/#submit-a-vendor-credit-for-approval" onclick="toggleAccordionMenu(this)">Submit a Vendor credit for approval</a> </li> <li class='item approve-a-vendor-credit' id='approve-a-vendor-credit-item'> <a href="/books/api/v3/vendor-credits/#approve-a-vendor-credit" onclick="toggleAccordionMenu(this)">Approve a Vendor credit</a> </li> <li class='item apply-credits-to-a-bill' id='apply-credits-to-a-bill-item'> <a href="/books/api/v3/vendor-credits/#apply-credits-to-a-bill" onclick="toggleAccordionMenu(this)">Apply credits to a bill</a> </li> <li class='item list-bills-credited' id='list-bills-credited-item'> <a href="/books/api/v3/vendor-credits/#list-bills-credited" onclick="toggleAccordionMenu(this)">List bills credited</a> </li> <li class='item delete-bills-credited' id='delete-bills-credited-item'> <a href="/books/api/v3/vendor-credits/#delete-bills-credited" onclick="toggleAccordionMenu(this)">Delete bills credited</a> </li> <li class='item refund-a-vendor-credit' id='refund-a-vendor-credit-item'> <a href="/books/api/v3/vendor-credits/#refund-a-vendor-credit" onclick="toggleAccordionMenu(this)">Refund a vendor credit</a> </li> <li class='item list-refunds-of-a-vendor-credit' id='list-refunds-of-a-vendor-credit-item'> <a href="/books/api/v3/vendor-credits/#list-refunds-of-a-vendor-credit" onclick="toggleAccordionMenu(this)">List refunds of a vendor credit</a> </li> <li class='item update-vendor-credit-refund' id='update-vendor-credit-refund-item'> <a href="/books/api/v3/vendor-credits/#update-vendor-credit-refund" onclick="toggleAccordionMenu(this)">Update vendor credit refund</a> </li> <li class='item get-vendor-credit-refund' id='get-vendor-credit-refund-item'> <a href="/books/api/v3/vendor-credits/#get-vendor-credit-refund" onclick="toggleAccordionMenu(this)">Get vendor credit refund</a> </li> <li class='item delete-vendor-credit-refund' id='delete-vendor-credit-refund-item'> <a href="/books/api/v3/vendor-credits/#delete-vendor-credit-refund" onclick="toggleAccordionMenu(this)">Delete vendor credit refund</a> </li> <li class='item list-vendor-credit-refunds' id='list-vendor-credit-refunds-item'> <a href="/books/api/v3/vendor-credits/#list-vendor-credit-refunds" onclick="toggleAccordionMenu(this)">List vendor credit refunds</a> </li> <li class='item add-a-comment' id='add-a-comment-item'> <a href="/books/api/v3/vendor-credits/#add-a-comment" onclick="toggleAccordionMenu(this)">Add a comment</a> </li> <li class='item list-vendor-credit-comments-and-history' id='list-vendor-credit-comments-and-history-item'> <a href="/books/api/v3/vendor-credits/#list-vendor-credit-comments-and-history" onclick="toggleAccordionMenu(this)">List vendor credit comments & history</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/vendor-credits/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> </ul> </li> <li class="nested-menu" id='vendor-payments-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Vendor Payments</a> <ul class='panel -acc-wrapper'> <li class='item vendor-payments-overview' id='vendor-payments-overview-item'> <a href="/books/api/v3/vendor-payments/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-vendor-payment' id='create-a-vendor-payment-item'> <a href="/books/api/v3/vendor-payments/#create-a-vendor-payment" onclick="toggleAccordionMenu(this)">Create a vendor payment</a> </li> <li class='item update-an-vendor-payment-using-a-custom-fields-unique-value' id='update-an-vendor-payment-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/vendor-payments/#update-an-vendor-payment-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update an vendor payment using a custom field's unique value</a> </li> <li class='item list-vendor-payments' id='list-vendor-payments-item'> <a href="/books/api/v3/vendor-payments/#list-vendor-payments" onclick="toggleAccordionMenu(this)">List vendor payments</a> </li> <li class='item update-a-vendor-payment' id='update-a-vendor-payment-item'> <a href="/books/api/v3/vendor-payments/#update-a-vendor-payment" onclick="toggleAccordionMenu(this)">Update a vendor payment</a> </li> <li class='item get-a-vendor-payment' id='get-a-vendor-payment-item'> <a href="/books/api/v3/vendor-payments/#get-a-vendor-payment" onclick="toggleAccordionMenu(this)">Get a vendor payment</a> </li> <li class='item delete-a-vendor-payment' id='delete-a-vendor-payment-item'> <a href="/books/api/v3/vendor-payments/#delete-a-vendor-payment" onclick="toggleAccordionMenu(this)">Delete a vendor payment</a> </li> <li class='item refund-an-excess-vendor-payment' id='refund-an-excess-vendor-payment-item'> <a href="/books/api/v3/vendor-payments/#refund-an-excess-vendor-payment" onclick="toggleAccordionMenu(this)">Refund an excess vendor payment</a> </li> <li class='item list-refunds-of-a-vendor-payment' id='list-refunds-of-a-vendor-payment-item'> <a href="/books/api/v3/vendor-payments/#list-refunds-of-a-vendor-payment" onclick="toggleAccordionMenu(this)">List refunds of a vendor payment</a> </li> <li class='item update-a-refund' id='update-a-refund-item'> <a href="/books/api/v3/vendor-payments/#update-a-refund" onclick="toggleAccordionMenu(this)">Update a refund</a> </li> <li class='item details-of-a-refund' id='details-of-a-refund-item'> <a href="/books/api/v3/vendor-payments/#details-of-a-refund" onclick="toggleAccordionMenu(this)">Details of a refund</a> </li> <li class='item delete-a-refund' id='delete-a-refund-item'> <a href="/books/api/v3/vendor-payments/#delete-a-refund" onclick="toggleAccordionMenu(this)">Delete a refund</a> </li> </ul> </li> <li class="nested-menu" id='custom-fields-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Custom Fields</a> <ul class='panel -acc-wrapper'> <li class='item custom-fields-overview' id='custom-fields-overview-item'> <a href="/books/api/v3/custom-fields/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> </ul> </li> <li class="nested-menu" id='custom-modules-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Custom Modules</a> <ul class='panel -acc-wrapper'> <li class='item custom-modules-overview' id='custom-modules-overview-item'> <a href="/books/api/v3/custom-modules/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-custom-modules' id='create-custom-modules-item'> <a href="/books/api/v3/custom-modules/#create-custom-modules" onclick="toggleAccordionMenu(this)">Create Custom Modules</a> </li> <li class='item bulk-update-custom-module' id='bulk-update-custom-module-item'> <a href="/books/api/v3/custom-modules/#bulk-update-custom-module" onclick="toggleAccordionMenu(this)">Bulk Update Custom Module</a> </li> <li class='item get-record-list-of-a-custom-module' id='get-record-list-of-a-custom-module-item'> <a href="/books/api/v3/custom-modules/#get-record-list-of-a-custom-module" onclick="toggleAccordionMenu(this)">Get Record List of a Custom Module</a> </li> <li class='item delete-custom-modules' id='delete-custom-modules-item'> <a href="/books/api/v3/custom-modules/#delete-custom-modules" onclick="toggleAccordionMenu(this)"> Delete Custom Modules</a> </li> <li class='item update-custom-module' id='update-custom-module-item'> <a href="/books/api/v3/custom-modules/#update-custom-module" onclick="toggleAccordionMenu(this)">Update Custom Module</a> </li> <li class='item get-individual-record-details' id='get-individual-record-details-item'> <a href="/books/api/v3/custom-modules/#get-individual-record-details" onclick="toggleAccordionMenu(this)">Get Individual Record Details</a> </li> <li class='item delete-individual-records' id='delete-individual-records-item'> <a href="/books/api/v3/custom-modules/#delete-individual-records" onclick="toggleAccordionMenu(this)">Delete individual records </a> </li> </ul> </li> <li class="nested-menu" id='bank-accounts-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Bank Accounts</a> <ul class='panel -acc-wrapper'> <li class='item bank-accounts-overview' id='bank-accounts-overview-item'> <a href="/books/api/v3/bank-accounts/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-bank-account' id='create-a-bank-account-item'> <a href="/books/api/v3/bank-accounts/#create-a-bank-account" onclick="toggleAccordionMenu(this)">Create a bank account</a> </li> <li class='item list-view-of-accounts' id='list-view-of-accounts-item'> <a href="/books/api/v3/bank-accounts/#list-view-of-accounts" onclick="toggleAccordionMenu(this)">List view of accounts</a> </li> <li class='item update-bank-account' id='update-bank-account-item'> <a href="/books/api/v3/bank-accounts/#update-bank-account" onclick="toggleAccordionMenu(this)">Update bank account</a> </li> <li class='item get-account-details' id='get-account-details-item'> <a href="/books/api/v3/bank-accounts/#get-account-details" onclick="toggleAccordionMenu(this)">Get account details</a> </li> <li class='item delete-an-account' id='delete-an-account-item'> <a href="/books/api/v3/bank-accounts/#delete-an-account" onclick="toggleAccordionMenu(this)">Delete an account</a> </li> <li class='item deactivate-account' id='deactivate-account-item'> <a href="/books/api/v3/bank-accounts/#deactivate-account" onclick="toggleAccordionMenu(this)">Deactivate account.</a> </li> <li class='item activate-account' id='activate-account-item'> <a href="/books/api/v3/bank-accounts/#activate-account" onclick="toggleAccordionMenu(this)">Activate account</a> </li> <li class='item import-a-bankcredit-card-statement' id='import-a-bankcredit-card-statement-item'> <a href="/books/api/v3/bank-accounts/#import-a-bankcredit-card-statement" onclick="toggleAccordionMenu(this)">Import a Bank/Credit Card Statement</a> </li> <li class='item get-last-imported-statement' id='get-last-imported-statement-item'> <a href="/books/api/v3/bank-accounts/#get-last-imported-statement" onclick="toggleAccordionMenu(this)">Get last imported statement</a> </li> <li class='item delete-last-imported-statement' id='delete-last-imported-statement-item'> <a href="/books/api/v3/bank-accounts/#delete-last-imported-statement" onclick="toggleAccordionMenu(this)">Delete last imported statement</a> </li> </ul> </li> <li class="nested-menu" id='bank-transactions-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Bank Transactions</a> <ul class='panel -acc-wrapper'> <li class='item bank-transactions-overview' id='bank-transactions-overview-item'> <a href="/books/api/v3/bank-transactions/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-transaction-for-an-account' id='create-a-transaction-for-an-account-item'> <a href="/books/api/v3/bank-transactions/#create-a-transaction-for-an-account" onclick="toggleAccordionMenu(this)">Create a transaction for an account</a> </li> <li class='item get-transactions-list' id='get-transactions-list-item'> <a href="/books/api/v3/bank-transactions/#get-transactions-list" onclick="toggleAccordionMenu(this)">Get transactions list</a> </li> <li class='item update-a-transaction' id='update-a-transaction-item'> <a href="/books/api/v3/bank-transactions/#update-a-transaction" onclick="toggleAccordionMenu(this)">Update a transaction</a> </li> <li class='item get-transaction' id='get-transaction-item'> <a href="/books/api/v3/bank-transactions/#get-transaction" onclick="toggleAccordionMenu(this)">Get transaction</a> </li> <li class='item delete-a-transaction' id='delete-a-transaction-item'> <a href="/books/api/v3/bank-transactions/#delete-a-transaction" onclick="toggleAccordionMenu(this)">Delete a transaction</a> </li> <li class='item match-a-transaction' id='match-a-transaction-item'> <a href="/books/api/v3/bank-transactions/#match-a-transaction" onclick="toggleAccordionMenu(this)">Match a transaction</a> </li> <li class='item get-matching-transactions' id='get-matching-transactions-item'> <a href="/books/api/v3/bank-transactions/#get-matching-transactions" onclick="toggleAccordionMenu(this)">Get matching transactions</a> </li> <li class='item unmatch-a-matched-transaction' id='unmatch-a-matched-transaction-item'> <a href="/books/api/v3/bank-transactions/#unmatch-a-matched-transaction" onclick="toggleAccordionMenu(this)">Unmatch a matched transaction</a> </li> <li class='item exclude-a-transaction' id='exclude-a-transaction-item'> <a href="/books/api/v3/bank-transactions/#exclude-a-transaction" onclick="toggleAccordionMenu(this)">Exclude a transaction</a> </li> <li class='item restore-a-transaction' id='restore-a-transaction-item'> <a href="/books/api/v3/bank-transactions/#restore-a-transaction" onclick="toggleAccordionMenu(this)">Restore a transaction</a> </li> <li class='item categorize-an-uncategorized-transaction' id='categorize-an-uncategorized-transaction-item'> <a href="/books/api/v3/bank-transactions/#categorize-an-uncategorized-transaction" onclick="toggleAccordionMenu(this)">Categorize an uncategorized transaction</a> </li> <li class='item categorize-as-expense' id='categorize-as-expense-item'> <a href="/books/api/v3/bank-transactions/#categorize-as-expense" onclick="toggleAccordionMenu(this)">Categorize as expense</a> </li> <li class='item uncategorize-a-categorized-transaction' id='uncategorize-a-categorized-transaction-item'> <a href="/books/api/v3/bank-transactions/#uncategorize-a-categorized-transaction" onclick="toggleAccordionMenu(this)">Uncategorize a categorized transaction</a> </li> <li class='item categorize-a-vendor-payment' id='categorize-a-vendor-payment-item'> <a href="/books/api/v3/bank-transactions/#categorize-a-vendor-payment" onclick="toggleAccordionMenu(this)">Categorize a vendor payment</a> </li> <li class='item categorize-as-customer-payment' id='categorize-as-customer-payment-item'> <a href="/books/api/v3/bank-transactions/#categorize-as-customer-payment" onclick="toggleAccordionMenu(this)">Categorize as customer payment</a> </li> <li class='item categorize-as-credit-note-refunds' id='categorize-as-credit-note-refunds-item'> <a href="/books/api/v3/bank-transactions/#categorize-as-credit-note-refunds" onclick="toggleAccordionMenu(this)">Categorize as credit note refunds</a> </li> <li class='item categorize-as-vendor-credit-refunds' id='categorize-as-vendor-credit-refunds-item'> <a href="/books/api/v3/bank-transactions/#categorize-as-vendor-credit-refunds" onclick="toggleAccordionMenu(this)">Categorize as vendor credit refunds</a> </li> <li class='item categorize-as-customer-payment-refund' id='categorize-as-customer-payment-refund-item'> <a href="/books/api/v3/bank-transactions/#categorize-as-customer-payment-refund" onclick="toggleAccordionMenu(this)">Categorize as Customer Payment refund</a> </li> <li class='item categorize-as-vendor-payment-refund' id='categorize-as-vendor-payment-refund-item'> <a href="/books/api/v3/bank-transactions/#categorize-as-vendor-payment-refund" onclick="toggleAccordionMenu(this)">Categorize as Vendor Payment refund</a> </li> </ul> </li> <li class="nested-menu" id='bank-rules-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Bank Rules</a> <ul class='panel -acc-wrapper'> <li class='item bank-rules-overview' id='bank-rules-overview-item'> <a href="/books/api/v3/bank-rules/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-rule' id='create-a-rule-item'> <a href="/books/api/v3/bank-rules/#create-a-rule" onclick="toggleAccordionMenu(this)">Create a rule</a> </li> <li class='item get-rules-list' id='get-rules-list-item'> <a href="/books/api/v3/bank-rules/#get-rules-list" onclick="toggleAccordionMenu(this)">Get Rules List</a> </li> <li class='item update-a-rule' id='update-a-rule-item'> <a href="/books/api/v3/bank-rules/#update-a-rule" onclick="toggleAccordionMenu(this)">Update a rule</a> </li> <li class='item get-a-rule' id='get-a-rule-item'> <a href="/books/api/v3/bank-rules/#get-a-rule" onclick="toggleAccordionMenu(this)">Get a rule</a> </li> <li class='item delete-a-rule' id='delete-a-rule-item'> <a href="/books/api/v3/bank-rules/#delete-a-rule" onclick="toggleAccordionMenu(this)">Delete a rule</a> </li> </ul> </li> <li class="nested-menu" id='chart-of-accounts-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Chart Of Accounts</a> <ul class='panel -acc-wrapper'> <li class='item chart-of-accounts-overview' id='chart-of-accounts-overview-item'> <a href="/books/api/v3/chart-of-accounts/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-an-account' id='create-an-account-item'> <a href="/books/api/v3/chart-of-accounts/#create-an-account" onclick="toggleAccordionMenu(this)">Create an account</a> </li> <li class='item list-chart-of-accounts' id='list-chart-of-accounts-item'> <a href="/books/api/v3/chart-of-accounts/#list-chart-of-accounts" onclick="toggleAccordionMenu(this)">List chart of accounts</a> </li> <li class='item update-an-account' id='update-an-account-item'> <a href="/books/api/v3/chart-of-accounts/#update-an-account" onclick="toggleAccordionMenu(this)">Update an account</a> </li> <li class='item get-an-account' id='get-an-account-item'> <a href="/books/api/v3/chart-of-accounts/#get-an-account" onclick="toggleAccordionMenu(this)">Get an account</a> </li> <li class='item delete-an-account' id='delete-an-account-item'> <a href="/books/api/v3/chart-of-accounts/#delete-an-account" onclick="toggleAccordionMenu(this)">Delete an account</a> </li> <li class='item mark-an-account-as-active' id='mark-an-account-as-active-item'> <a href="/books/api/v3/chart-of-accounts/#mark-an-account-as-active" onclick="toggleAccordionMenu(this)">Mark an account as active</a> </li> <li class='item mark-an-account-as-inactive' id='mark-an-account-as-inactive-item'> <a href="/books/api/v3/chart-of-accounts/#mark-an-account-as-inactive" onclick="toggleAccordionMenu(this)">Mark an account as inactive</a> </li> <li class='item list-of-transactions-for-an-account' id='list-of-transactions-for-an-account-item'> <a href="/books/api/v3/chart-of-accounts/#list-of-transactions-for-an-account" onclick="toggleAccordionMenu(this)">List of transactions for an account</a> </li> <li class='item delete-a-transaction' id='delete-a-transaction-item'> <a href="/books/api/v3/chart-of-accounts/#delete-a-transaction" onclick="toggleAccordionMenu(this)">Delete a transaction</a> </li> </ul> </li> <li class="nested-menu" id='journals-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Journals</a> <ul class='panel -acc-wrapper'> <li class='item journals-overview' id='journals-overview-item'> <a href="/books/api/v3/journals/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-journal' id='create-a-journal-item'> <a href="/books/api/v3/journals/#create-a-journal" onclick="toggleAccordionMenu(this)">Create a journal</a> </li> <li class='item get-journal-list' id='get-journal-list-item'> <a href="/books/api/v3/journals/#get-journal-list" onclick="toggleAccordionMenu(this)">Get journal list</a> </li> <li class='item update-a-journal' id='update-a-journal-item'> <a href="/books/api/v3/journals/#update-a-journal" onclick="toggleAccordionMenu(this)">Update a journal</a> </li> <li class='item get-journal' id='get-journal-item'> <a href="/books/api/v3/journals/#get-journal" onclick="toggleAccordionMenu(this)">Get journal</a> </li> <li class='item delete-a-journal' id='delete-a-journal-item'> <a href="/books/api/v3/journals/#delete-a-journal" onclick="toggleAccordionMenu(this)">Delete a journal</a> </li> <li class='item mark-a-journal-as-published' id='mark-a-journal-as-published-item'> <a href="/books/api/v3/journals/#mark-a-journal-as-published" onclick="toggleAccordionMenu(this)">Mark a journal as published</a> </li> <li class='item add-attachment-to-a-journal' id='add-attachment-to-a-journal-item'> <a href="/books/api/v3/journals/#add-attachment-to-a-journal" onclick="toggleAccordionMenu(this)">Add attachment to a journal</a> </li> <li class='item add-comment' id='add-comment-item'> <a href="/books/api/v3/journals/#add-comment" onclick="toggleAccordionMenu(this)">Add comment</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/journals/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> </ul> </li> <li class="nested-menu" id='fixed-assets-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Fixed Assets</a> <ul class='panel -acc-wrapper'> <li class='item fixed-assets-overview' id='fixed-assets-overview-item'> <a href="/books/api/v3/fixed-assets/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-fixed-asset' id='create-a-fixed-asset-item'> <a href="/books/api/v3/fixed-assets/#create-a-fixed-asset" onclick="toggleAccordionMenu(this)">Create a fixed asset</a> </li> <li class='item get-fixed-asset-list' id='get-fixed-asset-list-item'> <a href="/books/api/v3/fixed-assets/#get-fixed-asset-list" onclick="toggleAccordionMenu(this)">Get fixed asset list</a> </li> <li class='item update-a-fixed-asset' id='update-a-fixed-asset-item'> <a href="/books/api/v3/fixed-assets/#update-a-fixed-asset" onclick="toggleAccordionMenu(this)">Update a fixed asset</a> </li> <li class='item get-fixed-asset' id='get-fixed-asset-item'> <a href="/books/api/v3/fixed-assets/#get-fixed-asset" onclick="toggleAccordionMenu(this)">Get fixed asset</a> </li> <li class='item delete-a-fixed-asset' id='delete-a-fixed-asset-item'> <a href="/books/api/v3/fixed-assets/#delete-a-fixed-asset" onclick="toggleAccordionMenu(this)">Delete a fixed asset</a> </li> <li class='item get-fixed-asset-history' id='get-fixed-asset-history-item'> <a href="/books/api/v3/fixed-assets/#get-fixed-asset-history" onclick="toggleAccordionMenu(this)">Get fixed asset history</a> </li> <li class='item get-fixed-assets-forecast-depreciation' id='get-fixed-assets-forecast-depreciation-item'> <a href="/books/api/v3/fixed-assets/#get-fixed-assets-forecast-depreciation" onclick="toggleAccordionMenu(this)">Get fixed asset's forecast depreciation</a> </li> <li class='item mark-fixed-asset-as-active' id='mark-fixed-asset-as-active-item'> <a href="/books/api/v3/fixed-assets/#mark-fixed-asset-as-active" onclick="toggleAccordionMenu(this)">Mark fixed asset as active</a> </li> <li class='item cancel-fixed-asset' id='cancel-fixed-asset-item'> <a href="/books/api/v3/fixed-assets/#cancel-fixed-asset" onclick="toggleAccordionMenu(this)">Cancel fixed asset</a> </li> <li class='item mark-fixed-asset-as-draft' id='mark-fixed-asset-as-draft-item'> <a href="/books/api/v3/fixed-assets/#mark-fixed-asset-as-draft" onclick="toggleAccordionMenu(this)">Mark fixed asset as draft</a> </li> <li class='item write-off-fixed-asset' id='write-off-fixed-asset-item'> <a href="/books/api/v3/fixed-assets/#write-off-fixed-asset" onclick="toggleAccordionMenu(this)">Write off fixed asset</a> </li> <li class='item sell-fixed-asset' id='sell-fixed-asset-item'> <a href="/books/api/v3/fixed-assets/#sell-fixed-asset" onclick="toggleAccordionMenu(this)">Sell fixed asset</a> </li> <li class='item add-a-comment' id='add-a-comment-item'> <a href="/books/api/v3/fixed-assets/#add-a-comment" onclick="toggleAccordionMenu(this)">Add a comment</a> </li> <li class='item delete-a-comment' id='delete-a-comment-item'> <a href="/books/api/v3/fixed-assets/#delete-a-comment" onclick="toggleAccordionMenu(this)">Delete a comment</a> </li> <li class='item create-a-fixed-asset-type' id='create-a-fixed-asset-type-item'> <a href="/books/api/v3/fixed-assets/#create-a-fixed-asset-type" onclick="toggleAccordionMenu(this)">Create a fixed asset type</a> </li> <li class='item get-fixed-asset-type-list' id='get-fixed-asset-type-list-item'> <a href="/books/api/v3/fixed-assets/#get-fixed-asset-type-list" onclick="toggleAccordionMenu(this)">Get fixed asset type list</a> </li> <li class='item update-a-fixed-asset-type' id='update-a-fixed-asset-type-item'> <a href="/books/api/v3/fixed-assets/#update-a-fixed-asset-type" onclick="toggleAccordionMenu(this)">Update a fixed asset type</a> </li> <li class='item delete-a-fixed-asset-type' id='delete-a-fixed-asset-type-item'> <a href="/books/api/v3/fixed-assets/#delete-a-fixed-asset-type" onclick="toggleAccordionMenu(this)">Delete a fixed asset type</a> </li> </ul> </li> <li class="nested-menu" id='base-currency-adjustment-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Base Currency Adjustment</a> <ul class='panel -acc-wrapper'> <li class='item base-currency-adjustment-overview' id='base-currency-adjustment-overview-item'> <a href="/books/api/v3/base-currency-adjustment/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-base-currency-adjustment' id='create-a-base-currency-adjustment-item'> <a href="/books/api/v3/base-currency-adjustment/#create-a-base-currency-adjustment" onclick="toggleAccordionMenu(this)">Create a base currency adjustment</a> </li> <li class='item list-base-currency-adjustment' id='list-base-currency-adjustment-item'> <a href="/books/api/v3/base-currency-adjustment/#list-base-currency-adjustment" onclick="toggleAccordionMenu(this)">List base currency adjustment</a> </li> <li class='item get-a-base-currency-adjustment' id='get-a-base-currency-adjustment-item'> <a href="/books/api/v3/base-currency-adjustment/#get-a-base-currency-adjustment" onclick="toggleAccordionMenu(this)">Get a base currency adjustment</a> </li> <li class='item delete-a-base-currency-adjustment' id='delete-a-base-currency-adjustment-item'> <a href="/books/api/v3/base-currency-adjustment/#delete-a-base-currency-adjustment" onclick="toggleAccordionMenu(this)">Delete a base currency adjustment</a> </li> <li class='item list-account-details-for-base-currency-adjustment' id='list-account-details-for-base-currency-adjustment-item'> <a href="/books/api/v3/base-currency-adjustment/#list-account-details-for-base-currency-adjustment" onclick="toggleAccordionMenu(this)">List account details for base currency adjustment</a> </li> </ul> </li> <li class="nested-menu" id='projects-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Projects</a> <ul class='panel -acc-wrapper'> <li class='item projects-overview' id='projects-overview-item'> <a href="/books/api/v3/projects/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-project' id='create-a-project-item'> <a href="/books/api/v3/projects/#create-a-project" onclick="toggleAccordionMenu(this)">Create a project</a> </li> <li class='item update-a-project-using-a-custom-fields-unique-value' id='update-a-project-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/projects/#update-a-project-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update a project using a custom field's unique value</a> </li> <li class='item list-projects' id='list-projects-item'> <a href="/books/api/v3/projects/#list-projects" onclick="toggleAccordionMenu(this)">List projects</a> </li> <li class='item update-project' id='update-project-item'> <a href="/books/api/v3/projects/#update-project" onclick="toggleAccordionMenu(this)">Update project</a> </li> <li class='item get-a-project' id='get-a-project-item'> <a href="/books/api/v3/projects/#get-a-project" onclick="toggleAccordionMenu(this)">Get a project</a> </li> <li class='item delete-project' id='delete-project-item'> <a href="/books/api/v3/projects/#delete-project" onclick="toggleAccordionMenu(this)">Delete project</a> </li> <li class='item activate-project' id='activate-project-item'> <a href="/books/api/v3/projects/#activate-project" onclick="toggleAccordionMenu(this)">Activate project</a> </li> <li class='item inactivate-a-project' id='inactivate-a-project-item'> <a href="/books/api/v3/projects/#inactivate-a-project" onclick="toggleAccordionMenu(this)">Inactivate a project</a> </li> <li class='item clone-project' id='clone-project-item'> <a href="/books/api/v3/projects/#clone-project" onclick="toggleAccordionMenu(this)">Clone project</a> </li> <li class='item assign-users' id='assign-users-item'> <a href="/books/api/v3/projects/#assign-users" onclick="toggleAccordionMenu(this)">Assign users</a> </li> <li class='item list-users' id='list-users-item'> <a href="/books/api/v3/projects/#list-users" onclick="toggleAccordionMenu(this)">List Users</a> </li> <li class='item invite-user' id='invite-user-item'> <a href="/books/api/v3/projects/#invite-user" onclick="toggleAccordionMenu(this)">Invite user</a> </li> <li class='item update-user' id='update-user-item'> <a href="/books/api/v3/projects/#update-user" onclick="toggleAccordionMenu(this)">Update user</a> </li> <li class='item get-a-user' id='get-a-user-item'> <a href="/books/api/v3/projects/#get-a-user" onclick="toggleAccordionMenu(this)">Get a User</a> </li> <li class='item delete-user' id='delete-user-item'> <a href="/books/api/v3/projects/#delete-user" onclick="toggleAccordionMenu(this)">Delete user</a> </li> <li class='item post-comment' id='post-comment-item'> <a href="/books/api/v3/projects/#post-comment" onclick="toggleAccordionMenu(this)">Post comment</a> </li> <li class='item list-comments' id='list-comments-item'> <a href="/books/api/v3/projects/#list-comments" onclick="toggleAccordionMenu(this)">List comments</a> </li> <li class='item delete-comment' id='delete-comment-item'> <a href="/books/api/v3/projects/#delete-comment" onclick="toggleAccordionMenu(this)">Delete comment</a> </li> <li class='item list-invoices' id='list-invoices-item'> <a href="/books/api/v3/projects/#list-invoices" onclick="toggleAccordionMenu(this)">List invoices</a> </li> </ul> </li> <li class="nested-menu" id='tasks-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Tasks</a> <ul class='panel -acc-wrapper'> <li class='item tasks-overview' id='tasks-overview-item'> <a href="/books/api/v3/tasks/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item add-a-task' id='add-a-task-item'> <a href="/books/api/v3/tasks/#add-a-task" onclick="toggleAccordionMenu(this)">Add a task</a> </li> <li class='item list-tasks' id='list-tasks-item'> <a href="/books/api/v3/tasks/#list-tasks" onclick="toggleAccordionMenu(this)">List tasks</a> </li> <li class='item update-a-task' id='update-a-task-item'> <a href="/books/api/v3/tasks/#update-a-task" onclick="toggleAccordionMenu(this)">Update a task</a> </li> <li class='item get-a-task' id='get-a-task-item'> <a href="/books/api/v3/tasks/#get-a-task" onclick="toggleAccordionMenu(this)">Get a task</a> </li> <li class='item delete-task' id='delete-task-item'> <a href="/books/api/v3/tasks/#delete-task" onclick="toggleAccordionMenu(this)">Delete Task</a> </li> </ul> </li> <li class="nested-menu" id='time-entries-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Time Entries</a> <ul class='panel -acc-wrapper'> <li class='item time-entries-overview' id='time-entries-overview-item'> <a href="/books/api/v3/time-entries/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item log-time-entries' id='log-time-entries-item'> <a href="/books/api/v3/time-entries/#log-time-entries" onclick="toggleAccordionMenu(this)">Log time entries</a> </li> <li class='item list-time-entries' id='list-time-entries-item'> <a href="/books/api/v3/time-entries/#list-time-entries" onclick="toggleAccordionMenu(this)">List time entries.</a> </li> <li class='item delete-time-entries' id='delete-time-entries-item'> <a href="/books/api/v3/time-entries/#delete-time-entries" onclick="toggleAccordionMenu(this)">Delete time entries</a> </li> <li class='item update-time-entry' id='update-time-entry-item'> <a href="/books/api/v3/time-entries/#update-time-entry" onclick="toggleAccordionMenu(this)">Update time entry</a> </li> <li class='item get-a-time-entry' id='get-a-time-entry-item'> <a href="/books/api/v3/time-entries/#get-a-time-entry" onclick="toggleAccordionMenu(this)">Get a time entry</a> </li> <li class='item delete-time-entry' id='delete-time-entry-item'> <a href="/books/api/v3/time-entries/#delete-time-entry" onclick="toggleAccordionMenu(this)">Delete time entry</a> </li> <li class='item start-timer' id='start-timer-item'> <a href="/books/api/v3/time-entries/#start-timer" onclick="toggleAccordionMenu(this)">Start timer</a> </li> <li class='item stop-timer' id='stop-timer-item'> <a href="/books/api/v3/time-entries/#stop-timer" onclick="toggleAccordionMenu(this)">Stop timer</a> </li> <li class='item get-timer' id='get-timer-item'> <a href="/books/api/v3/time-entries/#get-timer" onclick="toggleAccordionMenu(this)">Get timer</a> </li> </ul> </li> <li class="nested-menu" id='users-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Users</a> <ul class='panel -acc-wrapper'> <li class='item users-overview' id='users-overview-item'> <a href="/books/api/v3/users/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-user' id='create-a-user-item'> <a href="/books/api/v3/users/#create-a-user" onclick="toggleAccordionMenu(this)">Create a user</a> </li> <li class='item list-users' id='list-users-item'> <a href="/books/api/v3/users/#list-users" onclick="toggleAccordionMenu(this)">List Users</a> </li> <li class='item update-a-user' id='update-a-user-item'> <a href="/books/api/v3/users/#update-a-user" onclick="toggleAccordionMenu(this)">Update a user</a> </li> <li class='item get-a-user' id='get-a-user-item'> <a href="/books/api/v3/users/#get-a-user" onclick="toggleAccordionMenu(this)">Get a user</a> </li> <li class='item delete-a-user' id='delete-a-user-item'> <a href="/books/api/v3/users/#delete-a-user" onclick="toggleAccordionMenu(this)">Delete a user</a> </li> <li class='item get-current-user' id='get-current-user-item'> <a href="/books/api/v3/users/#get-current-user" onclick="toggleAccordionMenu(this)">Get current user</a> </li> <li class='item invite-a-user' id='invite-a-user-item'> <a href="/books/api/v3/users/#invite-a-user" onclick="toggleAccordionMenu(this)">Invite a user</a> </li> <li class='item mark-user-as-active' id='mark-user-as-active-item'> <a href="/books/api/v3/users/#mark-user-as-active" onclick="toggleAccordionMenu(this)">Mark user as active</a> </li> <li class='item mark-user-as-inactive' id='mark-user-as-inactive-item'> <a href="/books/api/v3/users/#mark-user-as-inactive" onclick="toggleAccordionMenu(this)">Mark user as inactive</a> </li> </ul> </li> <li class="nested-menu" id='items-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Items</a> <ul class='panel -acc-wrapper'> <li class='item items-overview' id='items-overview-item'> <a href="/books/api/v3/items/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-an-item' id='create-an-item-item'> <a href="/books/api/v3/items/#create-an-item" onclick="toggleAccordionMenu(this)">Create an Item</a> </li> <li class='item update-an-item-using-a-custom-fields-unique-value' id='update-an-item-using-a-custom-fields-unique-value-item'> <a href="/books/api/v3/items/#update-an-item-using-a-custom-fields-unique-value" onclick="toggleAccordionMenu(this)">Update an item using a custom field's unique value</a> </li> <li class='item list-items' id='list-items-item'> <a href="/books/api/v3/items/#list-items" onclick="toggleAccordionMenu(this)">List items</a> </li> <li class='item update-an-item' id='update-an-item-item'> <a href="/books/api/v3/items/#update-an-item" onclick="toggleAccordionMenu(this)">Update an item</a> </li> <li class='item get-an-item' id='get-an-item-item'> <a href="/books/api/v3/items/#get-an-item" onclick="toggleAccordionMenu(this)">Get an item</a> </li> <li class='item delete-an-item' id='delete-an-item-item'> <a href="/books/api/v3/items/#delete-an-item" onclick="toggleAccordionMenu(this)">Delete an item</a> </li> <li class='item update-custom-field-in-existing-items' id='update-custom-field-in-existing-items-item'> <a href="/books/api/v3/items/#update-custom-field-in-existing-items" onclick="toggleAccordionMenu(this)">Update custom field in existing items</a> </li> <li class='item mark-as-active' id='mark-as-active-item'> <a href="/books/api/v3/items/#mark-as-active" onclick="toggleAccordionMenu(this)">Mark as active</a> </li> <li class='item mark-as-inactive' id='mark-as-inactive-item'> <a href="/books/api/v3/items/#mark-as-inactive" onclick="toggleAccordionMenu(this)">Mark as inactive</a> </li> </ul> </li> <li class="nested-menu" id='currency-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Currency</a> <ul class='panel -acc-wrapper'> <li class='item currency-overview' id='currency-overview-item'> <a href="/books/api/v3/currency/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-currency' id='create-a-currency-item'> <a href="/books/api/v3/currency/#create-a-currency" onclick="toggleAccordionMenu(this)">Create a Currency</a> </li> <li class='item list-currencies' id='list-currencies-item'> <a href="/books/api/v3/currency/#list-currencies" onclick="toggleAccordionMenu(this)">List Currencies</a> </li> <li class='item update-a-currency' id='update-a-currency-item'> <a href="/books/api/v3/currency/#update-a-currency" onclick="toggleAccordionMenu(this)">Update a Currency</a> </li> <li class='item get-a-currency' id='get-a-currency-item'> <a href="/books/api/v3/currency/#get-a-currency" onclick="toggleAccordionMenu(this)">Get a Currency</a> </li> <li class='item delete-a-currency' id='delete-a-currency-item'> <a href="/books/api/v3/currency/#delete-a-currency" onclick="toggleAccordionMenu(this)">Delete a currency</a> </li> <li class='item create-an-exchange-rate' id='create-an-exchange-rate-item'> <a href="/books/api/v3/currency/#create-an-exchange-rate" onclick="toggleAccordionMenu(this)">Create an exchange rate</a> </li> <li class='item list-exchange-rates' id='list-exchange-rates-item'> <a href="/books/api/v3/currency/#list-exchange-rates" onclick="toggleAccordionMenu(this)">List exchange rates</a> </li> <li class='item update-an-exchange-rate' id='update-an-exchange-rate-item'> <a href="/books/api/v3/currency/#update-an-exchange-rate" onclick="toggleAccordionMenu(this)">Update an exchange rate</a> </li> <li class='item get-an-exchange-rate' id='get-an-exchange-rate-item'> <a href="/books/api/v3/currency/#get-an-exchange-rate" onclick="toggleAccordionMenu(this)">Get an exchange rate.</a> </li> <li class='item delete-an-exchage-rate' id='delete-an-exchage-rate-item'> <a href="/books/api/v3/currency/#delete-an-exchage-rate" onclick="toggleAccordionMenu(this)">Delete an exchage rate</a> </li> </ul> </li> <li class="nested-menu" id='taxes-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Taxes</a> <ul class='panel -acc-wrapper'> <li class='item taxes-overview' id='taxes-overview-item'> <a href="/books/api/v3/taxes/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-a-tax' id='create-a-tax-item'> <a href="/books/api/v3/taxes/#create-a-tax" onclick="toggleAccordionMenu(this)">Create a tax</a> </li> <li class='item list-taxes' id='list-taxes-item'> <a href="/books/api/v3/taxes/#list-taxes" onclick="toggleAccordionMenu(this)">List taxes</a> </li> <li class='item update-a-tax' id='update-a-tax-item'> <a href="/books/api/v3/taxes/#update-a-tax" onclick="toggleAccordionMenu(this)">Update a tax</a> </li> <li class='item get-a-tax' id='get-a-tax-item'> <a href="/books/api/v3/taxes/#get-a-tax" onclick="toggleAccordionMenu(this)">Get a tax</a> </li> <li class='item delete-a-tax' id='delete-a-tax-item'> <a href="/books/api/v3/taxes/#delete-a-tax" onclick="toggleAccordionMenu(this)">Delete a tax</a> </li> <li class='item update-a-tax-group' id='update-a-tax-group-item'> <a href="/books/api/v3/taxes/#update-a-tax-group" onclick="toggleAccordionMenu(this)">Update a tax group</a> </li> <li class='item get-a-tax-group' id='get-a-tax-group-item'> <a href="/books/api/v3/taxes/#get-a-tax-group" onclick="toggleAccordionMenu(this)">Get a tax group</a> </li> <li class='item delete-a-tax-group' id='delete-a-tax-group-item'> <a href="/books/api/v3/taxes/#delete-a-tax-group" onclick="toggleAccordionMenu(this)">Delete a tax group</a> </li> <li class='item create-a-tax-group' id='create-a-tax-group-item'> <a href="/books/api/v3/taxes/#create-a-tax-group" onclick="toggleAccordionMenu(this)">Create a tax group</a> </li> <li class='item create-a-tax-authority-us-and-ca-edition-only' id='create-a-tax-authority-us-and-ca-edition-only-item'> <a href="/books/api/v3/taxes/#create-a-tax-authority-us-and-ca-edition-only" onclick="toggleAccordionMenu(this)">Create a tax authority [US and CA Edition only]</a> </li> <li class='item list-tax-authorities-us-edition-only' id='list-tax-authorities-us-edition-only-item'> <a href="/books/api/v3/taxes/#list-tax-authorities-us-edition-only" onclick="toggleAccordionMenu(this)">List tax authorities [US Edition only]</a> </li> <li class='item update-a-tax-authority-us-and-ca-edition-only' id='update-a-tax-authority-us-and-ca-edition-only-item'> <a href="/books/api/v3/taxes/#update-a-tax-authority-us-and-ca-edition-only" onclick="toggleAccordionMenu(this)">Update a tax authority [US and CA Edition only]</a> </li> <li class='item get-a-tax-authority-us-and-ca-edition-only' id='get-a-tax-authority-us-and-ca-edition-only-item'> <a href="/books/api/v3/taxes/#get-a-tax-authority-us-and-ca-edition-only" onclick="toggleAccordionMenu(this)">Get a tax authority [US and CA Edition only]</a> </li> <li class='item delete-a-tax-authority-us-and-ca-edition-only' id='delete-a-tax-authority-us-and-ca-edition-only-item'> <a href="/books/api/v3/taxes/#delete-a-tax-authority-us-and-ca-edition-only" onclick="toggleAccordionMenu(this)">Delete a tax authority [US and CA Edition only]</a> </li> <li class='item create-a-tax-exemption-us-edition-only' id='create-a-tax-exemption-us-edition-only-item'> <a href="/books/api/v3/taxes/#create-a-tax-exemption-us-edition-only" onclick="toggleAccordionMenu(this)">Create a tax exemption [US Edition only]</a> </li> <li class='item list-tax-exemptions-us-edition-only' id='list-tax-exemptions-us-edition-only-item'> <a href="/books/api/v3/taxes/#list-tax-exemptions-us-edition-only" onclick="toggleAccordionMenu(this)">List tax exemptions [US Edition only]</a> </li> <li class='item update-a-tax-exemption-us-edition-only' id='update-a-tax-exemption-us-edition-only-item'> <a href="/books/api/v3/taxes/#update-a-tax-exemption-us-edition-only" onclick="toggleAccordionMenu(this)">Update a tax exemption [US Edition only]</a> </li> <li class='item get-a-tax-exemption-us-edition-only' id='get-a-tax-exemption-us-edition-only-item'> <a href="/books/api/v3/taxes/#get-a-tax-exemption-us-edition-only" onclick="toggleAccordionMenu(this)">Get a tax exemption [US Edition only]</a> </li> <li class='item delete-a-tax-exemption-us-edition-only' id='delete-a-tax-exemption-us-edition-only-item'> <a href="/books/api/v3/taxes/#delete-a-tax-exemption-us-edition-only" onclick="toggleAccordionMenu(this)">Delete a tax exemption [US Edition only]</a> </li> </ul> </li> <li class="nested-menu" id='opening-balance-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >Opening Balance</a> <ul class='panel -acc-wrapper'> <li class='item opening-balance-overview' id='opening-balance-overview-item'> <a href="/books/api/v3/opening-balance/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item create-opening-balance' id='create-opening-balance-item'> <a href="/books/api/v3/opening-balance/#create-opening-balance" onclick="toggleAccordionMenu(this)">Create opening balance</a> </li> <li class='item update-opening-balance' id='update-opening-balance-item'> <a href="/books/api/v3/opening-balance/#update-opening-balance" onclick="toggleAccordionMenu(this)">Update opening balance</a> </li> <li class='item get-opening-balance' id='get-opening-balance-item'> <a href="/books/api/v3/opening-balance/#get-opening-balance" onclick="toggleAccordionMenu(this)">Get opening balance</a> </li> <li class='item delete-opening-balance' id='delete-opening-balance-item'> <a href="/books/api/v3/opening-balance/#delete-opening-balance" onclick="toggleAccordionMenu(this)">Delete opening balance</a> </li> </ul> </li> <li class="nested-menu" id='integration-menu'> <a class="accordian" onclick="registerAccordionClick(this)" >ZOHO CRM Integration</a> <ul class='panel -acc-wrapper'> <li class='item integration-overview' id='integration-overview-item'> <a href="/books/api/v3/integration/#overview" onclick="toggleAccordionMenu(this)">Overview</a> </li> <li class='item import-a-customer-using-the-crm-account-id' id='import-a-customer-using-the-crm-account-id-item'> <a href="/books/api/v3/integration/#import-a-customer-using-the-crm-account-id" onclick="toggleAccordionMenu(this)">Import a customer using the CRM account ID</a> </li> <li class='item import-a-customer-using-crm-contact-id' id='import-a-customer-using-crm-contact-id-item'> <a href="/books/api/v3/integration/#import-a-customer-using-crm-contact-id" onclick="toggleAccordionMenu(this)">Import a customer using CRM contact ID</a> </li> <li class='item import-a-vendor-using-the-crm-vendor-id' id='import-a-vendor-using-the-crm-vendor-id-item'> <a href="/books/api/v3/integration/#import-a-vendor-using-the-crm-vendor-id" onclick="toggleAccordionMenu(this)">Import a vendor using the CRM vendor ID</a> </li> </ul> </li> </ul> </div> </div> <div class="page-wrapper" id='page-wrapper'> <div class="content"> <div class="wrapper module-section"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h1 id="retainer-invoices-overview" class="scroll-observer pt-70">Retainer Invoices</h1> <p>A lot of businesses collect an advance payment (or retainer) for products sold or services rendered by them. This amount collected will not be an income but a liability to the company. The revenue is earned only when the product is delivered or the service is completed, if not delivered or completed the advance payment made will be returned to the customer. </p> </div> <div class="flex-wrapper-right endpoints-top pt-70"> <div class="endpoints-wrapper "> <div class="endpoints-header"> End Points </div> <div class="endpoints-innerwrapper"> <span role="tooltip" class="tooltip tooltip-content">Create a retainerinvoice <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#create-a-retainerinvoice" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">List a retainer invoices <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#list-a-retainer-invoices" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method get"> GET    </div> <div class="endpoints-bottom-text-url">/retainerinvoices</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">update a retainerinvoice <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#update-a-retainerinvoice" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method put"> PUT    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Get a retainer invoice <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#get-a-retainer-invoice" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method get"> GET    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Delete a retainer invoice <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#delete-a-retainer-invoice" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method delete"> DELETE </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Mark a retainer invoice as sent <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#mark-a-retainer-invoice-as-sent" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/status/sent</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Update retainer invoice template <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#update-retainer-invoice-template" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method put"> PUT    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/templates/{template_id}</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Void a retainer invoice <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#void-a-retainer-invoice" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/status/void</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Mark as draft <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#mark-as-draft" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{reatinerinvoice_id}/status/draft</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Submit a retainer invoice for approval <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#submit-a-retainer-invoice-for-approval" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{reatinerinvoice_id}/submit</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Approve a retainer invoice. <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#approve-a-retainer-invoice" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{reatinerinvoice_id}/approve</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Email a retainer invoice <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#email-a-retainer-invoice" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/email</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Get retainer invoice email content <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#get-retainer-invoice-email-content" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method get"> GET    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/email</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Update billing address <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#update-billing-address" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method put"> PUT    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/address/billing</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">List retainer invoice templates <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#list-retainer-invoice-templates" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method get"> GET    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/templates</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Add attachment to a retainer invoice <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#add-attachment-to-a-retainer-invoice" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/attachment</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Get a retainer invoice attachment <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#get-a-retainer-invoice-attachment" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method get"> GET    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/attachment</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Delete an attachment <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#delete-an-attachment" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method delete"> DELETE </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/documents/{document_id}</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Add comment <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#add-comment" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method post"> POST   </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/comments</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">List retainer invoice comments & history <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#list-retainer-invoice-comments-and-history" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method get"> GET    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/comments</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Update comment <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#update-comment" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method put"> PUT    </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/comments/{comment_id}</div> </div> </div> </a> </div> <span role="tooltip" class="tooltip tooltip-content">Delete a comment <div class="arrow" data-popper-arrow></div> </span> <div style="display: flex;"> <a href="/books/api/v3/retainer-invoices/#delete-a-comment" onclick="toggleAccordionMenu(this)" style="word-break:none;"> <div class="endpoints content" style="display: flex;"> <div class="endpoints-content"> <div class="endpoints-bottom-text-method delete"> DELETE </div> <div class="endpoints-bottom-text-url">/retainerinvoices/{retainerinvoice_id}/comments/{comment_id}</div> </div> </div> </a> </div> </div> </div> </div> </div> </div> <div class="attribute-section"> <div class="flex-wrapper-left"> <h3 id="attributes" class="properties"> Attribute </h3> <div class="parameter"> <div class="row" id=overview-retainerinvoice_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> retainerinvoice_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">ID of the retainerinvoice</div> </div> </div> <div class="row" id=overview-retainerinvoice_number> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> retainerinvoice_number </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">number of the retainer invoice.Variants: <code>retainerinvoice_number_startswith</code> and <code>retainerinvoice_number_contains</code>. Max-length [100]</div> </div> </div> <div class="row" id=overview-date> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> date </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The date of creation of the retainer invoice.</div> </div> </div> <div class="row" id=overview-status> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> status </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">retainer invoice status.Allowed Values: <code>sent</code>, <code>draft</code>, <code>overdue</code>, <code>paid</code>, <code>void</code>, <code>unpaid</code>, <code>partially_paid</code> and <code>viewed</code></div> </div> </div> <div class="row" id=overview-is_pre_gst> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> is_pre_gst </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Applicable for transactions that fall before july 1, 2017</div> </div> </div> <div class="row" id=overview-place_of_supply> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> place_of_supply </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> <div class='red'> <span class="availability-info-wrapper">馃嚠馃嚦 <span role="tooltip" class="tooltip infoText"> India <div class="arrow" data-popper-arrow></div> </span> </span> <span>only</span> </div> </div> <div class="prop-descrip">Place where the goods/services are supplied to. (If not given, <code>place of contact</code> given for the contact will be taken)</div> </div> </div> <div class="row" id=overview-project_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> project_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">ID of the project</div> </div> </div> <div class="row" id=overview-project_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> project_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Name of the project</div> </div> </div> <div class="row" id=overview-last_payment_date> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> last_payment_date </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The last payment date of the retainer invoice</div> </div> </div> <div class="row" id=overview-reference_number> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> reference_number </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The reference number of the retainer invoice. Max-length [100]</div> </div> </div> <div class="row" id=overview-customer_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> customer_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">ID of the customer the retainer invoice has to be created.</div> </div> </div> <div class="row" id=overview-customer_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> customer_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The name of the customer. Max-length [100]</div> </div> </div> <div class="row" id=overview-contact_persons> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> contact_persons </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-currency_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> currency_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The currenct id of the currency</div> </div> </div> <div class="row" id=overview-currency_code> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> currency_code </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The currency code in which the retainer invoice is created.</div> </div> </div> <div class="row" id=overview-currency_symbol> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> currency_symbol </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The currency symbol in which the retainer invoice is created.</div> </div> </div> <div class="row" id=overview-exchange_rate> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> exchange_rate </div> <div class="property-datatype"> float </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Exchange rate of the currency.</div> </div> </div> <div class="row" id=overview-is_viewed_by_client> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> is_viewed_by_client </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean is retainer invoice viewed by client in client portal.</div> </div> </div> <div class="row" id=overview-client_viewed_time> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> client_viewed_time </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">client viewed time for retainer invoice in client portal.</div> </div> </div> <div class="row" id=overview-is_inclusive_tax> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> is_inclusive_tax </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-line_items> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> line_items </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Line items of a retainer invoice.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=overview-line_items-line_item_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> line_item_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The line item id</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-description> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> description </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The description of the line items. Max-length [2000]</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-item_order> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> item_order </div> <div class="property-datatype"> integer </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The order of the line item_order</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-rate> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> rate </div> <div class="property-datatype"> double </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Rate of the line item.</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-bcy_rate> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> bcy_rate </div> <div class="property-datatype"> float </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">base currency rate</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-tax_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> tax_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">ID of the tax or tax group applied to the estimate</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-tax_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> tax_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The name of the tax</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-tax_type> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> tax_type </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The type of the tax</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-tax_percentage> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> tax_percentage </div> <div class="property-datatype"> float </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The percentage of tax levied</div> </div> </div> <div class="row attribute small-line" id=overview-line_items-item_total> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> item_total </div> <div class="property-datatype"> float </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The total amount of the line items</div> </div> </div> </div> </details> </div> </div> <div class="row" id=overview-sub_total> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> sub_total </div> <div class="property-datatype"> float </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The sub total of the all items</div> </div> </div> <div class="row" id=overview-total> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> total </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The total amount to be paid</div> </div> </div> <div class="row" id=overview-taxes> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> taxes </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">List of the taxes levied</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=overview-taxes-tax_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> tax_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The name of the tax</div> </div> </div> <div class="row attribute small-line" id=overview-taxes-tax_amount> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> tax_amount </div> <div class="property-datatype"> float </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The amount of the tax levied</div> </div> </div> </div> </details> </div> </div> <div class="row" id=overview-payment_made> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_made </div> <div class="property-datatype"> float </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The amount paid</div> </div> </div> <div class="row" id=overview-payment_drawn> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_drawn </div> <div class="property-datatype"> float </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The amount drawn</div> </div> </div> <div class="row" id=overview-balance> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> balance </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The unpaid amount</div> </div> </div> <div class="row" id=overview-allow_partial_payments> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> allow_partial_payments </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean to check if partial payments are allowed for the contact</div> </div> </div> <div class="row" id=overview-price_precision> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> price_precision </div> <div class="property-datatype"> integer </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The precision value on the price</div> </div> </div> <div class="row" id=overview-payment_options> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_options </div> <div class="property-datatype"> object </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Payment options for the retainer invoice, online payment gateways and bank accounts. Will be displayed in the pdf.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=overview-payment_options-payment_gateways> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_gateways </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Online payment gateways through which payment can be made.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=nested-attribute-wrapper> <div class="row attribute small-line" id=overview-payment_options-payment_gateways-configured> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> configured </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean check to see if a payment gateway ahs been configured</div> </div> </div> <div class="row attribute small-line" id=overview-payment_options-payment_gateways-additional_field1> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> additional_field1 </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Paypal payment method. Allowed Values: <code>standard</code> and <code>adaptive</code></div> </div> </div> <div class="row attribute small-line" id=overview-payment_options-payment_gateways-gateway_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> gateway_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Name of the payment gateway associated with the retainer invoice. E.g. paypal, stripe.Allowed Values: <code>paypal</code>, <code>authorize_net</code>, <code>payflow_pro</code>, <code>stripe</code>, <code>2checkout</code> and <code>braintree</code></div> </div> </div> </div> </details> </div> </div> </div> </details> </div> </div> <div class="row" id=overview-is_emailed> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> is_emailed </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean check to if the email was sent</div> </div> </div> <div class="row" id=overview-documents> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> documents </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">documents attached to the retainer invoice</div> </div> </div> <div class="row" id=overview-billing_address> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> billing_address </div> <div class="property-datatype"> object </div> <div class="property-kind" id="Optional"> </div> </div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=overview-billing_address-address> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> address </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-billing_address-street2> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> street2 </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-billing_address-city> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> city </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-billing_address-state> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> state </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-billing_address-zip> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> zip </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-billing_address-country> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> country </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-billing_address-fax> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> fax </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> </div> </details> </div> </div> <div class="row" id=overview-shipping_address> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> shipping_address </div> <div class="property-datatype"> object </div> <div class="property-kind" id="Optional"> </div> </div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=overview-shipping_address-address> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> address </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-shipping_address-city> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> city </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-shipping_address-state> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> state </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-shipping_address-zip> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> zip </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-shipping_address-country> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> country </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-shipping_address-fax> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> fax </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> </div> </details> </div> </div> <div class="row" id=overview-notes> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> notes </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The notes added below expressing gratitude or for conveying some information.</div> </div> </div> <div class="row" id=overview-terms> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> terms </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The terms added below expressing gratitude or for conveying some information.</div> </div> </div> <div class="row" id=overview-custom_fields> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> custom_fields </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Custom fields for a reatiner invoice.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=overview-custom_fields-index> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> index </div> <div class="property-datatype"> integer </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The index of the custom field</div> </div> </div> <div class="row attribute small-line" id=overview-custom_fields-show_on_pdf> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> show_on_pdf </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean value to check if the custom field is to be dispplayed on the pdf.</div> </div> </div> <div class="row attribute small-line" id=overview-custom_fields-value> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> value </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=overview-custom_fields-label> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> label </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The label of the custom field.</div> </div> </div> </div> </details> </div> </div> <div class="row" id=overview-template_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> template_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">ID of the pdf template associated with the retainer invoice.</div> </div> </div> <div class="row" id=overview-template_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> template_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-page_width> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> page_width </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-page_height> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> page_height </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-orientation> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> orientation </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-template_type> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> template_type </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The type of template type</div> </div> </div> <div class="row" id=overview-created_time> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> created_time </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The time of creation of the retainer invoice</div> </div> </div> <div class="row" id=overview-last_modified_time> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> last_modified_time </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The time of last modification of the retainer invoice</div> </div> </div> <div class="row" id=overview-created_by_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> created_by_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-attachment_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> attachment_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-can_send_in_mail> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> can_send_in_mail </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=overview-invoice_url> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> invoice_url </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> </div> </div> <div class="flex-wrapper-right"> <div class="attributeheader"> <p class="response-topbar header-example"> Example </p> <div class="codebag" data-simplebar> <div class="example"> <code><span class="token punctuation">{</span> <span class="token property">"retainerinvoice_id"</span><span class="token operator">:</span> <span class="token number">982000000567114</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice_number"</span><span class="token operator">:</span> <span class="token string">"RET-00003"</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"draft"</span><span class="token punctuation">,</span> <span class="token property">"is_pre_gst"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"place_of_supply"</span><span class="token operator">:</span> <span class="token string">"TN"</span><span class="token punctuation">,</span> <span class="token property">"project_id"</span><span class="token operator">:</span> <span class="token number">982000000567154</span><span class="token punctuation">,</span> <span class="token property">"project_name"</span><span class="token operator">:</span> <span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"last_payment_date"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"reference_number"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token number">982000000567001</span><span class="token punctuation">,</span> <span class="token property">"customer_name"</span><span class="token operator">:</span> <span class="token string">"Bowman & Co"</span><span class="token punctuation">,</span> <span class="token property">"contact_persons"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"982000000567003"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"currency_id"</span><span class="token operator">:</span> <span class="token number">982000000000190</span><span class="token punctuation">,</span> <span class="token property">"currency_code"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"currency_symbol"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"exchange_rate"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"is_viewed_by_client"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"client_viewed_time"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"is_inclusive_tax"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"line_items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"line_item_id"</span><span class="token operator">:</span> <span class="token number">982000000567021</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"500GB, USB 2.0 interface 1400 rpm, protective hard case."</span><span class="token punctuation">,</span> <span class="token property">"item_order"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"rate"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"bcy_rate"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"tax_id"</span><span class="token operator">:</span> <span class="token number">982000000557028</span><span class="token punctuation">,</span> <span class="token property">"tax_name"</span><span class="token operator">:</span> <span class="token string">"VAT"</span><span class="token punctuation">,</span> <span class="token property">"tax_type"</span><span class="token operator">:</span> <span class="token string">"tax"</span><span class="token punctuation">,</span> <span class="token property">"tax_percentage"</span><span class="token operator">:</span> <span class="token number">12.5</span><span class="token punctuation">,</span> <span class="token property">"item_total"</span><span class="token operator">:</span> <span class="token number">120</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"sub_total"</span><span class="token operator">:</span> <span class="token number">153</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"taxes"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"tax_name"</span><span class="token operator">:</span> <span class="token string">"VAT"</span><span class="token punctuation">,</span> <span class="token property">"tax_amount"</span><span class="token operator">:</span> <span class="token number">19.13</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"payment_made"</span><span class="token operator">:</span> <span class="token number">26.91</span><span class="token punctuation">,</span> <span class="token property">"payment_drawn"</span><span class="token operator">:</span> <span class="token number">26.91</span><span class="token punctuation">,</span> <span class="token property">"balance"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"allow_partial_payments"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"price_precision"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"payment_options"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"payment_gateways"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"configured"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"additional_field1"</span><span class="token operator">:</span> <span class="token string">"standard"</span><span class="token punctuation">,</span> <span class="token property">"gateway_name"</span><span class="token operator">:</span> <span class="token string">"paypal"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"is_emailed"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"documents"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"billing_address"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Suite 125, McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"street2"</span><span class="token operator">:</span> <span class="token string">"McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"San Francisco"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"CA"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">94134</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"U.S.A"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"shipping_address"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Suite 125, McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"San Francisco"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"CA"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">94134</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"U.S.A"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"notes"</span><span class="token operator">:</span> <span class="token string">"Looking forward for your business."</span><span class="token punctuation">,</span> <span class="token property">"terms"</span><span class="token operator">:</span> <span class="token string">"Terms & Conditions apply"</span><span class="token punctuation">,</span> <span class="token property">"custom_fields"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"index"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"show_on_pdf"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"The value of the custom field"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"Delivery Date"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"template_id"</span><span class="token operator">:</span> <span class="token number">982000000000143</span><span class="token punctuation">,</span> <span class="token property">"template_name"</span><span class="token operator">:</span> <span class="token string">"Service - Classic"</span><span class="token punctuation">,</span> <span class="token property">"page_width"</span><span class="token operator">:</span> <span class="token string">"8.27in"</span><span class="token punctuation">,</span> <span class="token property">"page_height"</span><span class="token operator">:</span> <span class="token string">"11.69in"</span><span class="token punctuation">,</span> <span class="token property">"orientation"</span><span class="token operator">:</span> <span class="token string">"portrait"</span><span class="token punctuation">,</span> <span class="token property">"template_type"</span><span class="token operator">:</span> <span class="token string">"classic"</span><span class="token punctuation">,</span> <span class="token property">"created_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"last_modified_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"created_by_id"</span><span class="token operator">:</span> <span class="token number">14909000000072000</span><span class="token punctuation">,</span> <span class="token property">"attachment_name"</span><span class="token operator">:</span> <span class="token string">"new file"</span><span class="token punctuation">,</span> <span class="token property">"can_send_in_mail"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"invoice_url"</span><span class="token operator">:</span> <span class="token string">"https://invoice.zoho.com/SecurePayment?CInvoiceID=23d84d0cf64f9a72ea0c66fded25a08c8bafd0ab508aff05323a9f80e2cd03fdc5dd568d3d6407bbda969d3e870d740b6fce549a9438c4ea"</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="create-a-retainerinvoice" class="scroll-observer pt-70">Create a retainerinvoice</h2> <p> Create a retainer invoice for your customer. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> <h3 id="arguments" class="properties"> Arguments </h3> <div class="parameter"> <div class="row" id=create-a-retainerinvoice-customer_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> customer_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Required"> (Required) </div> </div> <div class="prop-descrip">ID of the customer the retainer invoice has to be created.</div> </div> </div> <div class="row" id=create-a-retainerinvoice-reference_number> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> reference_number </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The reference number of the retainer invoice. Max-length [100]</div> </div> </div> <div class="row" id=create-a-retainerinvoice-date> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> date </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The date of creation of the retainer invoice.</div> </div> </div> <div class="row" id=create-a-retainerinvoice-contact_persons> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> contact_persons </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=create-a-retainerinvoice-custom_fields> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> custom_fields </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Custom fields for a reatiner invoice.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=create-a-retainerinvoice-custom_fields-index> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> index </div> <div class="property-datatype"> integer </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The index of the custom field</div> </div> </div> <div class="row attribute small-line" id=create-a-retainerinvoice-custom_fields-show_on_pdf> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> show_on_pdf </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean value to check if the custom field is to be dispplayed on the pdf.</div> </div> </div> <div class="row attribute small-line" id=create-a-retainerinvoice-custom_fields-value> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> value </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=create-a-retainerinvoice-custom_fields-label> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> label </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The label of the custom field.</div> </div> </div> </div> </details> </div> </div> <div class="row" id=create-a-retainerinvoice-notes> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> notes </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The notes added below expressing gratitude or for conveying some information.</div> </div> </div> <div class="row" id=create-a-retainerinvoice-terms> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> terms </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The terms added below expressing gratitude or for conveying some information.</div> </div> </div> <div class="row" id=create-a-retainerinvoice-line_items> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> line_items </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Required"> (Required) </div> </div> <div class="prop-descrip">Line items of an invoice.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=create-a-retainerinvoice-line_items-description> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> description </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The description of the line items. Max-length [2000]</div> </div> </div> <div class="row attribute small-line" id=create-a-retainerinvoice-line_items-item_order> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> item_order </div> <div class="property-datatype"> integer </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The order of the line item_order</div> </div> </div> <div class="row attribute small-line" id=create-a-retainerinvoice-line_items-rate> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> rate </div> <div class="property-datatype"> double </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Rate of the line item.</div> </div> </div> </div> </details> </div> </div> <div class="row" id=create-a-retainerinvoice-payment_options> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_options </div> <div class="property-datatype"> object </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Payment options for the retainer invoice, online payment gateways and bank accounts. Will be displayed in the pdf.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=create-a-retainerinvoice-payment_options-payment_gateways> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_gateways </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Online payment gateways through which payment can be made.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=nested-attribute-wrapper> <div class="row attribute small-line" id=create-a-retainerinvoice-payment_options-payment_gateways-configured> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> configured </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean check to see if a payment gateway ahs been configured</div> </div> </div> <div class="row attribute small-line" id=create-a-retainerinvoice-payment_options-payment_gateways-additional_field1> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> additional_field1 </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Paypal payment method. Allowed Values: <code>standard</code> and <code>adaptive</code></div> </div> </div> <div class="row attribute small-line" id=create-a-retainerinvoice-payment_options-payment_gateways-gateway_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> gateway_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Name of the payment gateway associated with the retainer invoice. E.g. paypal, stripe.Allowed Values: <code>paypal</code>, <code>authorize_net</code>, <code>payflow_pro</code>, <code>stripe</code>, <code>2checkout</code> and <code>braintree</code></div> </div> </div> </div> </details> </div> </div> </div> </details> </div> </div> <div class="row" id=create-a-retainerinvoice-template_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> template_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">ID of the pdf template associated with the retainer invoice.</div> </div> </div> <div class="row" id=create-a-retainerinvoice-place_of_supply> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> place_of_supply </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> <div class='red'> <span class="availability-info-wrapper">馃嚠馃嚦 <span role="tooltip" class="tooltip infoText"> India <div class="arrow" data-popper-arrow></div> </span> </span> <span>only</span> </div> </div> <div class="prop-descrip">Place where the goods/services are supplied to. (If not given, <code>place of contact</code> given for the contact will be taken)</div> </div> </div> </div> <h3 id="queryparams" class="properties"> Query Parameters </h3> <div class="parameter"> <div class="row" id=create-a-retainerinvoice-ignore_auto_number_generation> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> ignore_auto_number_generation </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Ignore auto invoice number generation for this invoice. This mandates the invoice number. Allowed values <code>true</code> and <code>false</code></div> </div> </div> </div> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_create-a-retainerinvoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_create-a-retainerinvoice">parameters_data<span class="token operator">=</span><span class="token string">'{"field1":"value1","field2":"value2"}'</span><span class="token punctuation">;</span> headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">content-type</span><span class="token punctuation">:</span> application<span class="token operator">/</span>json <span class="token property">parameters</span><span class="token punctuation">:</span> parameters_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_create-a-retainerinvoice"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">MediaType</span> mediaType <span class="token operator">=</span> <span class="token class-name">MediaType</span><span class="token punctuation">.</span><span class="token function">parse</span><span class="token punctuation">(</span><span class="token string">"application/json"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">RequestBody</span> body <span class="token operator">=</span> <span class="token class-name">RequestBody</span><span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>mediaType<span class="token punctuation">,</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span>body<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"content-type"</span><span class="token punctuation">,</span> <span class="token string">"application/json"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_create-a-retainerinvoice"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span><span class="token punctuation">,</span> <span class="token string-property property">'content-type'</span><span class="token operator">:</span> <span class="token string">'application/json'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token literal-property property">body</span><span class="token operator">:</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_create-a-retainerinvoice"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> payload <span class="token operator">=</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string">'content-type'</span><span class="token punctuation">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices?organization_id=10234695"</span><span class="token punctuation">,</span> payload<span class="token punctuation">,</span> headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_create-a-retainerinvoice"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string-property property">"content-type"</span><span class="token operator">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">write</span><span class="token punctuation">(</span><span class="token constant">JSON</span><span class="token punctuation">.</span><span class="token function">stringify</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token literal-property property">field1</span><span class="token operator">:</span> <span class="token string">'value1'</span><span class="token punctuation">,</span> <span class="token literal-property property">field2</span><span class="token operator">:</span> <span class="token string">'value2'</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_create-a-retainerinvoice"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'content-type: application/json'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--data</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span></code> </div> </div> <div class="request-topbar mt-60"> <p> Body Parameters </p> <div class="tooltiptext ml-auto"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('params_create-a-retainerinvoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> <div class="codebag codebag-code" data-simplebar> <div class="codesnippets" style="display: inline;"> <code data-snippet-id="params_create-a-retainerinvoice"><span class="token punctuation">{</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token number">982000000567001</span><span class="token punctuation">,</span> <span class="token property">"reference_number"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"contact_persons"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"982000000567003"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"custom_fields"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"index"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"show_on_pdf"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"The value of the custom field"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"Delivery Date"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"notes"</span><span class="token operator">:</span> <span class="token string">"Looking forward for your business."</span><span class="token punctuation">,</span> <span class="token property">"terms"</span><span class="token operator">:</span> <span class="token string">"Terms & Conditions apply"</span><span class="token punctuation">,</span> <span class="token property">"line_items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"500GB, USB 2.0 interface 1400 rpm, protective hard case."</span><span class="token punctuation">,</span> <span class="token property">"item_order"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"rate"</span><span class="token operator">:</span> <span class="token number">120</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"payment_options"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"payment_gateways"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"configured"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"additional_field1"</span><span class="token operator">:</span> <span class="token string">"standard"</span><span class="token punctuation">,</span> <span class="token property">"gateway_name"</span><span class="token operator">:</span> <span class="token string">"paypal"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"template_id"</span><span class="token operator">:</span> <span class="token number">982000000000143</span><span class="token punctuation">,</span> <span class="token property">"place_of_supply"</span><span class="token operator">:</span> <span class="token string">"TN"</span> <span class="token punctuation">}</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"The retainer invoice has been created."</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"retainerinvoice_id"</span><span class="token operator">:</span> <span class="token number">982000000567114</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice_number"</span><span class="token operator">:</span> <span class="token string">"RET-00003"</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"draft"</span><span class="token punctuation">,</span> <span class="token property">"is_pre_gst"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"place_of_supply"</span><span class="token operator">:</span> <span class="token string">"TN"</span><span class="token punctuation">,</span> <span class="token property">"project_id"</span><span class="token operator">:</span> <span class="token number">982000000567154</span><span class="token punctuation">,</span> <span class="token property">"project_name"</span><span class="token operator">:</span> <span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"last_payment_date"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"reference_number"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token number">982000000567001</span><span class="token punctuation">,</span> <span class="token property">"customer_name"</span><span class="token operator">:</span> <span class="token string">"Bowman & Co"</span><span class="token punctuation">,</span> <span class="token property">"contact_persons"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"982000000567003"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"currency_id"</span><span class="token operator">:</span> <span class="token number">982000000000190</span><span class="token punctuation">,</span> <span class="token property">"currency_code"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"currency_symbol"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"exchange_rate"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"is_viewed_by_client"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"client_viewed_time"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"is_inclusive_tax"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"line_items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"line_item_id"</span><span class="token operator">:</span> <span class="token number">982000000567021</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"500GB, USB 2.0 interface 1400 rpm, protective hard case."</span><span class="token punctuation">,</span> <span class="token property">"item_order"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"rate"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"bcy_rate"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"tax_id"</span><span class="token operator">:</span> <span class="token number">982000000557028</span><span class="token punctuation">,</span> <span class="token property">"tax_name"</span><span class="token operator">:</span> <span class="token string">"VAT"</span><span class="token punctuation">,</span> <span class="token property">"tax_type"</span><span class="token operator">:</span> <span class="token string">"tax"</span><span class="token punctuation">,</span> <span class="token property">"tax_percentage"</span><span class="token operator">:</span> <span class="token number">12.5</span><span class="token punctuation">,</span> <span class="token property">"item_total"</span><span class="token operator">:</span> <span class="token number">120</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"sub_total"</span><span class="token operator">:</span> <span class="token number">153</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"taxes"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"tax_name"</span><span class="token operator">:</span> <span class="token string">"VAT"</span><span class="token punctuation">,</span> <span class="token property">"tax_amount"</span><span class="token operator">:</span> <span class="token number">19.13</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"payment_made"</span><span class="token operator">:</span> <span class="token number">26.91</span><span class="token punctuation">,</span> <span class="token property">"payment_drawn"</span><span class="token operator">:</span> <span class="token number">26.91</span><span class="token punctuation">,</span> <span class="token property">"balance"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"allow_partial_payments"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"price_precision"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"payment_options"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"payment_gateways"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"configured"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"additional_field1"</span><span class="token operator">:</span> <span class="token string">"standard"</span><span class="token punctuation">,</span> <span class="token property">"gateway_name"</span><span class="token operator">:</span> <span class="token string">"paypal"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"is_emailed"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"documents"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"billing_address"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Suite 125, McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"street2"</span><span class="token operator">:</span> <span class="token string">"McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"San Francisco"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"CA"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">94134</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"U.S.A"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"shipping_address"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Suite 125, McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"San Francisco"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"CA"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">94134</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"U.S.A"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"notes"</span><span class="token operator">:</span> <span class="token string">"Looking forward for your business."</span><span class="token punctuation">,</span> <span class="token property">"terms"</span><span class="token operator">:</span> <span class="token string">"Terms & Conditions apply"</span><span class="token punctuation">,</span> <span class="token property">"custom_fields"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"index"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"show_on_pdf"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"The value of the custom field"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"Delivery Date"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"template_id"</span><span class="token operator">:</span> <span class="token number">982000000000143</span><span class="token punctuation">,</span> <span class="token property">"template_name"</span><span class="token operator">:</span> <span class="token string">"Service - Classic"</span><span class="token punctuation">,</span> <span class="token property">"page_width"</span><span class="token operator">:</span> <span class="token string">"8.27in"</span><span class="token punctuation">,</span> <span class="token property">"page_height"</span><span class="token operator">:</span> <span class="token string">"11.69in"</span><span class="token punctuation">,</span> <span class="token property">"orientation"</span><span class="token operator">:</span> <span class="token string">"portrait"</span><span class="token punctuation">,</span> <span class="token property">"template_type"</span><span class="token operator">:</span> <span class="token string">"classic"</span><span class="token punctuation">,</span> <span class="token property">"created_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"last_modified_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"created_by_id"</span><span class="token operator">:</span> <span class="token number">14909000000072000</span><span class="token punctuation">,</span> <span class="token property">"attachment_name"</span><span class="token operator">:</span> <span class="token string">"new file"</span><span class="token punctuation">,</span> <span class="token property">"can_send_in_mail"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"invoice_url"</span><span class="token operator">:</span> <span class="token string">"https://invoice.zoho.com/SecurePayment?CInvoiceID=23d84d0cf64f9a72ea0c66fded25a08c8bafd0ab508aff05323a9f80e2cd03fdc5dd568d3d6407bbda969d3e870d740b6fce549a9438c4ea"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="list-a-retainer-invoices" class="scroll-observer pt-70">List a retainer invoices</h2> <p> List all retainer invoices with pagination. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.READ</span></code> </p> <h3 id="queryparams" class="properties"> Query Parameters </h3> <div class="parameter"> <div class="row" id=list-a-retainer-invoices-print> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> print </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Print the exported pdf.</div> </div> </div> <div class="row" id=list-a-retainer-invoices-sort_column> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> sort_column </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Sort retainer invoices.Allowed Values: <code>customer_name</code>, <code>retainer invoice_number</code>, <code>date</code>, <code> due_date</code>, <code>total</code>, <code>balance</code> and <code>created_time</code></div> </div> </div> <div class="row" id=list-a-retainer-invoices-filter_by> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> filter_by </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Filter invoices by any status or payment expected date.Allowed Values: <code> Status.All</code>, <code>Status.Sent</code>, <code> Status.Draft</code>, <code>Status.OverDue</code>, <code>Status.Paid</code>, <code>Status.Void</code>, <code>Status.Unpaid</code>, <code>Status.PartiallyPaid</code>,<code> Status.Viewed</code> and <code>Date.PaymentExpectedDate</code></div> </div> </div> <div class="row" id=list-a-retainer-invoices-sort_order> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> sort_order </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The order for sorting</div> </div> </div> <div class="row" id=list-a-retainer-invoices-page> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> page </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Number of pages</div> </div> </div> </div> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_list-a-retainer-invoices',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_list-a-retainer-invoices">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">GET</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_list-a-retainer-invoices"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_list-a-retainer-invoices"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_list-a-retainer-invoices"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_list-a-retainer-invoices"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_list-a-retainer-invoices"><span class="token function">curl</span> <span class="token parameter variable">--request</span> GET <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"success"</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoices"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"retainerinvoice_id"</span><span class="token operator">:</span> <span class="token number">982000000567114</span><span class="token punctuation">,</span> <span class="token property">"customer_name"</span><span class="token operator">:</span> <span class="token string">"Bowman & Co"</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice_number"</span><span class="token operator">:</span> <span class="token string">"RET-00003"</span><span class="token punctuation">,</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token number">982000000567001</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"draft"</span><span class="token punctuation">,</span> <span class="token property">"reference_number"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"project_or_estimate_name"</span><span class="token operator">:</span> <span class="token string">"new project"</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"currency_id"</span><span class="token operator">:</span> <span class="token number">982000000000190</span><span class="token punctuation">,</span> <span class="token property">"currency_code"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"is_viewed_by_client"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"client_viewed_time"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"balance"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"created_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"last_modified_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"is_emailed"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"last_payment_date"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"has_attachment"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>...<span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>...<span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"page_context"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"page"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"per_page"</span><span class="token operator">:</span> <span class="token number">200</span><span class="token punctuation">,</span> <span class="token property">"has_more_page"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"report_name"</span><span class="token operator">:</span> <span class="token string">"Retainer Invoices"</span><span class="token punctuation">,</span> <span class="token property">"applied_filter"</span><span class="token operator">:</span> <span class="token string">"Status.All"</span><span class="token punctuation">,</span> <span class="token property">"sort_column"</span><span class="token operator">:</span> <span class="token string">"created_time"</span><span class="token punctuation">,</span> <span class="token property">"sort_order"</span><span class="token operator">:</span> <span class="token string">"D"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="update-a-retainerinvoice" class="scroll-observer pt-70">update a retainerinvoice</h2> <p> Update an existing invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.UPDATE</span></code> </p> <h3 id="arguments" class="properties"> Arguments </h3> <div class="parameter"> <div class="row" id=update-a-retainerinvoice-customer_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> customer_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Required"> (Required) </div> </div> <div class="prop-descrip">ID of the customer the retainer invoice has to be created.</div> </div> </div> <div class="row" id=update-a-retainerinvoice-reference_number> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> reference_number </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The reference number of the retainer invoice. Max-length [100]</div> </div> </div> <div class="row" id=update-a-retainerinvoice-date> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> date </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The date of creation of the retainer invoice.</div> </div> </div> <div class="row" id=update-a-retainerinvoice-contact_persons> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> contact_persons </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=update-a-retainerinvoice-custom_fields> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> custom_fields </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Custom fields for a reatiner invoice.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=update-a-retainerinvoice-custom_fields-index> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> index </div> <div class="property-datatype"> integer </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The index of the custom field</div> </div> </div> <div class="row attribute small-line" id=update-a-retainerinvoice-custom_fields-show_on_pdf> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> show_on_pdf </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean value to check if the custom field is to be dispplayed on the pdf.</div> </div> </div> <div class="row attribute small-line" id=update-a-retainerinvoice-custom_fields-value> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> value </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row attribute small-line" id=update-a-retainerinvoice-custom_fields-label> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> label </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The label of the custom field.</div> </div> </div> </div> </details> </div> </div> <div class="row" id=update-a-retainerinvoice-notes> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> notes </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The notes added below expressing gratitude or for conveying some information.</div> </div> </div> <div class="row" id=update-a-retainerinvoice-terms> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> terms </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The terms added below expressing gratitude or for conveying some information.</div> </div> </div> <div class="row" id=update-a-retainerinvoice-line_items> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> line_items </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Required"> (Required) </div> </div> <div class="prop-descrip">Line items of a retainer invoice.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=update-a-retainerinvoice-line_items-description> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> description </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The description of the line items. Max-length [2000]</div> </div> </div> <div class="row attribute small-line" id=update-a-retainerinvoice-line_items-item_order> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> item_order </div> <div class="property-datatype"> integer </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The order of the line item_order</div> </div> </div> <div class="row attribute small-line" id=update-a-retainerinvoice-line_items-rate> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> rate </div> <div class="property-datatype"> double </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Rate of the line item.</div> </div> </div> </div> </details> </div> </div> <div class="row" id=update-a-retainerinvoice-payment_options> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_options </div> <div class="property-datatype"> object </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Payment options for the retainer invoice, online payment gateways and bank accounts. Will be displayed in the pdf.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=attribute-wrapper> <div class="row attribute small-line" id=update-a-retainerinvoice-payment_options-payment_gateways> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_gateways </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Online payment gateways through which payment can be made.</div> <details> <summary class="link"> <span class="show-hide-attribute-text" data-showhide="Show Sub-Attributes">Show Sub-Attributes</span> <img src="/books/api/v3/images/dropdown-arrow.svg" class="arrow-icon" alt="arrow" width="9px" height="9px"/> </span> </summary> <div class=nested-attribute-wrapper> <div class="row attribute small-line" id=update-a-retainerinvoice-payment_options-payment_gateways-configured> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> configured </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean check to see if a payment gateway ahs been configured</div> </div> </div> <div class="row attribute small-line" id=update-a-retainerinvoice-payment_options-payment_gateways-additional_field1> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> additional_field1 </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Paypal payment method. Allowed Values: <code>standard</code> and <code>adaptive</code></div> </div> </div> <div class="row attribute small-line" id=update-a-retainerinvoice-payment_options-payment_gateways-gateway_name> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> gateway_name </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Name of the payment gateway associated with the retainer invoice. E.g. paypal, stripe.Allowed Values: <code>paypal</code>, <code>authorize_net</code>, <code>payflow_pro</code>, <code>stripe</code>, <code>2checkout</code> and <code>braintree</code></div> </div> </div> </div> </details> </div> </div> </div> </details> </div> </div> <div class="row" id=update-a-retainerinvoice-template_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> template_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">ID of the pdf template associated with the retainer invoice.</div> </div> </div> <div class="row" id=update-a-retainerinvoice-place_of_supply> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> place_of_supply </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> <div class='red'> <span class="availability-info-wrapper">馃嚠馃嚦 <span role="tooltip" class="tooltip infoText"> India <div class="arrow" data-popper-arrow></div> </span> </span> <span>only</span> </div> </div> <div class="prop-descrip">Place where the goods/services are supplied to. (If not given, <code>place of contact</code> given for the contact will be taken)</div> </div> </div> <div class="row" id=update-a-retainerinvoice-project_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> project_id </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">ID of the project</div> </div> </div> </div> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_update-a-retainerinvoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_update-a-retainerinvoice">parameters_data<span class="token operator">=</span><span class="token string">'{"field1":"value1","field2":"value2"}'</span><span class="token punctuation">;</span> headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">PUT</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">content-type</span><span class="token punctuation">:</span> application<span class="token operator">/</span>json <span class="token property">parameters</span><span class="token punctuation">:</span> parameters_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_update-a-retainerinvoice"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">MediaType</span> mediaType <span class="token operator">=</span> <span class="token class-name">MediaType</span><span class="token punctuation">.</span><span class="token function">parse</span><span class="token punctuation">(</span><span class="token string">"application/json"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">RequestBody</span> body <span class="token operator">=</span> <span class="token class-name">RequestBody</span><span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>mediaType<span class="token punctuation">,</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">put</span><span class="token punctuation">(</span>body<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"content-type"</span><span class="token punctuation">,</span> <span class="token string">"application/json"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_update-a-retainerinvoice"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'PUT'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span><span class="token punctuation">,</span> <span class="token string-property property">'content-type'</span><span class="token operator">:</span> <span class="token string">'application/json'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token literal-property property">body</span><span class="token operator">:</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_update-a-retainerinvoice"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> payload <span class="token operator">=</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string">'content-type'</span><span class="token punctuation">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"PUT"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">,</span> payload<span class="token punctuation">,</span> headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_update-a-retainerinvoice"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"PUT"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string-property property">"content-type"</span><span class="token operator">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">write</span><span class="token punctuation">(</span><span class="token constant">JSON</span><span class="token punctuation">.</span><span class="token function">stringify</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token literal-property property">field1</span><span class="token operator">:</span> <span class="token string">'value1'</span><span class="token punctuation">,</span> <span class="token literal-property property">field2</span><span class="token operator">:</span> <span class="token string">'value2'</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_update-a-retainerinvoice"><span class="token function">curl</span> <span class="token parameter variable">--request</span> PUT <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'content-type: application/json'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--data</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span></code> </div> </div> <div class="request-topbar mt-60"> <p> Body Parameters </p> <div class="tooltiptext ml-auto"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('params_update-a-retainerinvoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> <div class="codebag codebag-code" data-simplebar> <div class="codesnippets" style="display: inline;"> <code data-snippet-id="params_update-a-retainerinvoice"><span class="token punctuation">{</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token number">982000000567001</span><span class="token punctuation">,</span> <span class="token property">"reference_number"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"contact_persons"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"982000000567003"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"custom_fields"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"index"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"show_on_pdf"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"The value of the custom field"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"Delivery Date"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"notes"</span><span class="token operator">:</span> <span class="token string">"Looking forward for your business."</span><span class="token punctuation">,</span> <span class="token property">"terms"</span><span class="token operator">:</span> <span class="token string">"Terms & Conditions apply"</span><span class="token punctuation">,</span> <span class="token property">"line_items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"500GB, USB 2.0 interface 1400 rpm, protective hard case."</span><span class="token punctuation">,</span> <span class="token property">"item_order"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"rate"</span><span class="token operator">:</span> <span class="token number">120</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"payment_options"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"payment_gateways"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"configured"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"additional_field1"</span><span class="token operator">:</span> <span class="token string">"standard"</span><span class="token punctuation">,</span> <span class="token property">"gateway_name"</span><span class="token operator">:</span> <span class="token string">"paypal"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"template_id"</span><span class="token operator">:</span> <span class="token number">982000000000143</span><span class="token punctuation">,</span> <span class="token property">"place_of_supply"</span><span class="token operator">:</span> <span class="token string">"TN"</span><span class="token punctuation">,</span> <span class="token property">"project_id"</span><span class="token operator">:</span> <span class="token number">982000000567154</span> <span class="token punctuation">}</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Retainer Invoice information has been updated."</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"retainerinvoice_id"</span><span class="token operator">:</span> <span class="token number">982000000567114</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice_number"</span><span class="token operator">:</span> <span class="token string">"RET-00003"</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"draft"</span><span class="token punctuation">,</span> <span class="token property">"is_pre_gst"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"place_of_supply"</span><span class="token operator">:</span> <span class="token string">"TN"</span><span class="token punctuation">,</span> <span class="token property">"project_id"</span><span class="token operator">:</span> <span class="token number">982000000567154</span><span class="token punctuation">,</span> <span class="token property">"project_name"</span><span class="token operator">:</span> <span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"last_payment_date"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"reference_number"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token number">982000000567001</span><span class="token punctuation">,</span> <span class="token property">"customer_name"</span><span class="token operator">:</span> <span class="token string">"Bowman & Co"</span><span class="token punctuation">,</span> <span class="token property">"contact_persons"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"982000000567003"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"currency_id"</span><span class="token operator">:</span> <span class="token number">982000000000190</span><span class="token punctuation">,</span> <span class="token property">"currency_code"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"currency_symbol"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"exchange_rate"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"is_viewed_by_client"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"client_viewed_time"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"is_inclusive_tax"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"line_items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"line_item_id"</span><span class="token operator">:</span> <span class="token number">982000000567021</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"500GB, USB 2.0 interface 1400 rpm, protective hard case."</span><span class="token punctuation">,</span> <span class="token property">"item_order"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"rate"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"bcy_rate"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"tax_id"</span><span class="token operator">:</span> <span class="token number">982000000557028</span><span class="token punctuation">,</span> <span class="token property">"tax_name"</span><span class="token operator">:</span> <span class="token string">"VAT"</span><span class="token punctuation">,</span> <span class="token property">"tax_type"</span><span class="token operator">:</span> <span class="token string">"tax"</span><span class="token punctuation">,</span> <span class="token property">"tax_percentage"</span><span class="token operator">:</span> <span class="token number">12.5</span><span class="token punctuation">,</span> <span class="token property">"item_total"</span><span class="token operator">:</span> <span class="token number">120</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"sub_total"</span><span class="token operator">:</span> <span class="token number">153</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"taxes"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"tax_name"</span><span class="token operator">:</span> <span class="token string">"VAT"</span><span class="token punctuation">,</span> <span class="token property">"tax_amount"</span><span class="token operator">:</span> <span class="token number">19.13</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"payment_made"</span><span class="token operator">:</span> <span class="token number">26.91</span><span class="token punctuation">,</span> <span class="token property">"payment_drawn"</span><span class="token operator">:</span> <span class="token number">26.91</span><span class="token punctuation">,</span> <span class="token property">"balance"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"allow_partial_payments"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"price_precision"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"payment_options"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"payment_gateways"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"configured"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"additional_field1"</span><span class="token operator">:</span> <span class="token string">"standard"</span><span class="token punctuation">,</span> <span class="token property">"gateway_name"</span><span class="token operator">:</span> <span class="token string">"paypal"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"is_emailed"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"documents"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"billing_address"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Suite 125, McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"street2"</span><span class="token operator">:</span> <span class="token string">"McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"San Francisco"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"CA"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">94134</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"U.S.A"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"shipping_address"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Suite 125, McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"San Francisco"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"CA"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">94134</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"U.S.A"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"notes"</span><span class="token operator">:</span> <span class="token string">"Looking forward for your business."</span><span class="token punctuation">,</span> <span class="token property">"terms"</span><span class="token operator">:</span> <span class="token string">"Terms & Conditions apply"</span><span class="token punctuation">,</span> <span class="token property">"custom_fields"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"index"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"show_on_pdf"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"The value of the custom field"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"Delivery Date"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"template_id"</span><span class="token operator">:</span> <span class="token number">982000000000143</span><span class="token punctuation">,</span> <span class="token property">"template_name"</span><span class="token operator">:</span> <span class="token string">"Service - Classic"</span><span class="token punctuation">,</span> <span class="token property">"page_width"</span><span class="token operator">:</span> <span class="token string">"8.27in"</span><span class="token punctuation">,</span> <span class="token property">"page_height"</span><span class="token operator">:</span> <span class="token string">"11.69in"</span><span class="token punctuation">,</span> <span class="token property">"orientation"</span><span class="token operator">:</span> <span class="token string">"portrait"</span><span class="token punctuation">,</span> <span class="token property">"template_type"</span><span class="token operator">:</span> <span class="token string">"classic"</span><span class="token punctuation">,</span> <span class="token property">"created_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"last_modified_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"created_by_id"</span><span class="token operator">:</span> <span class="token number">14909000000072000</span><span class="token punctuation">,</span> <span class="token property">"attachment_name"</span><span class="token operator">:</span> <span class="token string">"new file"</span><span class="token punctuation">,</span> <span class="token property">"can_send_in_mail"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"invoice_url"</span><span class="token operator">:</span> <span class="token string">"https://invoice.zoho.com/SecurePayment?CInvoiceID=23d84d0cf64f9a72ea0c66fded25a08c8bafd0ab508aff05323a9f80e2cd03fdc5dd568d3d6407bbda969d3e870d740b6fce549a9438c4ea"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="get-a-retainer-invoice" class="scroll-observer pt-70">Get a retainer invoice</h2> <p> Get the details of a retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.READ</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_get-a-retainer-invoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_get-a-retainer-invoice">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">GET</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_get-a-retainer-invoice"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_get-a-retainer-invoice"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_get-a-retainer-invoice"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_get-a-retainer-invoice"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_get-a-retainer-invoice"><span class="token function">curl</span> <span class="token parameter variable">--request</span> GET <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"success"</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"retainerinvoice_id"</span><span class="token operator">:</span> <span class="token number">982000000567114</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice_number"</span><span class="token operator">:</span> <span class="token string">"RET-00003"</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"status"</span><span class="token operator">:</span> <span class="token string">"draft"</span><span class="token punctuation">,</span> <span class="token property">"is_pre_gst"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"place_of_supply"</span><span class="token operator">:</span> <span class="token string">"TN"</span><span class="token punctuation">,</span> <span class="token property">"project_id"</span><span class="token operator">:</span> <span class="token number">982000000567154</span><span class="token punctuation">,</span> <span class="token property">"project_name"</span><span class="token operator">:</span> <span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"last_payment_date"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"reference_number"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token number">982000000567001</span><span class="token punctuation">,</span> <span class="token property">"customer_name"</span><span class="token operator">:</span> <span class="token string">"Bowman & Co"</span><span class="token punctuation">,</span> <span class="token property">"contact_persons"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"982000000567003"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"currency_id"</span><span class="token operator">:</span> <span class="token number">982000000000190</span><span class="token punctuation">,</span> <span class="token property">"currency_code"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"currency_symbol"</span><span class="token operator">:</span> <span class="token string">"USD"</span><span class="token punctuation">,</span> <span class="token property">"exchange_rate"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"is_viewed_by_client"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"client_viewed_time"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"is_inclusive_tax"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"line_items"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"line_item_id"</span><span class="token operator">:</span> <span class="token number">982000000567021</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"500GB, USB 2.0 interface 1400 rpm, protective hard case."</span><span class="token punctuation">,</span> <span class="token property">"item_order"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"rate"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"bcy_rate"</span><span class="token operator">:</span> <span class="token number">120</span><span class="token punctuation">,</span> <span class="token property">"tax_id"</span><span class="token operator">:</span> <span class="token number">982000000557028</span><span class="token punctuation">,</span> <span class="token property">"tax_name"</span><span class="token operator">:</span> <span class="token string">"VAT"</span><span class="token punctuation">,</span> <span class="token property">"tax_type"</span><span class="token operator">:</span> <span class="token string">"tax"</span><span class="token punctuation">,</span> <span class="token property">"tax_percentage"</span><span class="token operator">:</span> <span class="token number">12.5</span><span class="token punctuation">,</span> <span class="token property">"item_total"</span><span class="token operator">:</span> <span class="token number">120</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"sub_total"</span><span class="token operator">:</span> <span class="token number">153</span><span class="token punctuation">,</span> <span class="token property">"total"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"taxes"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"tax_name"</span><span class="token operator">:</span> <span class="token string">"VAT"</span><span class="token punctuation">,</span> <span class="token property">"tax_amount"</span><span class="token operator">:</span> <span class="token number">19.13</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"payment_made"</span><span class="token operator">:</span> <span class="token number">26.91</span><span class="token punctuation">,</span> <span class="token property">"payment_drawn"</span><span class="token operator">:</span> <span class="token number">26.91</span><span class="token punctuation">,</span> <span class="token property">"balance"</span><span class="token operator">:</span> <span class="token number">40.6</span><span class="token punctuation">,</span> <span class="token property">"allow_partial_payments"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"price_precision"</span><span class="token operator">:</span> <span class="token number">2</span><span class="token punctuation">,</span> <span class="token property">"payment_options"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"payment_gateways"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"configured"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"additional_field1"</span><span class="token operator">:</span> <span class="token string">"standard"</span><span class="token punctuation">,</span> <span class="token property">"gateway_name"</span><span class="token operator">:</span> <span class="token string">"paypal"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"is_emailed"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"documents"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"billing_address"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Suite 125, McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"street2"</span><span class="token operator">:</span> <span class="token string">"McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"San Francisco"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"CA"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">94134</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"U.S.A"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"shipping_address"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"Suite 125, McMillan Avenue"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"San Francisco"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"CA"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">94134</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"U.S.A"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"notes"</span><span class="token operator">:</span> <span class="token string">"Looking forward for your business."</span><span class="token punctuation">,</span> <span class="token property">"terms"</span><span class="token operator">:</span> <span class="token string">"Terms & Conditions apply"</span><span class="token punctuation">,</span> <span class="token property">"custom_fields"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"index"</span><span class="token operator">:</span> <span class="token number">1</span><span class="token punctuation">,</span> <span class="token property">"show_on_pdf"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"The value of the custom field"</span><span class="token punctuation">,</span> <span class="token property">"label"</span><span class="token operator">:</span> <span class="token string">"Delivery Date"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"template_id"</span><span class="token operator">:</span> <span class="token number">982000000000143</span><span class="token punctuation">,</span> <span class="token property">"template_name"</span><span class="token operator">:</span> <span class="token string">"Service - Classic"</span><span class="token punctuation">,</span> <span class="token property">"page_width"</span><span class="token operator">:</span> <span class="token string">"8.27in"</span><span class="token punctuation">,</span> <span class="token property">"page_height"</span><span class="token operator">:</span> <span class="token string">"11.69in"</span><span class="token punctuation">,</span> <span class="token property">"orientation"</span><span class="token operator">:</span> <span class="token string">"portrait"</span><span class="token punctuation">,</span> <span class="token property">"template_type"</span><span class="token operator">:</span> <span class="token string">"classic"</span><span class="token punctuation">,</span> <span class="token property">"created_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"last_modified_time"</span><span class="token operator">:</span> <span class="token string">"2013-11-18T02:31:51-0800"</span><span class="token punctuation">,</span> <span class="token property">"created_by_id"</span><span class="token operator">:</span> <span class="token number">14909000000072000</span><span class="token punctuation">,</span> <span class="token property">"attachment_name"</span><span class="token operator">:</span> <span class="token string">"new file"</span><span class="token punctuation">,</span> <span class="token property">"can_send_in_mail"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"invoice_url"</span><span class="token operator">:</span> <span class="token string">"https://invoice.zoho.com/SecurePayment?CInvoiceID=23d84d0cf64f9a72ea0c66fded25a08c8bafd0ab508aff05323a9f80e2cd03fdc5dd568d3d6407bbda969d3e870d740b6fce549a9438c4ea"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="delete-a-retainer-invoice" class="scroll-observer pt-70">Delete a retainer invoice</h2> <p> Delete an existing retainer invoice. Invoices which have payment or credits note applied cannot be deleted. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.DELETE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_delete-a-retainer-invoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_delete-a-retainer-invoice">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">DELETE</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_delete-a-retainer-invoice"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">delete</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_delete-a-retainer-invoice"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'DELETE'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_delete-a-retainer-invoice"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"DELETE"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_delete-a-retainer-invoice"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"DELETE"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_delete-a-retainer-invoice"><span class="token function">curl</span> <span class="token parameter variable">--request</span> DELETE <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"The retainer invoice has been deleted."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="mark-a-retainer-invoice-as-sent" class="scroll-observer pt-70">Mark a retainer invoice as sent</h2> <p> Mark a draft retainer invoice as sent. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_mark-a-retainer-invoice-as-sent',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_mark-a-retainer-invoice-as-sent">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/status/sent?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_mark-a-retainer-invoice-as-sent"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/status/sent?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_mark-a-retainer-invoice-as-sent"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/status/sent?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_mark-a-retainer-invoice-as-sent"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/status/sent?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_mark-a-retainer-invoice-as-sent"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/status/sent?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_mark-a-retainer-invoice-as-sent"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/status/sent?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Retainer Invoice status has been changed to Sent."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="update-retainer-invoice-template" class="scroll-observer pt-70">Update retainer invoice template</h2> <p> Update the pdf template associated with the retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.UPDATE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_update-retainer-invoice-template',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_update-retainer-invoice-template">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/templates/982000000000143?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">PUT</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_update-retainer-invoice-template"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/templates/982000000000143?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_update-retainer-invoice-template"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'PUT'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/templates/982000000000143?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_update-retainer-invoice-template"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"PUT"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/templates/982000000000143?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_update-retainer-invoice-template"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"PUT"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/templates/982000000000143?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_update-retainer-invoice-template"><span class="token function">curl</span> <span class="token parameter variable">--request</span> PUT <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/templates/982000000000143?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Retainer Invoice information has been updated."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="void-a-retainer-invoice" class="scroll-observer pt-70">Void a retainer invoice</h2> <p> Mark an invoice status as void. Upon voiding, the payments and credits associated with the retainer invoices will be unassociated and will be under customer credits. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_void-a-retainer-invoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_void-a-retainer-invoice">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/status/void?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_void-a-retainer-invoice"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/status/void?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_void-a-retainer-invoice"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/status/void?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_void-a-retainer-invoice"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/status/void?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_void-a-retainer-invoice"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/status/void?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_void-a-retainer-invoice"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/status/void?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Retainer Invoice status has been changed to 'Void'."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="mark-as-draft" class="scroll-observer pt-70">Mark as draft</h2> <p> Mark a voided retainer invoice as draft. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_mark-as-draft',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_mark-as-draft">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices//status/draft?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_mark-as-draft"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices//status/draft?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_mark-as-draft"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices//status/draft?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_mark-as-draft"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices//status/draft?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_mark-as-draft"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices//status/draft?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_mark-as-draft"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices//status/draft?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Status of retainer invoice changed from void to draft."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="submit-a-retainer-invoice-for-approval" class="scroll-observer pt-70">Submit a retainer invoice for approval</h2> <p> Submit a retainer invoice for approval. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_submit-a-retainer-invoice-for-approval',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_submit-a-retainer-invoice-for-approval">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices//submit?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_submit-a-retainer-invoice-for-approval"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices//submit?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_submit-a-retainer-invoice-for-approval"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices//submit?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_submit-a-retainer-invoice-for-approval"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices//submit?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_submit-a-retainer-invoice-for-approval"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices//submit?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_submit-a-retainer-invoice-for-approval"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices//submit?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"The Retainer Invoice has been successfully submitted for approval."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="approve-a-retainer-invoice" class="scroll-observer pt-70">Approve a retainer invoice.</h2> <p> Approve a retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_approve-a-retainer-invoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_approve-a-retainer-invoice">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices//approve?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_approve-a-retainer-invoice"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices//approve?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_approve-a-retainer-invoice"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices//approve?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_approve-a-retainer-invoice"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices//approve?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_approve-a-retainer-invoice"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices//approve?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_approve-a-retainer-invoice"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices//approve?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"You have approved the Retainer Invoice."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="email-a-retainer-invoice" class="scroll-observer pt-70">Email a retainer invoice</h2> <p> Email a retainer invoice to the customer. Input json string is not mandatory. If input json string is empty, mail will be send with default mail content. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> <h3 id="arguments" class="properties"> Arguments </h3> <div class="parameter"> <div class="row" id=email-a-retainer-invoice-send_from_org_email_id> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> send_from_org_email_id </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean to trigger the email from the organization's email address</div> </div> </div> <div class="row" id=email-a-retainer-invoice-to_mail_ids> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> to_mail_ids </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Required"> (Required) </div> </div> <div class="prop-descrip">Array of email address of the recipients.</div> </div> </div> <div class="row" id=email-a-retainer-invoice-cc_mail_ids> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> cc_mail_ids </div> <div class="property-datatype"> array </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Array of email address of the recipients to be cced.</div> </div> </div> <div class="row" id=email-a-retainer-invoice-subject> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> subject </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The subject of the mail</div> </div> </div> <div class="row" id=email-a-retainer-invoice-body> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> body </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The body of the mail</div> </div> </div> </div> <h3 id="queryparams" class="properties"> Query Parameters </h3> <div class="parameter"> <div class="row" id=email-a-retainer-invoice-send_customer_statement> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> send_customer_statement </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Send customer statement pdf a with email.</div> </div> </div> <div class="row" id=email-a-retainer-invoice-send_attachment> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> send_attachment </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Send the retainer invoice attachment a with the email.</div> </div> </div> <div class="row" id=email-a-retainer-invoice-attachments> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> attachments </div> <div class="property-datatype"> </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Files to be attached to the email</div> </div> </div> </div> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_email-a-retainer-invoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_email-a-retainer-invoice">parameters_data<span class="token operator">=</span><span class="token string">'{"field1":"value1","field2":"value2"}'</span><span class="token punctuation">;</span> headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">content-type</span><span class="token punctuation">:</span> application<span class="token operator">/</span>json <span class="token property">parameters</span><span class="token punctuation">:</span> parameters_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_email-a-retainer-invoice"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">MediaType</span> mediaType <span class="token operator">=</span> <span class="token class-name">MediaType</span><span class="token punctuation">.</span><span class="token function">parse</span><span class="token punctuation">(</span><span class="token string">"application/json"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">RequestBody</span> body <span class="token operator">=</span> <span class="token class-name">RequestBody</span><span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>mediaType<span class="token punctuation">,</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span>body<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"content-type"</span><span class="token punctuation">,</span> <span class="token string">"application/json"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_email-a-retainer-invoice"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span><span class="token punctuation">,</span> <span class="token string-property property">'content-type'</span><span class="token operator">:</span> <span class="token string">'application/json'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token literal-property property">body</span><span class="token operator">:</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_email-a-retainer-invoice"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> payload <span class="token operator">=</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string">'content-type'</span><span class="token punctuation">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695"</span><span class="token punctuation">,</span> payload<span class="token punctuation">,</span> headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_email-a-retainer-invoice"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string-property property">"content-type"</span><span class="token operator">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">write</span><span class="token punctuation">(</span><span class="token constant">JSON</span><span class="token punctuation">.</span><span class="token function">stringify</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token literal-property property">field1</span><span class="token operator">:</span> <span class="token string">'value1'</span><span class="token punctuation">,</span> <span class="token literal-property property">field2</span><span class="token operator">:</span> <span class="token string">'value2'</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_email-a-retainer-invoice"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'content-type: application/json'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--data</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span></code> </div> </div> <div class="request-topbar mt-60"> <p> Body Parameters </p> <div class="tooltiptext ml-auto"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('params_email-a-retainer-invoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> <div class="codebag codebag-code" data-simplebar> <div class="codesnippets" style="display: inline;"> <code data-snippet-id="params_email-a-retainer-invoice"><span class="token punctuation">{</span> <span class="token property">"send_from_org_email_id"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"to_mail_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"willsmith@bowmanfurniture.com"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"cc_mail_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token string">"peterparker@bowmanfurniture.com"</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"subject"</span><span class="token operator">:</span> <span class="token string">"Retainer Invoice from Zillium Inc (Retainer Invoice#: RET-00001)"</span><span class="token punctuation">,</span> <span class="token property">"body"</span><span class="token operator">:</span> <span class="token string">"Dear Customer, <br><br><br><br>Thanks for your business. <br><br><br><br>The retainer invoice RET-00001 is attached with this email. You can choose the easy way out and <a href= https://invoice.zoho.com/SecurePayment?CInvoiceID=b9800228e011ae86abe71227bdacb3c68e1af685f647dcaed747812e0b9314635e55ac6223925675b371fcbd2d5ae3dc >pay online for this invoice.</a> <br><br>Here's an overview of the invoice for your reference. <br><br><br><br>Invoice Overview: <br><br>Invoice : INV-00001 <br><br>Date : 05 Aug 2013 <br><br>Amount : $541.82 <br><br><br><br>It was great working with you. Looking forward to working with you again.<br><br><br>\\nRegards<br>\\nZillium Inc<br>\\n\","</span> <span class="token punctuation">}</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Your retainer invoice has been sent."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="get-retainer-invoice-email-content" class="scroll-observer pt-70">Get retainer invoice email content</h2> <p> Get the email content of a retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.READ</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_get-retainer-invoice-email-content',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_get-retainer-invoice-email-content">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">GET</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_get-retainer-invoice-email-content"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_get-retainer-invoice-email-content"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_get-retainer-invoice-email-content"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_get-retainer-invoice-email-content"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_get-retainer-invoice-email-content"><span class="token function">curl</span> <span class="token parameter variable">--request</span> GET <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/email?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"success"</span><span class="token punctuation">,</span> <span class="token property">"gateways_configured"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"deprecated_placeholders_used"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"body"</span><span class="token operator">:</span> <span class="token string">"Dear Customer, <br><br><br><br>Thanks for your business. <br><br><br><br>The retainer invoice RET-00001 is attached with this email. You can choose the easy way out and <a href= https://invoice.zoho.com/SecurePayment?CInvoiceID=b9800228e011ae86abe71227bdacb3c68e1af685f647dcaed747812e0b9314635e55ac6223925675b371fcbd2d5ae3dc >pay online for this invoice.</a> <br><br>Here's an overview of the invoice for your reference. <br><br><br><br>Invoice Overview: <br><br>Invoice : INV-00001 <br><br>Date : 05 Aug 2013 <br><br>Amount : $541.82 <br><br><br><br>It was great working with you. Looking forward to working with you again.<br><br><br>\\nRegards<br>\\nZillium Inc<br>\\n\","</span><span class="token punctuation">,</span> <span class="token property">"error_list"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"subject"</span><span class="token operator">:</span> <span class="token string">"Retainer Invoice from Zillium Inc (Retainer Invoice#: RET-00001)"</span><span class="token punctuation">,</span> <span class="token property">"to_contacts"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"first_name"</span><span class="token operator">:</span> <span class="token string">"Will"</span><span class="token punctuation">,</span> <span class="token property">"selected"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"phone"</span><span class="token operator">:</span> <span class="token string">"+1-925-921-9201"</span><span class="token punctuation">,</span> <span class="token property">"email"</span><span class="token operator">:</span> <span class="token string">"willsmith@bowmanfurniture.com"</span><span class="token punctuation">,</span> <span class="token property">"last_name"</span><span class="token operator">:</span> <span class="token string">"Smith"</span><span class="token punctuation">,</span> <span class="token property">"salutation"</span><span class="token operator">:</span> <span class="token string">"Mr"</span><span class="token punctuation">,</span> <span class="token property">"contact_person_id"</span><span class="token operator">:</span> <span class="token number">982000000567003</span><span class="token punctuation">,</span> <span class="token property">"mobile"</span><span class="token operator">:</span> <span class="token string">"+1-4054439562"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"attachment_name"</span><span class="token operator">:</span> <span class="token string">"new file"</span><span class="token punctuation">,</span> <span class="token property">"email_template_id"</span><span class="token operator">:</span> <span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"file_name"</span><span class="token operator">:</span> <span class="token string">"RET-00001.pdf"</span><span class="token punctuation">,</span> <span class="token property">"from_emails"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"user_name"</span><span class="token operator">:</span> <span class="token string">"John Smith"</span><span class="token punctuation">,</span> <span class="token property">"selected"</span><span class="token operator">:</span> <span class="token boolean">false</span><span class="token punctuation">,</span> <span class="token property">"email"</span><span class="token operator">:</span> <span class="token string">"willsmith@bowmanfurniture.com"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"customer_id"</span><span class="token operator">:</span> <span class="token number">982000000567001</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="update-billing-address" class="scroll-observer pt-70">Update billing address</h2> <p> Updates the billing address for this retainer invoice alone. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.UPDATE</span></code> </p> <h3 id="arguments" class="properties"> Arguments </h3> <div class="parameter"> <div class="row" id=update-billing-address-address> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> address </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">address of the customer</div> </div> </div> <div class="row" id=update-billing-address-city> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> city </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">city of the customer</div> </div> </div> <div class="row" id=update-billing-address-state> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> state </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">state of the customer</div> </div> </div> <div class="row" id=update-billing-address-zip> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> zip </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">zip of the customer</div> </div> </div> <div class="row" id=update-billing-address-country> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> country </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">country of the customer</div> </div> </div> <div class="row" id=update-billing-address-fax> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> fax </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">fax of the customer</div> </div> </div> </div> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_update-billing-address',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_update-billing-address">parameters_data<span class="token operator">=</span><span class="token string">'{"field1":"value1","field2":"value2"}'</span><span class="token punctuation">;</span> headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/address/billing?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">PUT</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">content-type</span><span class="token punctuation">:</span> application<span class="token operator">/</span>json <span class="token property">parameters</span><span class="token punctuation">:</span> parameters_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_update-billing-address"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">MediaType</span> mediaType <span class="token operator">=</span> <span class="token class-name">MediaType</span><span class="token punctuation">.</span><span class="token function">parse</span><span class="token punctuation">(</span><span class="token string">"application/json"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">RequestBody</span> body <span class="token operator">=</span> <span class="token class-name">RequestBody</span><span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>mediaType<span class="token punctuation">,</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/address/billing?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">put</span><span class="token punctuation">(</span>body<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"content-type"</span><span class="token punctuation">,</span> <span class="token string">"application/json"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_update-billing-address"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'PUT'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span><span class="token punctuation">,</span> <span class="token string-property property">'content-type'</span><span class="token operator">:</span> <span class="token string">'application/json'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token literal-property property">body</span><span class="token operator">:</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/address/billing?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_update-billing-address"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> payload <span class="token operator">=</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string">'content-type'</span><span class="token punctuation">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"PUT"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/address/billing?organization_id=10234695"</span><span class="token punctuation">,</span> payload<span class="token punctuation">,</span> headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_update-billing-address"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"PUT"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/address/billing?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string-property property">"content-type"</span><span class="token operator">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">write</span><span class="token punctuation">(</span><span class="token constant">JSON</span><span class="token punctuation">.</span><span class="token function">stringify</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token literal-property property">field1</span><span class="token operator">:</span> <span class="token string">'value1'</span><span class="token punctuation">,</span> <span class="token literal-property property">field2</span><span class="token operator">:</span> <span class="token string">'value2'</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_update-billing-address"><span class="token function">curl</span> <span class="token parameter variable">--request</span> PUT <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/address/billing?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'content-type: application/json'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--data</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span></code> </div> </div> <div class="request-topbar mt-60"> <p> Body Parameters </p> <div class="tooltiptext ml-auto"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('params_update-billing-address',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> <div class="codebag codebag-code" data-simplebar> <div class="codesnippets" style="display: inline;"> <code data-snippet-id="params_update-billing-address"><span class="token punctuation">{</span> <span class="token property">"address"</span><span class="token operator">:</span> <span class="token string">"B-1104, 11F, \nHorizon International Tower, \nNo. 6, ZhiChun Road, HaiDian District"</span><span class="token punctuation">,</span> <span class="token property">"city"</span><span class="token operator">:</span> <span class="token string">"Beijing"</span><span class="token punctuation">,</span> <span class="token property">"state"</span><span class="token operator">:</span> <span class="token string">"Beijing"</span><span class="token punctuation">,</span> <span class="token property">"zip"</span><span class="token operator">:</span> <span class="token number">1000881</span><span class="token punctuation">,</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"fax"</span><span class="token operator">:</span> <span class="token string">"+86-10-82637827"</span> <span class="token punctuation">}</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Billing address updated"</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="list-retainer-invoice-templates" class="scroll-observer pt-70">List retainer invoice templates</h2> <p> Get all retainer invoice pdf templates. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.READ</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_list-retainer-invoice-templates',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_list-retainer-invoice-templates">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/templates?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">GET</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_list-retainer-invoice-templates"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/templates?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_list-retainer-invoice-templates"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/templates?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_list-retainer-invoice-templates"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/templates?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_list-retainer-invoice-templates"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/templates?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_list-retainer-invoice-templates"><span class="token function">curl</span> <span class="token parameter variable">--request</span> GET <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/templates?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"success"</span><span class="token punctuation">,</span> <span class="token property">"templates"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"template_name"</span><span class="token operator">:</span> <span class="token string">"Service - Classic"</span><span class="token punctuation">,</span> <span class="token property">"template_id"</span><span class="token operator">:</span> <span class="token number">982000000000143</span><span class="token punctuation">,</span> <span class="token property">"template_type"</span><span class="token operator">:</span> <span class="token string">"classic"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>...<span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>...<span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="add-attachment-to-a-retainer-invoice" class="scroll-observer pt-70">Add attachment to a retainer invoice</h2> <p> Attach a file to an invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> <h3 id="arguments" class="properties"> Arguments </h3> <div class="parameter"> <div class="row" id=add-attachment-to-a-retainer-invoice-can_send_in_mail> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> can_send_in_mail </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=add-attachment-to-a-retainer-invoice-attachment> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> attachment </div> <div class="property-datatype"> binary </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The file to be attached. It has to be sent in multipart/formdata</div> </div> </div> </div> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_add-attachment-to-a-retainer-invoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_add-attachment-to-a-retainer-invoice">parameters_data<span class="token operator">=</span><span class="token string">'{"field1":"value1","field2":"value2"}'</span><span class="token punctuation">;</span> headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">content-type</span><span class="token punctuation">:</span> application<span class="token operator">/</span>json <span class="token property">parameters</span><span class="token punctuation">:</span> parameters_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_add-attachment-to-a-retainer-invoice"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">MediaType</span> mediaType <span class="token operator">=</span> <span class="token class-name">MediaType</span><span class="token punctuation">.</span><span class="token function">parse</span><span class="token punctuation">(</span><span class="token string">"application/json"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">RequestBody</span> body <span class="token operator">=</span> <span class="token class-name">RequestBody</span><span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>mediaType<span class="token punctuation">,</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span>body<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"content-type"</span><span class="token punctuation">,</span> <span class="token string">"application/json"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_add-attachment-to-a-retainer-invoice"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span><span class="token punctuation">,</span> <span class="token string-property property">'content-type'</span><span class="token operator">:</span> <span class="token string">'application/json'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token literal-property property">body</span><span class="token operator">:</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_add-attachment-to-a-retainer-invoice"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> payload <span class="token operator">=</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string">'content-type'</span><span class="token punctuation">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695"</span><span class="token punctuation">,</span> payload<span class="token punctuation">,</span> headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_add-attachment-to-a-retainer-invoice"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string-property property">"content-type"</span><span class="token operator">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">write</span><span class="token punctuation">(</span><span class="token constant">JSON</span><span class="token punctuation">.</span><span class="token function">stringify</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token literal-property property">field1</span><span class="token operator">:</span> <span class="token string">'value1'</span><span class="token punctuation">,</span> <span class="token literal-property property">field2</span><span class="token operator">:</span> <span class="token string">'value2'</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_add-attachment-to-a-retainer-invoice"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'content-type: application/json'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--data</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span></code> </div> </div> <div class="request-topbar mt-60"> <p> Body Parameters </p> <div class="tooltiptext ml-auto"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('params_add-attachment-to-a-retainer-invoice',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> <div class="codebag codebag-code" data-simplebar> <div class="codesnippets" style="display: inline;"> <code data-snippet-id="params_add-attachment-to-a-retainer-invoice"><span class="token punctuation">{</span> <span class="token property">"can_send_in_mail"</span><span class="token operator">:</span> <span class="token boolean">true</span><span class="token punctuation">,</span> <span class="token property">"attachment"</span><span class="token operator">:</span> <span class="token string">"string"</span> <span class="token punctuation">}</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Your file has been attached."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="get-a-retainer-invoice-attachment" class="scroll-observer pt-70">Get a retainer invoice attachment</h2> <p> Returns the file attached to the retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.READ</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_get-a-retainer-invoice-attachment',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_get-a-retainer-invoice-attachment">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">GET</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_get-a-retainer-invoice-attachment"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_get-a-retainer-invoice-attachment"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_get-a-retainer-invoice-attachment"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_get-a-retainer-invoice-attachment"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_get-a-retainer-invoice-attachment"><span class="token function">curl</span> <span class="token parameter variable">--request</span> GET <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/attachment?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"success"</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="delete-an-attachment" class="scroll-observer pt-70">Delete an attachment</h2> <p> Delete the file attached to the retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.DELETE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_delete-an-attachment',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_delete-an-attachment">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/documents/?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">DELETE</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_delete-an-attachment"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/documents/?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">delete</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_delete-an-attachment"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'DELETE'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/documents/?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_delete-an-attachment"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"DELETE"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/documents/?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_delete-an-attachment"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"DELETE"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/documents/?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_delete-an-attachment"><span class="token function">curl</span> <span class="token parameter variable">--request</span> DELETE <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/documents/?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Your file is no longer attached to the invoice."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="add-comment" class="scroll-observer pt-70">Add comment</h2> <p> Add a comment for a retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.CREATE</span></code> </p> <h3 id="arguments" class="properties"> Arguments </h3> <div class="parameter"> <div class="row" id=add-comment-description> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> description </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The description of the line items. Max-length [2000]</div> </div> </div> <div class="row" id=add-comment-payment_expected_date> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> payment_expected_date </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> </div> </div> <div class="row" id=add-comment-show_comment_to_clients> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> show_comment_to_clients </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean to check if the comment to be shown to the clients</div> </div> </div> </div> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_add-comment',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_add-comment">parameters_data<span class="token operator">=</span><span class="token string">'{"field1":"value1","field2":"value2"}'</span><span class="token punctuation">;</span> headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">POST</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">content-type</span><span class="token punctuation">:</span> application<span class="token operator">/</span>json <span class="token property">parameters</span><span class="token punctuation">:</span> parameters_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_add-comment"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">MediaType</span> mediaType <span class="token operator">=</span> <span class="token class-name">MediaType</span><span class="token punctuation">.</span><span class="token function">parse</span><span class="token punctuation">(</span><span class="token string">"application/json"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">RequestBody</span> body <span class="token operator">=</span> <span class="token class-name">RequestBody</span><span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>mediaType<span class="token punctuation">,</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">post</span><span class="token punctuation">(</span>body<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"content-type"</span><span class="token punctuation">,</span> <span class="token string">"application/json"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_add-comment"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'POST'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span><span class="token punctuation">,</span> <span class="token string-property property">'content-type'</span><span class="token operator">:</span> <span class="token string">'application/json'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token literal-property property">body</span><span class="token operator">:</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_add-comment"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> payload <span class="token operator">=</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string">'content-type'</span><span class="token punctuation">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695"</span><span class="token punctuation">,</span> payload<span class="token punctuation">,</span> headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_add-comment"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"POST"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string-property property">"content-type"</span><span class="token operator">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">write</span><span class="token punctuation">(</span><span class="token constant">JSON</span><span class="token punctuation">.</span><span class="token function">stringify</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token literal-property property">field1</span><span class="token operator">:</span> <span class="token string">'value1'</span><span class="token punctuation">,</span> <span class="token literal-property property">field2</span><span class="token operator">:</span> <span class="token string">'value2'</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_add-comment"><span class="token function">curl</span> <span class="token parameter variable">--request</span> POST <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'content-type: application/json'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--data</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span></code> </div> </div> <div class="request-topbar mt-60"> <p> Body Parameters </p> <div class="tooltiptext ml-auto"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('params_add-comment',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> <div class="codebag codebag-code" data-simplebar> <div class="codesnippets" style="display: inline;"> <code data-snippet-id="params_add-comment"><span class="token punctuation">{</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"comment added"</span><span class="token punctuation">,</span> <span class="token property">"payment_expected_date"</span><span class="token operator">:</span> <span class="token string">" "</span><span class="token punctuation">,</span> <span class="token property">"show_comment_to_clients"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Comments added."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="list-retainer-invoice-comments-and-history" class="scroll-observer pt-70">List retainer invoice comments & history</h2> <p> Get the complete history and comments of a retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.READ</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_list-retainer-invoice-comments-and-history',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_list-retainer-invoice-comments-and-history">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">GET</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_list-retainer-invoice-comments-and-history"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">get</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_list-retainer-invoice-comments-and-history"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'GET'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_list-retainer-invoice-comments-and-history"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_list-retainer-invoice-comments-and-history"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"GET"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_list-retainer-invoice-comments-and-history"><span class="token function">curl</span> <span class="token parameter variable">--request</span> GET <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"success"</span><span class="token punctuation">,</span> <span class="token property">"comments"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"comment_id"</span><span class="token operator">:</span> <span class="token number">982000000567019</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice_id"</span><span class="token operator">:</span> <span class="token number">982000000567114</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"500GB, USB 2.0 interface 1400 rpm, protective hard case."</span><span class="token punctuation">,</span> <span class="token property">"commented_by_id"</span><span class="token operator">:</span> <span class="token number">982000000554041</span><span class="token punctuation">,</span> <span class="token property">"commented_by"</span><span class="token operator">:</span> <span class="token string">"John David"</span><span class="token punctuation">,</span> <span class="token property">"comment_type"</span><span class="token operator">:</span> <span class="token string">"system"</span><span class="token punctuation">,</span> <span class="token property">"operation_type"</span><span class="token operator">:</span> <span class="token string">"Added"</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"date_description"</span><span class="token operator">:</span> <span class="token string">"yesterday"</span><span class="token punctuation">,</span> <span class="token property">"time"</span><span class="token operator">:</span> <span class="token string">"2:38 AM"</span><span class="token punctuation">,</span> <span class="token property">"transaction_id"</span><span class="token operator">:</span> <span class="token string">"982000000567204"</span><span class="token punctuation">,</span> <span class="token property">"transaction_type"</span><span class="token operator">:</span> <span class="token string">"retainer_payment"</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>...<span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span>...<span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="update-comment" class="scroll-observer pt-70">Update comment</h2> <p> Update an existing comment of a retainer invoice. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.UPDATE</span></code> </p> <h3 id="arguments" class="properties"> Arguments </h3> <div class="parameter"> <div class="row" id=update-comment-description> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> description </div> <div class="property-datatype"> string </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">The comment on a retainer invoice</div> </div> </div> <div class="row" id=update-comment-show_comment_to_clients> <div class="property-wrapper"> <div class="table-flex"> <div class="property"> show_comment_to_clients </div> <div class="property-datatype"> boolean </div> <div class="property-kind" id="Optional"> </div> </div> <div class="prop-descrip">Boolean to check if the comment to be shown to the clients</div> </div> </div> </div> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_update-comment',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_update-comment">parameters_data<span class="token operator">=</span><span class="token string">'{"field1":"value1","field2":"value2"}'</span><span class="token punctuation">;</span> headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">PUT</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">content-type</span><span class="token punctuation">:</span> application<span class="token operator">/</span>json <span class="token property">parameters</span><span class="token punctuation">:</span> parameters_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_update-comment"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">MediaType</span> mediaType <span class="token operator">=</span> <span class="token class-name">MediaType</span><span class="token punctuation">.</span><span class="token function">parse</span><span class="token punctuation">(</span><span class="token string">"application/json"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">RequestBody</span> body <span class="token operator">=</span> <span class="token class-name">RequestBody</span><span class="token punctuation">.</span><span class="token function">create</span><span class="token punctuation">(</span>mediaType<span class="token punctuation">,</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">put</span><span class="token punctuation">(</span>body<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"content-type"</span><span class="token punctuation">,</span> <span class="token string">"application/json"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_update-comment"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'PUT'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span><span class="token punctuation">,</span> <span class="token string-property property">'content-type'</span><span class="token operator">:</span> <span class="token string">'application/json'</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token literal-property property">body</span><span class="token operator">:</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_update-comment"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> payload <span class="token operator">=</span> <span class="token string">"{\"field1\":\"value1\",\"field2\":\"value2\"}"</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string">'content-type'</span><span class="token punctuation">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"PUT"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695"</span><span class="token punctuation">,</span> payload<span class="token punctuation">,</span> headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_update-comment"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"PUT"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">,</span> <span class="token string-property property">"content-type"</span><span class="token operator">:</span> <span class="token string">"application/json"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">write</span><span class="token punctuation">(</span><span class="token constant">JSON</span><span class="token punctuation">.</span><span class="token function">stringify</span><span class="token punctuation">(</span><span class="token punctuation">{</span><span class="token literal-property property">field1</span><span class="token operator">:</span> <span class="token string">'value1'</span><span class="token punctuation">,</span> <span class="token literal-property property">field2</span><span class="token operator">:</span> <span class="token string">'value2'</span><span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_update-comment"><span class="token function">curl</span> <span class="token parameter variable">--request</span> PUT <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'content-type: application/json'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--data</span> <span class="token string">'{"field1":"value1","field2":"value2"}'</span></code> </div> </div> <div class="request-topbar mt-60"> <p> Body Parameters </p> <div class="tooltiptext ml-auto"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('params_update-comment',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> <div class="codebag codebag-code" data-simplebar> <div class="codesnippets" style="display: inline;"> <code data-snippet-id="params_update-comment"><span class="token punctuation">{</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"show_comment_to_clients"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"The comment has been updated."</span><span class="token punctuation">,</span> <span class="token property">"comment"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"comment_id"</span><span class="token operator">:</span> <span class="token number">982000000567019</span><span class="token punctuation">,</span> <span class="token property">"retainerinvoice_id"</span><span class="token operator">:</span> <span class="token number">982000000567114</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"500GB, USB 2.0 interface 1400 rpm, protective hard case."</span><span class="token punctuation">,</span> <span class="token property">"commented_by_id"</span><span class="token operator">:</span> <span class="token number">982000000554041</span><span class="token punctuation">,</span> <span class="token property">"commented_by"</span><span class="token operator">:</span> <span class="token string">"John David"</span><span class="token punctuation">,</span> <span class="token property">"date"</span><span class="token operator">:</span> <span class="token string">"2013-11-17"</span><span class="token punctuation">,</span> <span class="token property">"date_description"</span><span class="token operator">:</span> <span class="token string">"yesterday"</span><span class="token punctuation">,</span> <span class="token property">"time"</span><span class="token operator">:</span> <span class="token string">"2:38 AM"</span><span class="token punctuation">,</span> <span class="token property">"comment_type"</span><span class="token operator">:</span> <span class="token string">"system"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> <div class="divider"></div> <div class="wrapper"> <div class="flex-wrapper"> <div class="flex-wrapper-left"> <h2 id="delete-a-comment" class="scroll-observer pt-70">Delete a comment</h2> <p> Delete a retainer invoice comment. <br> <code>OAuth Scope : <span class="oauth-scope">ZohoBooks.invoices.DELETE</span></code> </p> </div> <div class="flex-wrapper-right request-top pt-70"> <div class="request-topbar"> <p> Request Example </p> <div class="ml-auto d-flex align-items-center"> <div class="dropdown-container"> <button role="button" class="dropdown-btn" onclick="dropDownClicked(this)"></button> <div class="dropdown-content d-none"> <ul class="m-3 pl-0 list-none"> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"cURL","id":"shell_curl"})">cURL</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Deluge","id":"deluge"})">Deluge</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Java","id":"java_okhttp"})">Java</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Node.js","id":"node_native"})">Node.js</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Javascript","id":"javascript_fetch"})">Javascript</button> </li> <li> <button role="option" class="dropdown-btn-item" onclick="changeLanguage({"name":"Python","id":"python_python3"})">Python</button> </li> </ul> </div> </div> <div class="tooltiptext"> <span role="tooltip" class="tooltip tooltipcopytext"> <span class="copytext">Click to copy </span> <div class="arrow" data-popper-arrow></div> </span> <button onclick="copyToClipboard('snippet_delete-a-comment',this)" class="copybutton"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512" xml:space="preserve" class="copyimage"><g fill="#9F9FAB"><path d="M477.6 346c-13.8 0-25-11.2-25-25V71c0-6.4-5.2-11.6-11.6-11.6H191c-13.8 0-25-11.2-25-25s11.2-25 25-25h250c34 0 61.6 27.6 61.6 61.6v250c0 13.8-11.2 25-25 25z"/><path d="M331 492.6H81c-34 0-61.6-27.6-61.6-61.6V181c0-34 27.6-61.6 61.6-61.6h250c34 0 61.6 27.6 61.6 61.6v250c0 33.9-27.7 61.6-61.6 61.6zM81 169.4c-6.4 0-11.6 5.2-11.6 11.6v250c0 6.4 5.2 11.6 11.6 11.6h250c6.4 0 11.6-5.2 11.6-11.6V181c0-6.4-5.2-11.6-11.6-11.6H81z"/></g></svg> </button> </div> </div> </div> <div class="codebag codebag-code code-snippets" data-simplebar > <div class="deluge d-none"> <code data-snippet-id="deluge_delete-a-comment">headers_data <span class="token operator">=</span> <span class="token function">Map</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> headers_data<span class="token operator">.</span><span class="token function">put</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token operator">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> response <span class="token operator">=</span> <span class="token keyword">invokeUrl</span> <span class="token punctuation">[</span> <span class="token property">url</span><span class="token punctuation">:</span> <span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695"</span> <span class="token property">type</span><span class="token punctuation">:</span> <span class="token keyword">DELETE</span> <span class="token property">headers</span><span class="token punctuation">:</span> headers_data <span class="token property">connection</span><span class="token punctuation">:</span> <span class="token operator"><</span>connection_name<span class="token operator">></span> <span class="token punctuation">]</span> <span class="token keyword">info</span> response<span class="token punctuation">;</span></code> </div> <div class="java_okhttp d-none"> <code data-snippet-id="java_okhttp_delete-a-comment"><span class="token class-name">OkHttpClient</span> client <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">OkHttpClient</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Request</span> request <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Request<span class="token punctuation">.</span>Builder</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">url</span><span class="token punctuation">(</span><span class="token string">"https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">delete</span><span class="token punctuation">(</span><span class="token keyword">null</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">addHeader</span><span class="token punctuation">(</span><span class="token string">"Authorization"</span><span class="token punctuation">,</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">build</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token class-name">Response</span> response <span class="token operator">=</span> client<span class="token punctuation">.</span><span class="token function">newCall</span><span class="token punctuation">(</span>request<span class="token punctuation">)</span><span class="token punctuation">.</span><span class="token function">execute</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="javascript_fetch d-none"> <code data-snippet-id="javascript_fetch_delete-a-comment"><span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token literal-property property">method</span><span class="token operator">:</span> <span class="token string">'DELETE'</span><span class="token punctuation">,</span> <span class="token literal-property property">headers</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token literal-property property">Authorization</span><span class="token operator">:</span> <span class="token string">'Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token function">fetch</span><span class="token punctuation">(</span><span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695'</span><span class="token punctuation">,</span> options<span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> response<span class="token punctuation">.</span><span class="token function">json</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">then</span><span class="token punctuation">(</span><span class="token parameter">response</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>response<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token punctuation">.</span><span class="token function">catch</span><span class="token punctuation">(</span><span class="token parameter">err</span> <span class="token operator">=></span> console<span class="token punctuation">.</span><span class="token function">error</span><span class="token punctuation">(</span>err<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="python_python3 d-none"> <code data-snippet-id="python_python3_delete-a-comment"><span class="token keyword">import</span> http<span class="token punctuation">.</span>client conn <span class="token operator">=</span> http<span class="token punctuation">.</span>client<span class="token punctuation">.</span>HTTPSConnection<span class="token punctuation">(</span><span class="token string">"www.zohoapis.com"</span><span class="token punctuation">)</span> headers <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string">'Authorization'</span><span class="token punctuation">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> conn<span class="token punctuation">.</span>request<span class="token punctuation">(</span><span class="token string">"DELETE"</span><span class="token punctuation">,</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695"</span><span class="token punctuation">,</span> headers<span class="token operator">=</span>headers<span class="token punctuation">)</span> res <span class="token operator">=</span> conn<span class="token punctuation">.</span>getresponse<span class="token punctuation">(</span><span class="token punctuation">)</span> data <span class="token operator">=</span> res<span class="token punctuation">.</span>read<span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token keyword">print</span><span class="token punctuation">(</span>data<span class="token punctuation">.</span>decode<span class="token punctuation">(</span><span class="token string">"utf-8"</span><span class="token punctuation">)</span><span class="token punctuation">)</span></code> </div> <div class="node_native d-none"> <code data-snippet-id="node_native_delete-a-comment"><span class="token keyword">const</span> http <span class="token operator">=</span> <span class="token function">require</span><span class="token punctuation">(</span><span class="token string">"https"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">const</span> options <span class="token operator">=</span> <span class="token punctuation">{</span> <span class="token string-property property">"method"</span><span class="token operator">:</span> <span class="token string">"DELETE"</span><span class="token punctuation">,</span> <span class="token string-property property">"hostname"</span><span class="token operator">:</span> <span class="token string">"www.zohoapis.com"</span><span class="token punctuation">,</span> <span class="token string-property property">"port"</span><span class="token operator">:</span> <span class="token keyword">null</span><span class="token punctuation">,</span> <span class="token string-property property">"path"</span><span class="token operator">:</span> <span class="token string">"/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695"</span><span class="token punctuation">,</span> <span class="token string-property property">"headers"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"Authorization"</span><span class="token operator">:</span> <span class="token string">"Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">;</span> <span class="token keyword">const</span> req <span class="token operator">=</span> http<span class="token punctuation">.</span><span class="token function">request</span><span class="token punctuation">(</span>options<span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">res</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> chunks <span class="token operator">=</span> <span class="token punctuation">[</span><span class="token punctuation">]</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"data"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token parameter">chunk</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> chunks<span class="token punctuation">.</span><span class="token function">push</span><span class="token punctuation">(</span>chunk<span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> res<span class="token punctuation">.</span><span class="token function">on</span><span class="token punctuation">(</span><span class="token string">"end"</span><span class="token punctuation">,</span> <span class="token keyword">function</span> <span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{</span> <span class="token keyword">const</span> body <span class="token operator">=</span> Buffer<span class="token punctuation">.</span><span class="token function">concat</span><span class="token punctuation">(</span>chunks<span class="token punctuation">)</span><span class="token punctuation">;</span> console<span class="token punctuation">.</span><span class="token function">log</span><span class="token punctuation">(</span>body<span class="token punctuation">.</span><span class="token function">toString</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span><span class="token punctuation">)</span><span class="token punctuation">;</span> req<span class="token punctuation">.</span><span class="token function">end</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span></code> </div> <div class="shell_curl d-none"> <code data-snippet-id="shell_curl_delete-a-comment"><span class="token function">curl</span> <span class="token parameter variable">--request</span> DELETE <span class="token punctuation">\</span> <span class="token parameter variable">--url</span> <span class="token string">'https://www.zohoapis.com/books/v3/retainerinvoices/982000000567114/comments/982000000567019?organization_id=10234695'</span> <span class="token punctuation">\</span> <span class="token parameter variable">--header</span> <span class="token string">'Authorization: Zoho-oauthtoken 1000.41d9xxxxxxxxxxxxxxxxxxxxxxxxc2d1.8fccxxxxxxxxxxxxxxxxxxxxxxxx125f'</span></code> </div> </div> <p class="response-topbar mt-60"> Response Example </p> <div class="responsebg pd-bottom" data-simplebar> <code><span class="token punctuation">{</span> <span class="token property">"code"</span><span class="token operator">:</span> <span class="token number">0</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"The comment has been deleted."</span> <span class="token punctuation">}</span></code> </div> </div> </div> </div> </div> </div> </div> </div> <script type="text/javascript" src="/books/api/v3/js/vendor.js"></script> <script src="/books/api/v3/js/app.js"></script> <template role="none" id="search-result-template"> <a target="_self" onclick="goToSearchResult(this)"> <div class="result-link" onmousemove="showPropDescription(this)"> <div class="result-link-padding"> <div class="result-first-line"> <span class="result-prop-name"></span> <span class="result-prop-title"></span> </div> <div class="result-second-line"> <span class="result-prop-description">${resultObj.description}</span> </div> </div> </div> </a> </template> </body> </html>

CINXE.COM

Retainer Invoices | Zoho Books | API Documentation