List invoices

GET {{baseUrl}}/api/v1/zohoFinance/:financeService/invoices?deskModuleName=<String>

To list invoices.

OAuth Scope

  • Desk.integrations.READ

Request Params

KeyDatatypeRequiredDescription
deskEntityIdstringTo fetch invoice by desk contact or account or ticket id
deskModuleNamestringDesk Module Name: Contacts or Cases or Accounts
departmentIdstringDepartment Id
statusstringTo fetch invoice by status, Available status are sent, draft, overdue, paid, void, unpaid, partially_paid and viewed
pageNumberstringpage number

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring

RESPONSES

status: OK

{&quot;deskEntityId&quot;:&quot;5000000014010&quot;,&quot;data&quot;:[{&quot;date&quot;:&quot;2018-09-23&quot;,&quot;total&quot;:117,&quot;isViewdByClient&quot;:false,&quot;totalFormatted&quot;:&quot;AED117.00&quot;,&quot;invoiceNumber&quot;:&quot;INV-000025&quot;,&quot;id&quot;:&quot;1332784000000108001&quot;,&quot;dateFormatted&quot;:&quot;23 Sep 2018&quot;,&quot;currencyCode&quot;:&quot;AED&quot;,&quot;statusFormatted&quot;:&quot;Draft&quot;,&quot;status&quot;:&quot;draft&quot;}],&quot;deskModuleName&quot;:&quot;Contacts&quot;}