agent-generator-cli 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (766) hide show
  1. package/README.md +2 -22
  2. package/install-extension.js +89 -0
  3. package/main.js +45 -7
  4. package/package.json +21 -8
  5. package/source/api-data-generators/.idea/api-data-generators.iml +9 -0
  6. package/source/api-data-generators/.idea/misc.xml +6 -0
  7. package/source/api-data-generators/.idea/modules.xml +8 -0
  8. package/source/api-data-generators/.idea/vcs.xml +6 -0
  9. package/source/api-data-generators/portal/ArticleComment/test_data_generation_configurations.json +318 -0
  10. package/source/api-data-generators/portal/ArticleFeedback/test_data_generation_configurations.json +32 -0
  11. package/source/api-data-generators/portal/AsapMobile/test_data_generation_configurations.json +21 -0
  12. package/source/api-data-generators/portal/AsapWeb/test_data_generation_configurations.json +18 -0
  13. package/source/api-data-generators/portal/Category/test_data_generation_configurations.json +39 -0
  14. package/source/api-data-generators/portal/Comment/test_data_generation_configurations.json +157 -0
  15. package/source/api-data-generators/portal/Community/test_data_generation_configurations.json +46 -0
  16. package/source/api-data-generators/portal/CommunityUser/test_data_generation_configurations.json +16 -0
  17. package/source/api-data-generators/portal/Contact/test_data_generation_configurations.json +33 -0
  18. package/source/api-data-generators/portal/Department/test_data_generation_configurations.json +13 -0
  19. package/source/api-data-generators/portal/Extension/test_data_generation_configurations.json +91 -0
  20. package/source/api-data-generators/portal/FeedbackWidget/test_data_generation_configurations.json +18 -0
  21. package/source/api-data-generators/portal/FileExport/test_data_generation_configurations.json +42 -0
  22. package/source/api-data-generators/portal/Followers/test_data_generation_configurations.json +92 -0
  23. package/source/api-data-generators/portal/Gamification/test_data_generation_configurations.json +51 -0
  24. package/source/api-data-generators/portal/HelpCenters/test_data_generation_configurations.json +11 -0
  25. package/source/api-data-generators/portal/Helpcenter/test_data_generation_configurations.json +41 -0
  26. package/source/api-data-generators/portal/HelpcenterGroups/test_data_generation_configurations.json +18 -0
  27. package/source/api-data-generators/portal/KBRootCategory/test_data_generation_configurations.json +76 -0
  28. package/source/api-data-generators/portal/KbCategory/test_data_generation_configurations.json +51 -0
  29. package/source/api-data-generators/portal/KbSection/test_data_generation_configurations.json +25 -0
  30. package/source/api-data-generators/portal/KnowledgeBase/test_data_generation_configurations.json +26 -0
  31. package/source/api-data-generators/portal/Label/test_data_generation_configurations.json +18 -0
  32. package/source/api-data-generators/portal/Layout/test_data_generation_configurations.json +17 -0
  33. package/source/api-data-generators/portal/LayoutRules/test_data_generation_configurations.json +17 -0
  34. package/source/api-data-generators/portal/NewAsapMobile/test_data_generation_configurations.json +21 -0
  35. package/source/api-data-generators/portal/Permalink/test_data_generation_configurations.json +32 -0
  36. package/source/api-data-generators/portal/Product/test_data_generation_configurations.json +43 -0
  37. package/source/api-data-generators/portal/Solution/test_data_generation_configurations.json +631 -0
  38. package/source/api-data-generators/portal/Thread/test_data_generation_configurations.json +70 -0
  39. package/source/api-data-generators/portal/Ticket/test_data_generation_configurations.json +294 -0
  40. package/source/api-data-generators/portal/TicketComment/test_data_generation_configurations.json +58 -0
  41. package/source/api-data-generators/portal/TicketCount/test_data_generation_configurations.json +74 -0
  42. package/source/api-data-generators/portal/TicketStatusMapping/test_data_generation_configurations.json +11 -0
  43. package/source/api-data-generators/portal/TicketTemplate/test_data_generation_configurations.json +24 -0
  44. package/source/api-data-generators/portal/Topic/test_data_generation_configurations.json +259 -0
  45. package/source/api-data-generators/portal/Translation/test_data_generation_configurations.json +6 -0
  46. package/source/api-data-generators/portal/ValidationRules/test_data_generation_configurations.json +14 -0
  47. package/source/api-data-generators/portal/View/test_data_generation_configurations.json +19 -0
  48. package/source/api-data-generators/support/Account/test_data_generation_configurations.json +265 -0
  49. package/source/api-data-generators/support/AccountAttachment/test_data_generation_configurations.json +48 -0
  50. package/source/api-data-generators/support/AccountComments/test_data_generation_configurations.json +47 -0
  51. package/source/api-data-generators/support/AccountContactMappingInfo/test_data_generation_configurations.json +14 -0
  52. package/source/api-data-generators/support/AccountFollowers/test_data_generation_configurations.json +52 -0
  53. package/source/api-data-generators/support/AccountSla/test_data_generation_configurations.json +33 -0
  54. package/source/api-data-generators/support/AccountTimeEntry/test_data_generation_configurations.json +45 -0
  55. package/source/api-data-generators/support/ActiveCalls/test_data_generation_configurations.json +38 -0
  56. package/source/api-data-generators/support/Activity/test_data_generation_configurations.json +50 -0
  57. package/source/api-data-generators/support/ActorsAPI/test_data_generation_configurations.json +22 -0
  58. package/source/api-data-generators/support/Agent/test_data_generation_configurations.json +217 -0
  59. package/source/api-data-generators/support/AgentPresence/test_data_generation_configurations.json +30 -0
  60. package/source/api-data-generators/support/AgentSignatures/test_data_generation_configurations.json +31 -0
  61. package/source/api-data-generators/support/AgentTimeEntry/test_data_generation_configurations.json +36 -0
  62. package/source/api-data-generators/support/AntiSpamInfo/test_data_generation_configurations.json +32 -0
  63. package/source/api-data-generators/support/ApiCreditNotificationRule/test_data_generation_configurations.json +49 -0
  64. package/source/api-data-generators/support/ArchivedView/test_data_generation_configurations.json +66 -0
  65. package/source/api-data-generators/support/Article/test_data_generation_configurations.json +294 -0
  66. package/source/api-data-generators/support/ArticleAttachment/test_data_generation_configurations.json +150 -0
  67. package/source/api-data-generators/support/ArticleComment/test_data_generation_configurations.json +238 -0
  68. package/source/api-data-generators/support/ArticleFeedback/test_data_generation_configurations.json +147 -0
  69. package/source/api-data-generators/support/ArticleFeedbackResolution/test_data_generation_configurations.json +56 -0
  70. package/source/api-data-generators/support/ArticleStatistics/test_data_generation_configurations.json +397 -0
  71. package/source/api-data-generators/support/ArticleTranslation/test_data_generation_configurations.json +1123 -0
  72. package/source/api-data-generators/support/ArticleVersion/test_data_generation_configurations.json +26 -0
  73. package/source/api-data-generators/support/ArticleViews/test_data_generation_configurations.json +26 -0
  74. package/source/api-data-generators/support/Asap/test_data_generation_configurations.json +49 -0
  75. package/source/api-data-generators/support/AuditLog/test_data_generation_configurations.json +58 -0
  76. package/source/api-data-generators/support/AutomationAlerts/test_data_generation_configurations.json +27 -0
  77. package/source/api-data-generators/support/AutomationEngine/test_data_generation_configurations.json +20 -0
  78. package/source/api-data-generators/support/AutomationFeatureCount/test_data_generation_configurations.json +13 -0
  79. package/source/api-data-generators/support/AutomationFieldUpdates/test_data_generation_configurations.json +24 -0
  80. package/source/api-data-generators/support/AutomationTask/test_data_generation_configurations.json +29 -0
  81. package/source/api-data-generators/support/Backup/test_data_generation_configurations.json +115 -0
  82. package/source/api-data-generators/support/Badge/test_data_generation_configurations.json +64 -0
  83. package/source/api-data-generators/support/Bot/test_data_generation_configurations.json +288 -0
  84. package/source/api-data-generators/support/BotInference/test_data_generation_configurations.json +119 -0
  85. package/source/api-data-generators/support/BugInteg/test_data_generation_configurations.json +37 -0
  86. package/source/api-data-generators/support/BulkAction/test_data_generation_configurations.json +26 -0
  87. package/source/api-data-generators/support/BulkImport/test_data_generation_configurations.json +211 -0
  88. package/source/api-data-generators/support/BulkUpdate/test_data_generation_configurations.json +40 -0
  89. package/source/api-data-generators/support/BulkWrite/test_data_generation_configurations.json +32 -0
  90. package/source/api-data-generators/support/BusinessHour/test_data_generation_configurations.json +72 -0
  91. package/source/api-data-generators/support/Call/test_data_generation_configurations.json +247 -0
  92. package/source/api-data-generators/support/CallComments/test_data_generation_configurations.json +51 -0
  93. package/source/api-data-generators/support/CallHistory/test_data_generation_configurations.json +65 -0
  94. package/source/api-data-generators/support/CallTimeEntry/test_data_generation_configurations.json +77 -0
  95. package/source/api-data-generators/support/CallTimer/test_data_generation_configurations.json +14 -0
  96. package/source/api-data-generators/support/Channel/test_data_generation_configurations.json +44 -0
  97. package/source/api-data-generators/support/Chart/test_data_generation_configurations.json +35 -0
  98. package/source/api-data-generators/support/ChatTicket/test_data_generation_configurations.json +185 -0
  99. package/source/api-data-generators/support/Common/test_data_generation_configurations.json +43 -0
  100. package/source/api-data-generators/support/Community/test_data_generation_configurations.json +313 -0
  101. package/source/api-data-generators/support/CommunityAttachment/test_data_generation_configurations.json +16 -0
  102. package/source/api-data-generators/support/CommunityCategory/test_data_generation_configurations.json +121 -0
  103. package/source/api-data-generators/support/CommunityComment/test_data_generation_configurations.json +350 -0
  104. package/source/api-data-generators/support/CommunityInitPermissions/test_data_generation_configurations.json +16 -0
  105. package/source/api-data-generators/support/CommunityPreferences/test_data_generation_configurations.json +19 -0
  106. package/source/api-data-generators/support/CommunityTopic/test_data_generation_configurations.json +509 -0
  107. package/source/api-data-generators/support/CommunityTopicInsights/test_data_generation_configurations.json +32 -0
  108. package/source/api-data-generators/support/CommunityUser/test_data_generation_configurations.json +63 -0
  109. package/source/api-data-generators/support/Contact/test_data_generation_configurations.json +370 -0
  110. package/source/api-data-generators/support/ContactAttachment/test_data_generation_configurations.json +44 -0
  111. package/source/api-data-generators/support/ContactComments/test_data_generation_configurations.json +47 -0
  112. package/source/api-data-generators/support/ContactFollowers/test_data_generation_configurations.json +52 -0
  113. package/source/api-data-generators/support/ContactProfile/test_data_generation_configurations.json +11 -0
  114. package/source/api-data-generators/support/ContactTimeEntry/test_data_generation_configurations.json +45 -0
  115. package/source/api-data-generators/support/Contract/test_data_generation_configurations.json +184 -0
  116. package/source/api-data-generators/support/ContractAttachment/test_data_generation_configurations.json +30 -0
  117. package/source/api-data-generators/support/CreateTicket/test_data_generation_configurations.json +93 -0
  118. package/source/api-data-generators/support/Criteria/test_data_generation_configurations.json +19 -0
  119. package/source/api-data-generators/support/CrmInteg/test_data_generation_configurations.json +202 -0
  120. package/source/api-data-generators/support/CustomAction/test_data_generation_configurations.json +56 -0
  121. package/source/api-data-generators/support/CustomActionRuleMapping/test_data_generation_configurations.json +334 -0
  122. package/source/api-data-generators/support/CustomButton/test_data_generation_configurations.json +113 -0
  123. package/source/api-data-generators/support/CustomFunctionExecutionLogs/test_data_generation_configurations.json +68 -0
  124. package/source/api-data-generators/support/CustomFunctionGallery/test_data_generation_configurations.json +16 -0
  125. package/source/api-data-generators/support/CustomFunctions/test_data_generation_configurations.json +270 -0
  126. package/source/api-data-generators/support/CustomTheme/test_data_generation_configurations.json +70 -0
  127. package/source/api-data-generators/support/CustomView/test_data_generation_configurations.json +486 -0
  128. package/source/api-data-generators/support/CustomerHappiness/test_data_generation_configurations.json +77 -0
  129. package/source/api-data-generators/support/DashboardComponent/test_data_generation_configurations.json +305 -0
  130. package/source/api-data-generators/support/DashboardFolder/test_data_generation_configurations.json +126 -0
  131. package/source/api-data-generators/support/DashboardMetrics/test_data_generation_configurations.json +205 -0
  132. package/source/api-data-generators/support/Dashboards/test_data_generation_configurations.json +90 -0
  133. package/source/api-data-generators/support/DataChips/test_data_generation_configurations.json +33 -0
  134. package/source/api-data-generators/support/DataSync/test_data_generation_configurations.json +228 -0
  135. package/source/api-data-generators/support/DeleteTicket/test_data_generation_configurations.json +44 -0
  136. package/source/api-data-generators/support/Department/test_data_generation_configurations.json +156 -0
  137. package/source/api-data-generators/support/DependencyMappings/test_data_generation_configurations.json +50 -0
  138. package/source/api-data-generators/support/DirectAssignRuleTarget/test_data_generation_configurations.json +17 -0
  139. package/source/api-data-generators/support/DirectAssignmentRules/test_data_generation_configurations.json +37 -0
  140. package/source/api-data-generators/support/DisplayEntity/test_data_generation_configurations.json +45 -0
  141. package/source/api-data-generators/support/DomainMapping/test_data_generation_configurations.json +6 -0
  142. package/source/api-data-generators/support/EmailFailureAlert/test_data_generation_configurations.json +21 -0
  143. package/source/api-data-generators/support/EmailTemplates/test_data_generation_configurations.json +106 -0
  144. package/source/api-data-generators/support/EntityBlueprints/test_data_generation_configurations.json +205 -0
  145. package/source/api-data-generators/support/Event/test_data_generation_configurations.json +196 -0
  146. package/source/api-data-generators/support/EventComments/test_data_generation_configurations.json +45 -0
  147. package/source/api-data-generators/support/EventTimeEntry/test_data_generation_configurations.json +77 -0
  148. package/source/api-data-generators/support/EventTimer/test_data_generation_configurations.json +14 -0
  149. package/source/api-data-generators/support/Extension/test_data_generation_configurations.json +689 -0
  150. package/source/api-data-generators/support/FbManager/test_data_generation_configurations.json +64 -0
  151. package/source/api-data-generators/support/Feature/test_data_generation_configurations.json +61 -0
  152. package/source/api-data-generators/support/FeatureFile/test_data_generation_configurations.json +49 -0
  153. package/source/api-data-generators/support/FeatureFolder/test_data_generation_configurations.json +44 -0
  154. package/source/api-data-generators/support/FeaturePermission/test_data_generation_configurations.json +108 -0
  155. package/source/api-data-generators/support/FederatedLogin/test_data_generation_configurations.json +39 -0
  156. package/source/api-data-generators/support/FeedsAPIs/test_data_generation_configurations.json +54 -0
  157. package/source/api-data-generators/support/Field/test_data_generation_configurations.json +1031 -0
  158. package/source/api-data-generators/support/FieldPrediction/test_data_generation_configurations.json +564 -0
  159. package/source/api-data-generators/support/FileExport/test_data_generation_configurations.json +36 -0
  160. package/source/api-data-generators/support/Finance/test_data_generation_configurations.json +180 -0
  161. package/source/api-data-generators/support/Followers/test_data_generation_configurations.json +60 -0
  162. package/source/api-data-generators/support/GC_Bots/test_data_generation_configurations.json +26 -0
  163. package/source/api-data-generators/support/GC_Guide/test_data_generation_configurations.json +240 -0
  164. package/source/api-data-generators/support/GenericAction/test_data_generation_configurations.json +16 -0
  165. package/source/api-data-generators/support/GenericActionMapping/test_data_generation_configurations.json +216 -0
  166. package/source/api-data-generators/support/GoogleAnalytics/test_data_generation_configurations.json +168 -0
  167. package/source/api-data-generators/support/GoogleChat/test_data_generation_configurations.json +29 -0
  168. package/source/api-data-generators/support/Helpcenter/test_data_generation_configurations.json +98 -0
  169. package/source/api-data-generators/support/HelpcenterAutoTranslateSetting/test_data_generation_configurations.json +11 -0
  170. package/source/api-data-generators/support/HelpcenterGroups/test_data_generation_configurations.json +93 -0
  171. package/source/api-data-generators/support/HelpcenterPages/test_data_generation_configurations.json +34 -0
  172. package/source/api-data-generators/support/HelpcenterPreference/test_data_generation_configurations.json +18 -0
  173. package/source/api-data-generators/support/HelpcenterUpload/test_data_generation_configurations.json +25 -0
  174. package/source/api-data-generators/support/HolidayList/test_data_generation_configurations.json +65 -0
  175. package/source/api-data-generators/support/IMCannedMessage/test_data_generation_configurations.json +155 -0
  176. package/source/api-data-generators/support/IMCannedMessageTranslation/test_data_generation_configurations.json +92 -0
  177. package/source/api-data-generators/support/IMTemplateMessage/test_data_generation_configurations.json +22 -0
  178. package/source/api-data-generators/support/IM_AddOn/test_data_generation_configurations.json +19 -0
  179. package/source/api-data-generators/support/IM_Bot/test_data_generation_configurations.json +143 -0
  180. package/source/api-data-generators/support/IM_Broadcast/test_data_generation_configurations.json +39 -0
  181. package/source/api-data-generators/support/IM_Channel/test_data_generation_configurations.json +312 -0
  182. package/source/api-data-generators/support/IM_ChannelPreference/test_data_generation_configurations.json +35 -0
  183. package/source/api-data-generators/support/IM_Contact/test_data_generation_configurations.json +16 -0
  184. package/source/api-data-generators/support/IM_Integration/test_data_generation_configurations.json +32 -0
  185. package/source/api-data-generators/support/IM_Message/test_data_generation_configurations.json +297 -0
  186. package/source/api-data-generators/support/IM_Metrics/test_data_generation_configurations.json +38 -0
  187. package/source/api-data-generators/support/IM_Search/test_data_generation_configurations.json +56 -0
  188. package/source/api-data-generators/support/IM_Session/test_data_generation_configurations.json +149 -0
  189. package/source/api-data-generators/support/IM_TimeSeriesMetrics/test_data_generation_configurations.json +77 -0
  190. package/source/api-data-generators/support/IM_ZiaGpt/test_data_generation_configurations.json +52 -0
  191. package/source/api-data-generators/support/Import/test_data_generation_configurations.json +229 -0
  192. package/source/api-data-generators/support/InlineImage/test_data_generation_configurations.json +16 -0
  193. package/source/api-data-generators/support/IntegModule/test_data_generation_configurations.json +90 -0
  194. package/source/api-data-generators/support/Integrations/test_data_generation_configurations.json +25 -0
  195. package/source/api-data-generators/support/InteractiveTours/test_data_generation_configurations.json +66 -0
  196. package/source/api-data-generators/support/JWT/test_data_generation_configurations.json +49 -0
  197. package/source/api-data-generators/support/KBCategoryUser/test_data_generation_configurations.json +23 -0
  198. package/source/api-data-generators/support/KBRecycleBin/test_data_generation_configurations.json +131 -0
  199. package/source/api-data-generators/support/KBRootCategory/test_data_generation_configurations.json +214 -0
  200. package/source/api-data-generators/support/KBRootCategoryTranslation/test_data_generation_configurations.json +30 -0
  201. package/source/api-data-generators/support/KBSection/test_data_generation_configurations.json +173 -0
  202. package/source/api-data-generators/support/KPIWidget/test_data_generation_configurations.json +21 -0
  203. package/source/api-data-generators/support/KbCategory/test_data_generation_configurations.json +93 -0
  204. package/source/api-data-generators/support/Label/test_data_generation_configurations.json +103 -0
  205. package/source/api-data-generators/support/Layout/test_data_generation_configurations.json +503 -0
  206. package/source/api-data-generators/support/LayoutRuleCriteria/test_data_generation_configurations.json +19 -0
  207. package/source/api-data-generators/support/LayoutRules/test_data_generation_configurations.json +334 -0
  208. package/source/api-data-generators/support/License/test_data_generation_configurations.json +60 -0
  209. package/source/api-data-generators/support/Livecall/test_data_generation_configurations.json +72 -0
  210. package/source/api-data-generators/support/LookupRecord/test_data_generation_configurations.json +34 -0
  211. package/source/api-data-generators/support/Macros/test_data_generation_configurations.json +184 -0
  212. package/source/api-data-generators/support/MailReplyAddress/test_data_generation_configurations.json +32 -0
  213. package/source/api-data-generators/support/MassAction/test_data_generation_configurations.json +38 -0
  214. package/source/api-data-generators/support/Message/test_data_generation_configurations.json +38 -0
  215. package/source/api-data-generators/support/MicrosoftTeams/test_data_generation_configurations.json +50 -0
  216. package/source/api-data-generators/support/Misc/test_data_generation_configurations.json +16 -0
  217. package/source/api-data-generators/support/Module/test_data_generation_configurations.json +96 -0
  218. package/source/api-data-generators/support/NewCriteria/test_data_generation_configurations.json +26 -0
  219. package/source/api-data-generators/support/NewFeatureFields/test_data_generation_configurations.json +19 -0
  220. package/source/api-data-generators/support/NewTicketHistory/test_data_generation_configurations.json +20 -0
  221. package/source/api-data-generators/support/NotificationRules/test_data_generation_configurations.json +27 -0
  222. package/source/api-data-generators/support/OEmbedData/test_data_generation_configurations.json +19 -0
  223. package/source/api-data-generators/support/Onboarding/test_data_generation_configurations.json +29 -0
  224. package/source/api-data-generators/support/Organization/test_data_generation_configurations.json +79 -0
  225. package/source/api-data-generators/support/PBGroup/test_data_generation_configurations.json +109 -0
  226. package/source/api-data-generators/support/PBGroupAgents/test_data_generation_configurations.json +66 -0
  227. package/source/api-data-generators/support/PBPlatform/test_data_generation_configurations.json +113 -0
  228. package/source/api-data-generators/support/PBX/test_data_generation_configurations.json +28 -0
  229. package/source/api-data-generators/support/PBXConfig/test_data_generation_configurations.json +17 -0
  230. package/source/api-data-generators/support/PBXPhoneNumbers/test_data_generation_configurations.json +54 -0
  231. package/source/api-data-generators/support/PBXPreference/test_data_generation_configurations.json +54 -0
  232. package/source/api-data-generators/support/PageSense/test_data_generation_configurations.json +77 -0
  233. package/source/api-data-generators/support/PendingApproval/test_data_generation_configurations.json +14 -0
  234. package/source/api-data-generators/support/Permalink/test_data_generation_configurations.json +32 -0
  235. package/source/api-data-generators/support/PhoneAgents/test_data_generation_configurations.json +66 -0
  236. package/source/api-data-generators/support/PinnedConversation/test_data_generation_configurations.json +64 -0
  237. package/source/api-data-generators/support/Pipeline_Service/test_data_generation_configurations.json +32 -0
  238. package/source/api-data-generators/support/Product/test_data_generation_configurations.json +196 -0
  239. package/source/api-data-generators/support/ProductAttachment/test_data_generation_configurations.json +48 -0
  240. package/source/api-data-generators/support/Profile/test_data_generation_configurations.json +59 -0
  241. package/source/api-data-generators/support/QueueView/test_data_generation_configurations.json +37 -0
  242. package/source/api-data-generators/support/Records/test_data_generation_configurations.json +239 -0
  243. package/source/api-data-generators/support/Recyclebin/test_data_generation_configurations.json +52 -0
  244. package/source/api-data-generators/support/RemoteAuth/test_data_generation_configurations.json +52 -0
  245. package/source/api-data-generators/support/Report/test_data_generation_configurations.json +538 -0
  246. package/source/api-data-generators/support/ReportChart/test_data_generation_configurations.json +28 -0
  247. package/source/api-data-generators/support/ReportFolder/test_data_generation_configurations.json +100 -0
  248. package/source/api-data-generators/support/Resources/test_data_generation_configurations.json +29 -0
  249. package/source/api-data-generators/support/Role/test_data_generation_configurations.json +84 -0
  250. package/source/api-data-generators/support/RoundRobin/test_data_generation_configurations.json +58 -0
  251. package/source/api-data-generators/support/RoundRobinTarget/test_data_generation_configurations.json +50 -0
  252. package/source/api-data-generators/support/RoutingPreference/test_data_generation_configurations.json +29 -0
  253. package/source/api-data-generators/support/SLAMetaInfo/test_data_generation_configurations.json +22 -0
  254. package/source/api-data-generators/support/Saml/test_data_generation_configurations.json +42 -0
  255. package/source/api-data-generators/support/Sandbox/test_data_generation_configurations.json +92 -0
  256. package/source/api-data-generators/support/SandboxChangeset/test_data_generation_configurations.json +46 -0
  257. package/source/api-data-generators/support/SandboxDeployment/test_data_generation_configurations.json +50 -0
  258. package/source/api-data-generators/support/SandboxDeploymentLogs/test_data_generation_configurations.json +22 -0
  259. package/source/api-data-generators/support/SavedFilters/test_data_generation_configurations.json +203 -0
  260. package/source/api-data-generators/support/Schedule/test_data_generation_configurations.json +172 -0
  261. package/source/api-data-generators/support/ScheduleReplyInfo/test_data_generation_configurations.json +182 -0
  262. package/source/api-data-generators/support/Search/test_data_generation_configurations.json +636 -0
  263. package/source/api-data-generators/support/SearchInteg/test_data_generation_configurations.json +32 -0
  264. package/source/api-data-generators/support/Setup/test_data_generation_configurations.json +32 -0
  265. package/source/api-data-generators/support/SharedSnippet/test_data_generation_configurations.json +62 -0
  266. package/source/api-data-generators/support/Signature/test_data_generation_configurations.json +24 -0
  267. package/source/api-data-generators/support/Skill/test_data_generation_configurations.json +164 -0
  268. package/source/api-data-generators/support/SkillConfiguration/test_data_generation_configurations.json +21 -0
  269. package/source/api-data-generators/support/SkillType/test_data_generation_configurations.json +60 -0
  270. package/source/api-data-generators/support/Slack/test_data_generation_configurations.json +51 -0
  271. package/source/api-data-generators/support/SmsTemplates/test_data_generation_configurations.json +40 -0
  272. package/source/api-data-generators/support/Snippets/test_data_generation_configurations.json +47 -0
  273. package/source/api-data-generators/support/SocialInteg/test_data_generation_configurations.json +22 -0
  274. package/source/api-data-generators/support/SocialPosts/test_data_generation_configurations.json +223 -0
  275. package/source/api-data-generators/support/SocialTwitterConversations/test_data_generation_configurations.json +22 -0
  276. package/source/api-data-generators/support/StarredTemplates/test_data_generation_configurations.json +76 -0
  277. package/source/api-data-generators/support/SubjectAccessRequest/test_data_generation_configurations.json +104 -0
  278. package/source/api-data-generators/support/Supervise/test_data_generation_configurations.json +43 -0
  279. package/source/api-data-generators/support/SupportPlan/test_data_generation_configurations.json +65 -0
  280. package/source/api-data-generators/support/Tab/test_data_generation_configurations.json +29 -0
  281. package/source/api-data-generators/support/Target/test_data_generation_configurations.json +97 -0
  282. package/source/api-data-generators/support/Task/test_data_generation_configurations.json +219 -0
  283. package/source/api-data-generators/support/TaskAttachment/test_data_generation_configurations.json +42 -0
  284. package/source/api-data-generators/support/TaskComments/test_data_generation_configurations.json +45 -0
  285. package/source/api-data-generators/support/TaskTimeEntry/test_data_generation_configurations.json +87 -0
  286. package/source/api-data-generators/support/TaskTimer/test_data_generation_configurations.json +27 -0
  287. package/source/api-data-generators/support/Team/test_data_generation_configurations.json +115 -0
  288. package/source/api-data-generators/support/TemplateFolders/test_data_generation_configurations.json +72 -0
  289. package/source/api-data-generators/support/Thread/test_data_generation_configurations.json +383 -0
  290. package/source/api-data-generators/support/Ticket/test_data_generation_configurations.json +694 -0
  291. package/source/api-data-generators/support/TicketApprovals/test_data_generation_configurations.json +66 -0
  292. package/source/api-data-generators/support/TicketAttachment/test_data_generation_configurations.json +58 -0
  293. package/source/api-data-generators/support/TicketComment/test_data_generation_configurations.json +82 -0
  294. package/source/api-data-generators/support/TicketCount/test_data_generation_configurations.json +43 -0
  295. package/source/api-data-generators/support/TicketFollowers/test_data_generation_configurations.json +65 -0
  296. package/source/api-data-generators/support/TicketMetrics/test_data_generation_configurations.json +16 -0
  297. package/source/api-data-generators/support/TicketTag/test_data_generation_configurations.json +99 -0
  298. package/source/api-data-generators/support/TicketTemplate/test_data_generation_configurations.json +475 -0
  299. package/source/api-data-generators/support/TicketTimeEntry/test_data_generation_configurations.json +110 -0
  300. package/source/api-data-generators/support/TicketTimer/test_data_generation_configurations.json +48 -0
  301. package/source/api-data-generators/support/TicketWithChildren/test_data_generation_configurations.json +91 -0
  302. package/source/api-data-generators/support/TimeTracking/test_data_generation_configurations.json +46 -0
  303. package/source/api-data-generators/support/TranslationLanguages/test_data_generation_configurations.json +68 -0
  304. package/source/api-data-generators/support/Upload/test_data_generation_configurations.json +54 -0
  305. package/source/api-data-generators/support/User/test_data_generation_configurations.json +100 -0
  306. package/source/api-data-generators/support/UserAuthentication/test_data_generation_configurations.json +49 -0
  307. package/source/api-data-generators/support/UserPresence/test_data_generation_configurations.json +19 -0
  308. package/source/api-data-generators/support/ValidationRuleCriteria/test_data_generation_configurations.json +19 -0
  309. package/source/api-data-generators/support/ValidationRules/test_data_generation_configurations.json +321 -0
  310. package/source/api-data-generators/support/Webhook/test_data_generation_configurations.json +501 -0
  311. package/source/api-data-generators/support/Widget/test_data_generation_configurations.json +166 -0
  312. package/source/api-data-generators/support/ZIAAnswerbotInference/test_data_generation_configurations.json +26 -0
  313. package/source/api-data-generators/support/ZIADocumentData/test_data_generation_configurations.json +38 -0
  314. package/source/api-data-generators/support/ZIAVectorSearch/test_data_generation_configurations.json +22 -0
  315. package/source/api-data-generators/support/ZiaGPT/test_data_generation_configurations.json +19 -0
  316. package/source/api-data-generators/support/ZiaScheduler/test_data_generation_configurations.json +22 -0
  317. package/source/api-data-generators/support/ZiapoweredbyGPT/test_data_generation_configurations.json +33 -0
  318. package/source/api-data-generators/support/Zwitch/test_data_generation_configurations.json +71 -0
  319. package/source/api-data-generators/support/blueprintDrafts/test_data_generation_configurations.json +859 -0
  320. package/source/api-data-generators/support/blueprintTransitions/test_data_generation_configurations.json +26 -0
  321. package/source/api-data-generators/support/blueprints/test_data_generation_configurations.json +652 -0
  322. package/source/api-data-generators/support/borrow_book/test_data_generation_configurations.json +21 -0
  323. package/source/api-data-generators/support/zlabsnlp/test_data_generation_configurations.json +50 -0
  324. package/source/openapi-specifications/v1.0/common/Common.json +587 -0
  325. package/source/openapi-specifications/v1.0/portal/Account.json +183 -0
  326. package/source/openapi-specifications/v1.0/portal/ArticleComment.json +1103 -0
  327. package/source/openapi-specifications/v1.0/portal/ArticleFeedback.json +133 -0
  328. package/source/openapi-specifications/v1.0/portal/AsapMobile.json +712 -0
  329. package/source/openapi-specifications/v1.0/portal/AsapWeb.json +91 -0
  330. package/source/openapi-specifications/v1.0/portal/Attachment.json +122 -0
  331. package/source/openapi-specifications/v1.0/portal/Captcha.json +334 -0
  332. package/source/openapi-specifications/v1.0/portal/Category.json +1061 -0
  333. package/source/openapi-specifications/v1.0/portal/Comment.json +1546 -0
  334. package/source/openapi-specifications/v1.0/portal/Community.json +235 -0
  335. package/source/openapi-specifications/v1.0/portal/CommunityUser.json +296 -0
  336. package/source/openapi-specifications/v1.0/portal/Contact.json +536 -0
  337. package/source/openapi-specifications/v1.0/portal/CustomerHappiness.json +163 -0
  338. package/source/openapi-specifications/v1.0/portal/Department.json +246 -0
  339. package/source/openapi-specifications/v1.0/portal/Extension.json +1122 -0
  340. package/source/openapi-specifications/v1.0/portal/FeedbackWidget.json +96 -0
  341. package/source/openapi-specifications/v1.0/portal/Field.json +1239 -0
  342. package/source/openapi-specifications/v1.0/portal/FileExport.json +313 -0
  343. package/source/openapi-specifications/v1.0/portal/Followers.json +802 -0
  344. package/source/openapi-specifications/v1.0/portal/Gamification.json +819 -0
  345. package/source/openapi-specifications/v1.0/portal/HashTags.json +61 -0
  346. package/source/openapi-specifications/v1.0/portal/HelpCenterUser.json +605 -0
  347. package/source/openapi-specifications/v1.0/portal/HelpCenterUserPreference.json +148 -0
  348. package/source/openapi-specifications/v1.0/portal/Helpcenter.json +920 -0
  349. package/source/openapi-specifications/v1.0/portal/HelpcenterGroups.json +118 -0
  350. package/source/openapi-specifications/v1.0/portal/HelpcenterPages.json +184 -0
  351. package/source/openapi-specifications/v1.0/portal/KBCategoryTranslation.json +70 -0
  352. package/source/openapi-specifications/v1.0/portal/KBRootCategory.json +1310 -0
  353. package/source/openapi-specifications/v1.0/portal/KbCategory.json +1525 -0
  354. package/source/openapi-specifications/v1.0/portal/KbSection.json +515 -0
  355. package/source/openapi-specifications/v1.0/portal/Label.json +172 -0
  356. package/source/openapi-specifications/v1.0/portal/Layout.json +303 -0
  357. package/source/openapi-specifications/v1.0/portal/LayoutRules.json +375 -0
  358. package/source/openapi-specifications/v1.0/portal/Mentions.json +580 -0
  359. package/source/openapi-specifications/v1.0/portal/NewAsapMobile.json +699 -0
  360. package/source/openapi-specifications/v1.0/portal/Permalink.json +265 -0
  361. package/source/openapi-specifications/v1.0/portal/Placeholders.json +57 -0
  362. package/source/openapi-specifications/v1.0/portal/Product.json +401 -0
  363. package/source/openapi-specifications/v1.0/portal/Solution.json +3766 -0
  364. package/source/openapi-specifications/v1.0/portal/Thread.json +821 -0
  365. package/source/openapi-specifications/v1.0/portal/Ticket.json +2636 -0
  366. package/source/openapi-specifications/v1.0/portal/TicketComment.json +822 -0
  367. package/source/openapi-specifications/v1.0/portal/TicketCount.json +336 -0
  368. package/source/openapi-specifications/v1.0/portal/TicketExport.json +609 -0
  369. package/source/openapi-specifications/v1.0/portal/TicketField.json +358 -0
  370. package/source/openapi-specifications/v1.0/portal/TicketForm.json +517 -0
  371. package/source/openapi-specifications/v1.0/portal/TicketStatusMapping.json +155 -0
  372. package/source/openapi-specifications/v1.0/portal/TicketTemplate.json +409 -0
  373. package/source/openapi-specifications/v1.0/portal/TicketsViewCount.json +175 -0
  374. package/source/openapi-specifications/v1.0/portal/Topic.json +4079 -0
  375. package/source/openapi-specifications/v1.0/portal/Translation.json +174 -0
  376. package/source/openapi-specifications/v1.0/portal/Upload.json +156 -0
  377. package/source/openapi-specifications/v1.0/portal/ValidationRules.json +309 -0
  378. package/source/openapi-specifications/v1.0/portal/View.json +353 -0
  379. package/source/openapi-specifications/v1.0/portal/Widget.json +218 -0
  380. package/source/openapi-specifications/v1.0/support/AEAdminTool.json +354 -0
  381. package/source/openapi-specifications/v1.0/support/Account.json +3206 -0
  382. package/source/openapi-specifications/v1.0/support/AccountAttachment.json +484 -0
  383. package/source/openapi-specifications/v1.0/support/AccountComments.json +794 -0
  384. package/source/openapi-specifications/v1.0/support/AccountContactMappingInfo.json +227 -0
  385. package/source/openapi-specifications/v1.0/support/AccountDeduplication.json +578 -0
  386. package/source/openapi-specifications/v1.0/support/AccountFollowers.json +350 -0
  387. package/source/openapi-specifications/v1.0/support/AccountSla.json +341 -0
  388. package/source/openapi-specifications/v1.0/support/AccountTimeEntry.json +1152 -0
  389. package/source/openapi-specifications/v1.0/support/ActiveCalls.json +573 -0
  390. package/source/openapi-specifications/v1.0/support/Activity.json +1400 -0
  391. package/source/openapi-specifications/v1.0/support/Actor.json +88 -0
  392. package/source/openapi-specifications/v1.0/support/ActorsAPI.json +304 -0
  393. package/source/openapi-specifications/v1.0/support/AdminTool.json +489 -0
  394. package/source/openapi-specifications/v1.0/support/Agent.json +6685 -0
  395. package/source/openapi-specifications/v1.0/support/AgentPresence.json +567 -0
  396. package/source/openapi-specifications/v1.0/support/AgentRoom.json +1997 -0
  397. package/source/openapi-specifications/v1.0/support/AgentSignatures.json +359 -0
  398. package/source/openapi-specifications/v1.0/support/AgentTimeEntry.json +1402 -0
  399. package/source/openapi-specifications/v1.0/support/AntiSpamInfo.json +510 -0
  400. package/source/openapi-specifications/v1.0/support/ApiCreditNotificationRule.json +1189 -0
  401. package/source/openapi-specifications/v1.0/support/ApiDashboard.json +543 -0
  402. package/source/openapi-specifications/v1.0/support/ApplicationFlags.json +155 -0
  403. package/source/openapi-specifications/v1.0/support/ArchivedView.json +469 -0
  404. package/source/openapi-specifications/v1.0/support/Article.json +5060 -0
  405. package/source/openapi-specifications/v1.0/support/ArticleAttachment.json +544 -0
  406. package/source/openapi-specifications/v1.0/support/ArticleComment.json +1929 -0
  407. package/source/openapi-specifications/v1.0/support/ArticleExternalImageUrlResponse.json +56 -0
  408. package/source/openapi-specifications/v1.0/support/ArticleFeedback.json +1314 -0
  409. package/source/openapi-specifications/v1.0/support/ArticleFeedbackResolution.json +513 -0
  410. package/source/openapi-specifications/v1.0/support/ArticleHistory.json +2510 -0
  411. package/source/openapi-specifications/v1.0/support/ArticleStatistics.json +3053 -0
  412. package/source/openapi-specifications/v1.0/support/ArticleTranslation.json +7530 -0
  413. package/source/openapi-specifications/v1.0/support/ArticleVersion.json +184 -0
  414. package/source/openapi-specifications/v1.0/support/ArticleViews.json +564 -0
  415. package/source/openapi-specifications/v1.0/support/Asap.json +1525 -0
  416. package/source/openapi-specifications/v1.0/support/AsapModule.json +246 -0
  417. package/source/openapi-specifications/v1.0/support/AsapStatus.json +199 -0
  418. package/source/openapi-specifications/v1.0/support/AssistInteg.json +613 -0
  419. package/source/openapi-specifications/v1.0/support/AttachmentRestriction.json +786 -0
  420. package/source/openapi-specifications/v1.0/support/AuditLog.json +1122 -0
  421. package/source/openapi-specifications/v1.0/support/AutomatedSummaryForChats.json +702 -0
  422. package/source/openapi-specifications/v1.0/support/AutomationAlerts.json +868 -0
  423. package/source/openapi-specifications/v1.0/support/AutomationEngine.json +1181 -0
  424. package/source/openapi-specifications/v1.0/support/AutomationFeatureCount.json +207 -0
  425. package/source/openapi-specifications/v1.0/support/AutomationFieldUpdates.json +809 -0
  426. package/source/openapi-specifications/v1.0/support/AutomationTask.json +1054 -0
  427. package/source/openapi-specifications/v1.0/support/Backup.json +2845 -0
  428. package/source/openapi-specifications/v1.0/support/Badge.json +544 -0
  429. package/source/openapi-specifications/v1.0/support/Bot.json +2103 -0
  430. package/source/openapi-specifications/v1.0/support/BotInference.json +1071 -0
  431. package/source/openapi-specifications/v1.0/support/BotResources.json +175 -0
  432. package/source/openapi-specifications/v1.0/support/BotStaticResources.json +541 -0
  433. package/source/openapi-specifications/v1.0/support/Bot_UserInfo.json +63 -0
  434. package/source/openapi-specifications/v1.0/support/Bots.json +58 -0
  435. package/source/openapi-specifications/v1.0/support/BugInteg.json +481 -0
  436. package/source/openapi-specifications/v1.0/support/BulkAction.json +150 -0
  437. package/source/openapi-specifications/v1.0/support/BulkImport.json +2845 -0
  438. package/source/openapi-specifications/v1.0/support/BulkUpdate.json +743 -0
  439. package/source/openapi-specifications/v1.0/support/BulkWrite.json +678 -0
  440. package/source/openapi-specifications/v1.0/support/BusinessHour.json +1344 -0
  441. package/source/openapi-specifications/v1.0/support/Call.json +3839 -0
  442. package/source/openapi-specifications/v1.0/support/CallComments.json +721 -0
  443. package/source/openapi-specifications/v1.0/support/CallHistory.json +936 -0
  444. package/source/openapi-specifications/v1.0/support/CallTimeEntry.json +1745 -0
  445. package/source/openapi-specifications/v1.0/support/CallTimer.json +285 -0
  446. package/source/openapi-specifications/v1.0/support/Channel.json +730 -0
  447. package/source/openapi-specifications/v1.0/support/Chart.json +422 -0
  448. package/source/openapi-specifications/v1.0/support/ChatTicket.json +553 -0
  449. package/source/openapi-specifications/v1.0/support/ClientAction.json +1834 -0
  450. package/source/openapi-specifications/v1.0/support/ClientEvent.json +780 -0
  451. package/source/openapi-specifications/v1.0/support/CliqIntegJsonMapping.json +1123 -0
  452. package/source/openapi-specifications/v1.0/support/CloudAttachment.json +528 -0
  453. package/source/openapi-specifications/v1.0/support/CommonMassActionError.json +44 -0
  454. package/source/openapi-specifications/v1.0/support/CommonMassActionResponse.json +94 -0
  455. package/source/openapi-specifications/v1.0/support/Community.json +2545 -0
  456. package/source/openapi-specifications/v1.0/support/CommunityAttachment.json +249 -0
  457. package/source/openapi-specifications/v1.0/support/CommunityCategory.json +1896 -0
  458. package/source/openapi-specifications/v1.0/support/CommunityCategoryLogo.json +145 -0
  459. package/source/openapi-specifications/v1.0/support/CommunityComment.json +2492 -0
  460. package/source/openapi-specifications/v1.0/support/CommunityInitPermissions.json +129 -0
  461. package/source/openapi-specifications/v1.0/support/CommunityPreferences.json +343 -0
  462. package/source/openapi-specifications/v1.0/support/CommunitySearch.json +78 -0
  463. package/source/openapi-specifications/v1.0/support/CommunityTopic.json +6005 -0
  464. package/source/openapi-specifications/v1.0/support/CommunityTopicInsights.json +310 -0
  465. package/source/openapi-specifications/v1.0/support/CommunityUser.json +822 -0
  466. package/source/openapi-specifications/v1.0/support/Composite.json +414 -0
  467. package/source/openapi-specifications/v1.0/support/Contact.json +4691 -0
  468. package/source/openapi-specifications/v1.0/support/ContactAttachment.json +484 -0
  469. package/source/openapi-specifications/v1.0/support/ContactComments.json +769 -0
  470. package/source/openapi-specifications/v1.0/support/ContactDeduplication.json +683 -0
  471. package/source/openapi-specifications/v1.0/support/ContactFollowers.json +350 -0
  472. package/source/openapi-specifications/v1.0/support/ContactProfile.json +195 -0
  473. package/source/openapi-specifications/v1.0/support/ContactTimeEntry.json +1157 -0
  474. package/source/openapi-specifications/v1.0/support/Contract.json +2877 -0
  475. package/source/openapi-specifications/v1.0/support/ContractAttachment.json +307 -0
  476. package/source/openapi-specifications/v1.0/support/Conversation.json +570 -0
  477. package/source/openapi-specifications/v1.0/support/CountriesAndLanguages.json +5279 -0
  478. package/source/openapi-specifications/v1.0/support/CreditCycle.json +124 -0
  479. package/source/openapi-specifications/v1.0/support/Criteria.json +1014 -0
  480. package/source/openapi-specifications/v1.0/support/CriteriaValue.json +50 -0
  481. package/source/openapi-specifications/v1.0/support/CrmInteg.json +5938 -0
  482. package/source/openapi-specifications/v1.0/support/CustomAction.json +2106 -0
  483. package/source/openapi-specifications/v1.0/support/CustomActionRuleMapping.json +1327 -0
  484. package/source/openapi-specifications/v1.0/support/CustomButton.json +1898 -0
  485. package/source/openapi-specifications/v1.0/support/CustomFunctionExecutionLogs.json +883 -0
  486. package/source/openapi-specifications/v1.0/support/CustomFunctionGallery.json +329 -0
  487. package/source/openapi-specifications/v1.0/support/CustomFunctionReRun.json +317 -0
  488. package/source/openapi-specifications/v1.0/support/CustomFunctionZiaCopilot.json +379 -0
  489. package/source/openapi-specifications/v1.0/support/CustomFunctions.json +3457 -0
  490. package/source/openapi-specifications/v1.0/support/CustomModuleAdminTool.json +81 -0
  491. package/source/openapi-specifications/v1.0/support/CustomTheme.json +7391 -0
  492. package/source/openapi-specifications/v1.0/support/CustomView.json +3478 -0
  493. package/source/openapi-specifications/v1.0/support/CustomerHappiness.json +464 -0
  494. package/source/openapi-specifications/v1.0/support/DBThrottle.json +334 -0
  495. package/source/openapi-specifications/v1.0/support/DashboardComponent.json +1163 -0
  496. package/source/openapi-specifications/v1.0/support/DashboardFolder.json +1258 -0
  497. package/source/openapi-specifications/v1.0/support/DashboardMetrics.json +2310 -0
  498. package/source/openapi-specifications/v1.0/support/Dashboards.json +1219 -0
  499. package/source/openapi-specifications/v1.0/support/DataChips.json +477 -0
  500. package/source/openapi-specifications/v1.0/support/DataImport.json +1099 -0
  501. package/source/openapi-specifications/v1.0/support/DataSync.json +1246 -0
  502. package/source/openapi-specifications/v1.0/support/DatasetEntry.json +153 -0
  503. package/source/openapi-specifications/v1.0/support/Department.json +1971 -0
  504. package/source/openapi-specifications/v1.0/support/DependencyMappings.json +656 -0
  505. package/source/openapi-specifications/v1.0/support/DirectAssignRuleTarget.json +232 -0
  506. package/source/openapi-specifications/v1.0/support/DirectAssignmentRules.json +722 -0
  507. package/source/openapi-specifications/v1.0/support/DisplayEntity.json +91 -0
  508. package/source/openapi-specifications/v1.0/support/DomainMapping.json +1143 -0
  509. package/source/openapi-specifications/v1.0/support/EmailFailureAlert.json +306 -0
  510. package/source/openapi-specifications/v1.0/support/EmailTemplates.json +1491 -0
  511. package/source/openapi-specifications/v1.0/support/EntityBlueprints.json +572 -0
  512. package/source/openapi-specifications/v1.0/support/Event.json +3607 -0
  513. package/source/openapi-specifications/v1.0/support/EventComments.json +737 -0
  514. package/source/openapi-specifications/v1.0/support/EventTimeEntry.json +1520 -0
  515. package/source/openapi-specifications/v1.0/support/EventTimer.json +285 -0
  516. package/source/openapi-specifications/v1.0/support/Expression.json +43 -0
  517. package/source/openapi-specifications/v1.0/support/Extension.json +7152 -0
  518. package/source/openapi-specifications/v1.0/support/ExtensionOrg.json +129 -0
  519. package/source/openapi-specifications/v1.0/support/FAQ.json +142 -0
  520. package/source/openapi-specifications/v1.0/support/FAQTranslation.json +178 -0
  521. package/source/openapi-specifications/v1.0/support/FbManager.json +1147 -0
  522. package/source/openapi-specifications/v1.0/support/Feature.json +691 -0
  523. package/source/openapi-specifications/v1.0/support/FeatureFile.json +435 -0
  524. package/source/openapi-specifications/v1.0/support/FeatureFolder.json +576 -0
  525. package/source/openapi-specifications/v1.0/support/FeaturePermission.json +492 -0
  526. package/source/openapi-specifications/v1.0/support/FederatedLogin.json +318 -0
  527. package/source/openapi-specifications/v1.0/support/FeedsAPIs.json +198 -0
  528. package/source/openapi-specifications/v1.0/support/Field.json +7493 -0
  529. package/source/openapi-specifications/v1.0/support/FieldDetails.json +139 -0
  530. package/source/openapi-specifications/v1.0/support/FieldPermissions.json +113 -0
  531. package/source/openapi-specifications/v1.0/support/FieldPrediction.json +3831 -0
  532. package/source/openapi-specifications/v1.0/support/FileExport.json +324 -0
  533. package/source/openapi-specifications/v1.0/support/Finance.json +4290 -0
  534. package/source/openapi-specifications/v1.0/support/Followers.json +875 -0
  535. package/source/openapi-specifications/v1.0/support/FormulaFunctions.json +47 -0
  536. package/source/openapi-specifications/v1.0/support/GC_Bots.json +138 -0
  537. package/source/openapi-specifications/v1.0/support/GC_Guide.json +1536 -0
  538. package/source/openapi-specifications/v1.0/support/GC_GuideHistories.json +58 -0
  539. package/source/openapi-specifications/v1.0/support/GC_GuideHistory.json +79 -0
  540. package/source/openapi-specifications/v1.0/support/GC_Guides.json +89 -0
  541. package/source/openapi-specifications/v1.0/support/GC_Info.json +208 -0
  542. package/source/openapi-specifications/v1.0/support/GC_Status.json +69 -0
  543. package/source/openapi-specifications/v1.0/support/GC_UserInfo.json +79 -0
  544. package/source/openapi-specifications/v1.0/support/GenericAction.json +1888 -0
  545. package/source/openapi-specifications/v1.0/support/GenericActionMapping.json +1050 -0
  546. package/source/openapi-specifications/v1.0/support/GoogleAnalytics.json +1715 -0
  547. package/source/openapi-specifications/v1.0/support/GoogleChat.json +650 -0
  548. package/source/openapi-specifications/v1.0/support/HelpCenterCommon.json +44 -0
  549. package/source/openapi-specifications/v1.0/support/Help_Center_OIDC_Authentication.json +900 -0
  550. package/source/openapi-specifications/v1.0/support/Helpcenter.json +1212 -0
  551. package/source/openapi-specifications/v1.0/support/HelpcenterAutoTranslateSetting.json +331 -0
  552. package/source/openapi-specifications/v1.0/support/HelpcenterGroups.json +1496 -0
  553. package/source/openapi-specifications/v1.0/support/HelpcenterPages.json +504 -0
  554. package/source/openapi-specifications/v1.0/support/HelpcenterPreference.json +208 -0
  555. package/source/openapi-specifications/v1.0/support/HelpcenterTranslationApp.json +64 -0
  556. package/source/openapi-specifications/v1.0/support/HelpcenterUpload.json +211 -0
  557. package/source/openapi-specifications/v1.0/support/HolidayList.json +731 -0
  558. package/source/openapi-specifications/v1.0/support/IMAPAddress.json +1091 -0
  559. package/source/openapi-specifications/v1.0/support/IMCannedMessage.json +1357 -0
  560. package/source/openapi-specifications/v1.0/support/IMCannedMessagePlaceHolders.json +169 -0
  561. package/source/openapi-specifications/v1.0/support/IMCannedMessageTranslation.json +624 -0
  562. package/source/openapi-specifications/v1.0/support/IMTemplateMessage.json +597 -0
  563. package/source/openapi-specifications/v1.0/support/IM_AddOn.json +841 -0
  564. package/source/openapi-specifications/v1.0/support/IM_AttachmentMessage.json +64 -0
  565. package/source/openapi-specifications/v1.0/support/IM_Bot.json +1007 -0
  566. package/source/openapi-specifications/v1.0/support/IM_BotService.json +357 -0
  567. package/source/openapi-specifications/v1.0/support/IM_Broadcast.json +323 -0
  568. package/source/openapi-specifications/v1.0/support/IM_Channel.json +2849 -0
  569. package/source/openapi-specifications/v1.0/support/IM_ChannelPreference.json +502 -0
  570. package/source/openapi-specifications/v1.0/support/IM_Contact.json +165 -0
  571. package/source/openapi-specifications/v1.0/support/IM_Efc.json +188 -0
  572. package/source/openapi-specifications/v1.0/support/IM_Integration.json +1269 -0
  573. package/source/openapi-specifications/v1.0/support/IM_IntegrationService.json +454 -0
  574. package/source/openapi-specifications/v1.0/support/IM_LayoutView.json +625 -0
  575. package/source/openapi-specifications/v1.0/support/IM_License.json +225 -0
  576. package/source/openapi-specifications/v1.0/support/IM_Message.json +1371 -0
  577. package/source/openapi-specifications/v1.0/support/IM_Metrics.json +462 -0
  578. package/source/openapi-specifications/v1.0/support/IM_Search.json +547 -0
  579. package/source/openapi-specifications/v1.0/support/IM_Session.json +1397 -0
  580. package/source/openapi-specifications/v1.0/support/IM_TemplateButton.json +142 -0
  581. package/source/openapi-specifications/v1.0/support/IM_TemplateFooter.json +83 -0
  582. package/source/openapi-specifications/v1.0/support/IM_TemplateHeader.json +86 -0
  583. package/source/openapi-specifications/v1.0/support/IM_TemplateItems.json +73 -0
  584. package/source/openapi-specifications/v1.0/support/IM_TimeSeriesMetrics.json +435 -0
  585. package/source/openapi-specifications/v1.0/support/IM_TwilioPhoneNumber.json +202 -0
  586. package/source/openapi-specifications/v1.0/support/IM_WhatsApp_Integrations.json +193 -0
  587. package/source/openapi-specifications/v1.0/support/IM_ZiaGpt.json +489 -0
  588. package/source/openapi-specifications/v1.0/support/Import.json +1844 -0
  589. package/source/openapi-specifications/v1.0/support/IncrementalDocuments.json +395 -0
  590. package/source/openapi-specifications/v1.0/support/Inference.json +307 -0
  591. package/source/openapi-specifications/v1.0/support/InlineImage.json +97 -0
  592. package/source/openapi-specifications/v1.0/support/IntegModule.json +938 -0
  593. package/source/openapi-specifications/v1.0/support/Integrations.json +1264 -0
  594. package/source/openapi-specifications/v1.0/support/InteractiveTours.json +539 -0
  595. package/source/openapi-specifications/v1.0/support/JWT.json +535 -0
  596. package/source/openapi-specifications/v1.0/support/KBCategoryPermalink.json +208 -0
  597. package/source/openapi-specifications/v1.0/support/KBCategoryUser.json +241 -0
  598. package/source/openapi-specifications/v1.0/support/KBPreference.json +323 -0
  599. package/source/openapi-specifications/v1.0/support/KBRecycleBin.json +2316 -0
  600. package/source/openapi-specifications/v1.0/support/KBRootCategory.json +2839 -0
  601. package/source/openapi-specifications/v1.0/support/KBRootCategoryTranslation.json +570 -0
  602. package/source/openapi-specifications/v1.0/support/KBSection.json +1941 -0
  603. package/source/openapi-specifications/v1.0/support/KBTranslationMassActionResponse.json +169 -0
  604. package/source/openapi-specifications/v1.0/support/KPIWidget.json +206 -0
  605. package/source/openapi-specifications/v1.0/support/KbBot.json +511 -0
  606. package/source/openapi-specifications/v1.0/support/KbCategory.json +1618 -0
  607. package/source/openapi-specifications/v1.0/support/KbCategoryLogo.json +124 -0
  608. package/source/openapi-specifications/v1.0/support/Label.json +1251 -0
  609. package/source/openapi-specifications/v1.0/support/Layout.json +8042 -0
  610. package/source/openapi-specifications/v1.0/support/LayoutRuleCriteria.json +491 -0
  611. package/source/openapi-specifications/v1.0/support/LayoutRules.json +1422 -0
  612. package/source/openapi-specifications/v1.0/support/LensInteg.json +86 -0
  613. package/source/openapi-specifications/v1.0/support/LicenseFeaturePlan.json +548 -0
  614. package/source/openapi-specifications/v1.0/support/LicenseInfo.json +1231 -0
  615. package/source/openapi-specifications/v1.0/support/LicenseTool.json +165 -0
  616. package/source/openapi-specifications/v1.0/support/Livecall.json +954 -0
  617. package/source/openapi-specifications/v1.0/support/LookupRecord.json +174 -0
  618. package/source/openapi-specifications/v1.0/support/Macros.json +1960 -0
  619. package/source/openapi-specifications/v1.0/support/MailReplyAddress.json +1263 -0
  620. package/source/openapi-specifications/v1.0/support/MassAction.json +1151 -0
  621. package/source/openapi-specifications/v1.0/support/MassActionError.json +55 -0
  622. package/source/openapi-specifications/v1.0/support/MassActionResponse.json +89 -0
  623. package/source/openapi-specifications/v1.0/support/Mentions.json +491 -0
  624. package/source/openapi-specifications/v1.0/support/Message.json +685 -0
  625. package/source/openapi-specifications/v1.0/support/Microsoft.json +887 -0
  626. package/source/openapi-specifications/v1.0/support/MicrosoftTeams.json +574 -0
  627. package/source/openapi-specifications/v1.0/support/Microsoft_PowerBI.json +903 -0
  628. package/source/openapi-specifications/v1.0/support/Misc.json +214 -0
  629. package/source/openapi-specifications/v1.0/support/Module.json +1625 -0
  630. package/source/openapi-specifications/v1.0/support/NewCriteria.json +1863 -0
  631. package/source/openapi-specifications/v1.0/support/NewFeatureFields.json +204 -0
  632. package/source/openapi-specifications/v1.0/support/NewTicketHistory.json +150 -0
  633. package/source/openapi-specifications/v1.0/support/NotificationRules.json +441 -0
  634. package/source/openapi-specifications/v1.0/support/OEmbedData.json +233 -0
  635. package/source/openapi-specifications/v1.0/support/Onboarding.json +282 -0
  636. package/source/openapi-specifications/v1.0/support/Organization.json +1391 -0
  637. package/source/openapi-specifications/v1.0/support/PBGroup.json +634 -0
  638. package/source/openapi-specifications/v1.0/support/PBGroupAgents.json +433 -0
  639. package/source/openapi-specifications/v1.0/support/PBPlatform.json +1447 -0
  640. package/source/openapi-specifications/v1.0/support/PBX.json +550 -0
  641. package/source/openapi-specifications/v1.0/support/PBXConfig.json +219 -0
  642. package/source/openapi-specifications/v1.0/support/PBXPhoneNumbers.json +443 -0
  643. package/source/openapi-specifications/v1.0/support/PBXPreference.json +314 -0
  644. package/source/openapi-specifications/v1.0/support/PageSense.json +1505 -0
  645. package/source/openapi-specifications/v1.0/support/PendingApproval.json +279 -0
  646. package/source/openapi-specifications/v1.0/support/Permalink.json +393 -0
  647. package/source/openapi-specifications/v1.0/support/PhoneAgents.json +1014 -0
  648. package/source/openapi-specifications/v1.0/support/PhoneMenu.json +118 -0
  649. package/source/openapi-specifications/v1.0/support/PinnedConversation.json +1115 -0
  650. package/source/openapi-specifications/v1.0/support/Pipeline_Info.json +232 -0
  651. package/source/openapi-specifications/v1.0/support/Pipeline_Service.json +499 -0
  652. package/source/openapi-specifications/v1.0/support/Product.json +1861 -0
  653. package/source/openapi-specifications/v1.0/support/ProductAttachment.json +485 -0
  654. package/source/openapi-specifications/v1.0/support/Profile.json +4236 -0
  655. package/source/openapi-specifications/v1.0/support/ProjectsInteg.json +989 -0
  656. package/source/openapi-specifications/v1.0/support/QueryStore.json +238 -0
  657. package/source/openapi-specifications/v1.0/support/QueueView.json +335 -0
  658. package/source/openapi-specifications/v1.0/support/RatelimitAdminTool.json +1204 -0
  659. package/source/openapi-specifications/v1.0/support/Records.json +1509 -0
  660. package/source/openapi-specifications/v1.0/support/Recyclebin.json +669 -0
  661. package/source/openapi-specifications/v1.0/support/RemoteAuth.json +401 -0
  662. package/source/openapi-specifications/v1.0/support/Report.json +6491 -0
  663. package/source/openapi-specifications/v1.0/support/ReportChart.json +254 -0
  664. package/source/openapi-specifications/v1.0/support/ReportFolder.json +1076 -0
  665. package/source/openapi-specifications/v1.0/support/ReportIntegration.json +202 -0
  666. package/source/openapi-specifications/v1.0/support/RequestFlags.json +358 -0
  667. package/source/openapi-specifications/v1.0/support/Resources.json +335 -0
  668. package/source/openapi-specifications/v1.0/support/ResponseHelpCenterUser.json +128 -0
  669. package/source/openapi-specifications/v1.0/support/Role.json +996 -0
  670. package/source/openapi-specifications/v1.0/support/RoundRobin.json +796 -0
  671. package/source/openapi-specifications/v1.0/support/RoundRobinTarget.json +381 -0
  672. package/source/openapi-specifications/v1.0/support/RoutingPreference.json +615 -0
  673. package/source/openapi-specifications/v1.0/support/RuleGroup.json +1630 -0
  674. package/source/openapi-specifications/v1.0/support/SLAMetaInfo.json +227 -0
  675. package/source/openapi-specifications/v1.0/support/Saml.json +565 -0
  676. package/source/openapi-specifications/v1.0/support/Sandbox.json +1075 -0
  677. package/source/openapi-specifications/v1.0/support/SandboxChangeset.json +501 -0
  678. package/source/openapi-specifications/v1.0/support/SandboxDeployment.json +428 -0
  679. package/source/openapi-specifications/v1.0/support/SandboxDeploymentLogs.json +295 -0
  680. package/source/openapi-specifications/v1.0/support/SandboxSourceOrganization.json +268 -0
  681. package/source/openapi-specifications/v1.0/support/SavedFilters.json +652 -0
  682. package/source/openapi-specifications/v1.0/support/Schedule.json +2077 -0
  683. package/source/openapi-specifications/v1.0/support/ScheduleReplyInfo.json +2271 -0
  684. package/source/openapi-specifications/v1.0/support/Search.json +12600 -0
  685. package/source/openapi-specifications/v1.0/support/SearchInteg.json +2254 -0
  686. package/source/openapi-specifications/v1.0/support/Setup.json +1766 -0
  687. package/source/openapi-specifications/v1.0/support/SharedSnippet.json +1110 -0
  688. package/source/openapi-specifications/v1.0/support/SharingRule.json +287 -0
  689. package/source/openapi-specifications/v1.0/support/Signature.json +354 -0
  690. package/source/openapi-specifications/v1.0/support/Skill.json +2164 -0
  691. package/source/openapi-specifications/v1.0/support/SkillConfiguration.json +269 -0
  692. package/source/openapi-specifications/v1.0/support/SkillType.json +807 -0
  693. package/source/openapi-specifications/v1.0/support/Slack.json +957 -0
  694. package/source/openapi-specifications/v1.0/support/SmsTemplates.json +514 -0
  695. package/source/openapi-specifications/v1.0/support/Snippets.json +918 -0
  696. package/source/openapi-specifications/v1.0/support/SocialBrands.json +427 -0
  697. package/source/openapi-specifications/v1.0/support/SocialInteg.json +336 -0
  698. package/source/openapi-specifications/v1.0/support/SocialPosts.json +2460 -0
  699. package/source/openapi-specifications/v1.0/support/SocialTwitterConversations.json +337 -0
  700. package/source/openapi-specifications/v1.0/support/StarredTemplates.json +690 -0
  701. package/source/openapi-specifications/v1.0/support/Statistics.json +125 -0
  702. package/source/openapi-specifications/v1.0/support/SubjectAccessRequest.json +2419 -0
  703. package/source/openapi-specifications/v1.0/support/Supervise.json +774 -0
  704. package/source/openapi-specifications/v1.0/support/SupportEmailAddress.json +188 -0
  705. package/source/openapi-specifications/v1.0/support/SupportEmailDomain.json +293 -0
  706. package/source/openapi-specifications/v1.0/support/SupportPlan.json +1109 -0
  707. package/source/openapi-specifications/v1.0/support/Tab.json +606 -0
  708. package/source/openapi-specifications/v1.0/support/Target.json +1311 -0
  709. package/source/openapi-specifications/v1.0/support/TargetFunctions.json +130 -0
  710. package/source/openapi-specifications/v1.0/support/Task.json +4006 -0
  711. package/source/openapi-specifications/v1.0/support/TaskAttachment.json +443 -0
  712. package/source/openapi-specifications/v1.0/support/TaskComments.json +706 -0
  713. package/source/openapi-specifications/v1.0/support/TaskTimeEntry.json +1756 -0
  714. package/source/openapi-specifications/v1.0/support/TaskTimer.json +441 -0
  715. package/source/openapi-specifications/v1.0/support/Team.json +1383 -0
  716. package/source/openapi-specifications/v1.0/support/TemplateFolders.json +1069 -0
  717. package/source/openapi-specifications/v1.0/support/Theme.json +152 -0
  718. package/source/openapi-specifications/v1.0/support/Thread.json +3545 -0
  719. package/source/openapi-specifications/v1.0/support/Ticket.json +9495 -0
  720. package/source/openapi-specifications/v1.0/support/TicketApprovals.json +855 -0
  721. package/source/openapi-specifications/v1.0/support/TicketAttachment.json +562 -0
  722. package/source/openapi-specifications/v1.0/support/TicketComment.json +1444 -0
  723. package/source/openapi-specifications/v1.0/support/TicketCount.json +690 -0
  724. package/source/openapi-specifications/v1.0/support/TicketFollowers.json +454 -0
  725. package/source/openapi-specifications/v1.0/support/TicketHistory.json +414 -0
  726. package/source/openapi-specifications/v1.0/support/TicketMetrics.json +369 -0
  727. package/source/openapi-specifications/v1.0/support/TicketRealTime.json +178 -0
  728. package/source/openapi-specifications/v1.0/support/TicketTag.json +1513 -0
  729. package/source/openapi-specifications/v1.0/support/TicketTemplate.json +907 -0
  730. package/source/openapi-specifications/v1.0/support/TicketTimeEntry.json +1681 -0
  731. package/source/openapi-specifications/v1.0/support/TicketTimer.json +1205 -0
  732. package/source/openapi-specifications/v1.0/support/TimeTracking.json +1212 -0
  733. package/source/openapi-specifications/v1.0/support/TrainingCourses.json +614 -0
  734. package/source/openapi-specifications/v1.0/support/TrainingIntegration.json +163 -0
  735. package/source/openapi-specifications/v1.0/support/TranslationLanguages.json +2772 -0
  736. package/source/openapi-specifications/v1.0/support/Upload.json +620 -0
  737. package/source/openapi-specifications/v1.0/support/User.json +1409 -0
  738. package/source/openapi-specifications/v1.0/support/UserAuthentication.json +617 -0
  739. package/source/openapi-specifications/v1.0/support/UserPresence.json +763 -0
  740. package/source/openapi-specifications/v1.0/support/ValidationRuleCriteria.json +107 -0
  741. package/source/openapi-specifications/v1.0/support/ValidationRules.json +1173 -0
  742. package/source/openapi-specifications/v1.0/support/Webhook.json +1330 -0
  743. package/source/openapi-specifications/v1.0/support/WhatsAppDetails.json +132 -0
  744. package/source/openapi-specifications/v1.0/support/WhatsAppMigration.json +143 -0
  745. package/source/openapi-specifications/v1.0/support/WhatsAppTemplateTags.json +132 -0
  746. package/source/openapi-specifications/v1.0/support/Widget.json +3023 -0
  747. package/source/openapi-specifications/v1.0/support/WmsDomain.json +104 -0
  748. package/source/openapi-specifications/v1.0/support/ZIAAnswerbotInference.json +756 -0
  749. package/source/openapi-specifications/v1.0/support/ZIADocumentData.json +989 -0
  750. package/source/openapi-specifications/v1.0/support/ZIASolutionService.json +135 -0
  751. package/source/openapi-specifications/v1.0/support/ZIAVectorSearch.json +376 -0
  752. package/source/openapi-specifications/v1.0/support/ZiaDCMigration.json +159 -0
  753. package/source/openapi-specifications/v1.0/support/ZiaGPT.json +3229 -0
  754. package/source/openapi-specifications/v1.0/support/ZiaScheduler.json +453 -0
  755. package/source/openapi-specifications/v1.0/support/Zwitch.json +1543 -0
  756. package/source/openapi-specifications/v1.0/support/blueprintChartData.json +201 -0
  757. package/source/openapi-specifications/v1.0/support/blueprintConnections.json +75 -0
  758. package/source/openapi-specifications/v1.0/support/blueprintCriteria.json +255 -0
  759. package/source/openapi-specifications/v1.0/support/blueprintDrafts.json +1677 -0
  760. package/source/openapi-specifications/v1.0/support/blueprintStates.json +284 -0
  761. package/source/openapi-specifications/v1.0/support/blueprintStrictModeConfig.json +91 -0
  762. package/source/openapi-specifications/v1.0/support/blueprintTransitions.json +1546 -0
  763. package/source/openapi-specifications/v1.0/support/blueprints.json +2992 -0
  764. package/source/openapi-specifications/v1.0/support/errors.json +80 -0
  765. package/source/openapi-specifications/v1.0/support/zlabsnlp.json +416 -0
  766. package/.github/agents/Generators.agent.md +0 -121
@@ -0,0 +1,4290 @@
1
+ {
2
+ "openapi" : "3.1.0",
3
+ "info" : {
4
+ "title" : "Finance",
5
+ "version" : "1.0.0",
6
+ "x-clan-group" : "integration",
7
+ "x-module-group" : "integration"
8
+ },
9
+ "paths" : {
10
+ "/api/v1/zohoFinance/{financeService}/paymentTermsMeta" : {
11
+ "get" : {
12
+ "tags" : [ "Finance" ],
13
+ "summary" : "Get payment and curency Meta",
14
+ "description" : "To get currency and payment terms.",
15
+ "operationId" : "paymentMeta",
16
+ "parameters" : [ {
17
+ "$ref" : "#/components/parameters/financeService"
18
+ }, {
19
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
20
+ } ],
21
+ "responses" : {
22
+ "200" : {
23
+ "$ref" : "#/components/responses/paymentMeta"
24
+ },
25
+ "422" : {
26
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
27
+ },
28
+ "500" : {
29
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
30
+ },
31
+ "204" : {
32
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
33
+ },
34
+ "403" : {
35
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
36
+ }
37
+ },
38
+ "security" : [ {
39
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
40
+ }, {
41
+ "cookie-auth" : [ "cookie-auth" ]
42
+ }, {
43
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
44
+ } ],
45
+ "x-audience" : [ "company-internal" ],
46
+ "x-custom-url-attribute" : {
47
+ "security" : {
48
+ "throttle" : {
49
+ "inline" : [ {
50
+ "scope" : "APPSERVER",
51
+ "rules" : [ {
52
+ "duration" : 60000,
53
+ "lock-period" : 180000,
54
+ "threshold" : 50,
55
+ "hip" : false
56
+ }, {
57
+ "duration" : 3600000,
58
+ "lock-period" : 600000,
59
+ "threshold" : 500,
60
+ "hip" : false
61
+ } ],
62
+ "window" : "ROLLING",
63
+ "key" : "url.path+user.zuid"
64
+ } ]
65
+ },
66
+ "extraparams" : {
67
+ "disable" : true,
68
+ "ignore" : false
69
+ },
70
+ "authentication" : { }
71
+ },
72
+ "clan-group" : "integration",
73
+ "apihash" : "bb8b8b019eb334a951d8990941eb7065",
74
+ "module-group" : "integration",
75
+ "apimethod" : "com.zoho.support.restapi.FinanceService.paymentMeta"
76
+ }
77
+ }
78
+ },
79
+ "/api/v1/zohoFinance/{financeService}/salesorders/{id}/packages" : {
80
+ "get" : {
81
+ "tags" : [ "Finance" ],
82
+ "summary" : "Get salesorder packages",
83
+ "description" : "To get salesorder packages.",
84
+ "operationId" : "getSalesOrderPackages",
85
+ "parameters" : [ {
86
+ "$ref" : "#/components/parameters/financeService"
87
+ }, {
88
+ "$ref" : "#/components/parameters/id"
89
+ }, {
90
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
91
+ } ],
92
+ "responses" : {
93
+ "200" : {
94
+ "$ref" : "#/components/responses/getSalesOrderPackagesResponse"
95
+ },
96
+ "500" : {
97
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
98
+ },
99
+ "204" : {
100
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
101
+ },
102
+ "403" : {
103
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
104
+ }
105
+ },
106
+ "security" : [ {
107
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
108
+ }, {
109
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
110
+ } ],
111
+ "x-audience" : [ "company-internal" ],
112
+ "x-custom-url-attribute" : {
113
+ "security" : {
114
+ "throttle" : {
115
+ "inline" : [ {
116
+ "scope" : "APPSERVER",
117
+ "rules" : [ {
118
+ "duration" : 60000,
119
+ "lock-period" : 180000,
120
+ "threshold" : 50,
121
+ "hip" : false
122
+ }, {
123
+ "duration" : 3600000,
124
+ "lock-period" : 600000,
125
+ "threshold" : 500,
126
+ "hip" : false
127
+ } ],
128
+ "window" : "ROLLING",
129
+ "key" : "url.path+user.zuid"
130
+ } ]
131
+ },
132
+ "extraparams" : {
133
+ "disable" : true,
134
+ "ignore" : false
135
+ },
136
+ "authentication" : { }
137
+ },
138
+ "clan-group" : "integration",
139
+ "apihash" : "179cb1c2314b93ccba9f9c3befa7c53d",
140
+ "module-group" : "integration",
141
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getSalesOrderPackages"
142
+ }
143
+ }
144
+ },
145
+ "/api/v1/zohoFinance/{financeService}/invoices" : {
146
+ "get" : {
147
+ "tags" : [ "Finance" ],
148
+ "summary" : "List invoices",
149
+ "description" : "To list invoices.",
150
+ "operationId" : "getInvoices",
151
+ "parameters" : [ {
152
+ "$ref" : "#/components/parameters/deskEntityId"
153
+ }, {
154
+ "$ref" : "#/components/parameters/pageNumber"
155
+ }, {
156
+ "name" : "departmentId",
157
+ "in" : "query",
158
+ "description" : "Department Id",
159
+ "required" : false,
160
+ "style" : "form",
161
+ "explode" : true,
162
+ "schema" : {
163
+ "type" : [ "string", "null", "integer" ],
164
+ "format" : "int64",
165
+ "description" : "Department Id",
166
+ "pattern" : "([0-9]+)"
167
+ }
168
+ }, {
169
+ "$ref" : "#/components/parameters/deskModuleName"
170
+ }, {
171
+ "$ref" : "#/components/parameters/status"
172
+ }, {
173
+ "$ref" : "#/components/parameters/financeService"
174
+ }, {
175
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
176
+ } ],
177
+ "responses" : {
178
+ "200" : {
179
+ "$ref" : "#/components/responses/getInvoices"
180
+ },
181
+ "422" : {
182
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
183
+ },
184
+ "500" : {
185
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
186
+ },
187
+ "204" : {
188
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
189
+ },
190
+ "403" : {
191
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
192
+ }
193
+ },
194
+ "security" : [ {
195
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
196
+ }, {
197
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
198
+ } ],
199
+ "x-audience" : [ "external-public" ],
200
+ "x-custom-url-attribute" : {
201
+ "security" : {
202
+ "throttle" : {
203
+ "inline" : [ {
204
+ "scope" : "APPSERVER",
205
+ "rules" : [ {
206
+ "duration" : 60000,
207
+ "lock-period" : 180000,
208
+ "threshold" : 500,
209
+ "hip" : false
210
+ }, {
211
+ "duration" : 3600000,
212
+ "lock-period" : 600000,
213
+ "threshold" : 2000,
214
+ "hip" : false
215
+ } ],
216
+ "window" : "ROLLING",
217
+ "key" : "url.path+user.zuid"
218
+ } ]
219
+ },
220
+ "extraparams" : {
221
+ "disable" : true,
222
+ "ignore" : false
223
+ },
224
+ "authentication" : { }
225
+ },
226
+ "clan-group" : "integration",
227
+ "apihash" : "20c42bcbf0cd1bbd5ee26fd95e69c000",
228
+ "module-group" : "integration",
229
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getInvoices"
230
+ }
231
+ }
232
+ },
233
+ "/api/v1/zohoFinance/inventory/items/fields" : {
234
+ "get" : {
235
+ "tags" : [ "Finance" ],
236
+ "summary" : "Get fields for Inventory Items",
237
+ "description" : "to",
238
+ "operationId" : "getInventoryItemFields",
239
+ "parameters" : [ {
240
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
241
+ } ],
242
+ "responses" : {
243
+ "500" : {
244
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
245
+ },
246
+ "200" : {
247
+ "$ref" : "#/components/responses/inventoryFieldJsonResponse"
248
+ },
249
+ "403" : {
250
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
251
+ }
252
+ },
253
+ "security" : [ {
254
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
255
+ }, {
256
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
257
+ }, {
258
+ "cookie-auth" : [ "cookie-auth" ]
259
+ } ],
260
+ "x-audience" : [ "company-internal" ],
261
+ "x-custom-url-attribute" : {
262
+ "security" : {
263
+ "throttle" : {
264
+ "inline" : [ {
265
+ "scope" : "APPSERVER",
266
+ "rules" : [ {
267
+ "duration" : 60000,
268
+ "lock-period" : 180000,
269
+ "threshold" : 20,
270
+ "hip" : false
271
+ }, {
272
+ "duration" : 3600000,
273
+ "lock-period" : 600000,
274
+ "threshold" : 50,
275
+ "hip" : false
276
+ } ],
277
+ "window" : "ROLLING",
278
+ "key" : "url.path+user.zuid"
279
+ } ]
280
+ },
281
+ "extraparams" : {
282
+ "disable" : true,
283
+ "ignore" : false
284
+ },
285
+ "authentication" : { }
286
+ },
287
+ "clan-group" : "integration",
288
+ "apihash" : "93cc0c947fa20228afbd1266531fb9a2",
289
+ "module-group" : "integration",
290
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getInventoryItemFields"
291
+ }
292
+ }
293
+ },
294
+ "/api/v1/zohoFinance/{financeService}/configuration" : {
295
+ "get" : {
296
+ "tags" : [ "Finance" ],
297
+ "summary" : "Finance configuration details",
298
+ "description" : "To get integrated finance service details.",
299
+ "operationId" : "getConfiguration",
300
+ "parameters" : [ {
301
+ "$ref" : "#/components/parameters/financeService"
302
+ }, {
303
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
304
+ } ],
305
+ "responses" : {
306
+ "200" : {
307
+ "$ref" : "#/components/responses/getConfiguration"
308
+ },
309
+ "422" : {
310
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
311
+ },
312
+ "500" : {
313
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
314
+ },
315
+ "204" : {
316
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
317
+ },
318
+ "403" : {
319
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
320
+ }
321
+ },
322
+ "security" : [ {
323
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
324
+ }, {
325
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
326
+ }, {
327
+ "cookie-auth" : [ "cookie-auth" ]
328
+ } ],
329
+ "x-audience" : [ "company-internal" ],
330
+ "x-custom-url-attribute" : {
331
+ "security" : {
332
+ "throttle" : {
333
+ "inline" : [ {
334
+ "scope" : "APPSERVER",
335
+ "rules" : [ {
336
+ "duration" : 60000,
337
+ "lock-period" : 180000,
338
+ "threshold" : 50,
339
+ "hip" : false
340
+ }, {
341
+ "duration" : 3600000,
342
+ "lock-period" : 600000,
343
+ "threshold" : 200,
344
+ "hip" : false
345
+ } ],
346
+ "window" : "ROLLING",
347
+ "key" : "url.path+user.zuid"
348
+ } ]
349
+ },
350
+ "extraparams" : {
351
+ "disable" : true,
352
+ "ignore" : false
353
+ },
354
+ "authentication" : { }
355
+ },
356
+ "clan-group" : "integration",
357
+ "apihash" : "55e3977e01e7bb058ff1e3a5f77a8f52",
358
+ "module-group" : "integration",
359
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getConfiguration"
360
+ }
361
+ },
362
+ "post" : {
363
+ "tags" : [ "Finance" ],
364
+ "summary" : "integrate finance organizations",
365
+ "description" : "To integrate finance organizations.",
366
+ "operationId" : "addOrganization",
367
+ "parameters" : [ {
368
+ "$ref" : "#/components/parameters/financeService"
369
+ }, {
370
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
371
+ } ],
372
+ "requestBody" : {
373
+ "$ref" : "#/components/requestBodies/addFinanceOrganization"
374
+ },
375
+ "responses" : {
376
+ "422" : {
377
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
378
+ },
379
+ "500" : {
380
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
381
+ },
382
+ "204" : {
383
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
384
+ },
385
+ "403" : {
386
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
387
+ }
388
+ },
389
+ "security" : [ {
390
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
391
+ }, {
392
+ "iam-oauth2-schema" : [ "Desk.integrations.CREATE" ]
393
+ }, {
394
+ "cookie-auth" : [ "cookie-auth" ]
395
+ } ],
396
+ "x-audience" : [ "company-internal" ],
397
+ "x-custom-url-attribute" : {
398
+ "security" : {
399
+ "throttle" : {
400
+ "inline" : [ {
401
+ "scope" : "APPSERVER",
402
+ "rules" : [ {
403
+ "duration" : 60000,
404
+ "lock-period" : 180000,
405
+ "threshold" : 50,
406
+ "hip" : false
407
+ }, {
408
+ "duration" : 3600000,
409
+ "lock-period" : 600000,
410
+ "threshold" : 200,
411
+ "hip" : false
412
+ } ],
413
+ "window" : "ROLLING",
414
+ "key" : "url.path+user.zuid"
415
+ } ]
416
+ },
417
+ "extraparams" : {
418
+ "disable" : true,
419
+ "ignore" : false
420
+ },
421
+ "authentication" : { }
422
+ },
423
+ "clan-group" : "integration",
424
+ "apihash" : "a3b646fc4213782ec55a95e15b6e6c67",
425
+ "module-group" : "integration",
426
+ "apimethod" : "com.zoho.support.restapi.FinanceService.addOrganization"
427
+ }
428
+ },
429
+ "patch" : {
430
+ "tags" : [ "Finance" ],
431
+ "summary" : "enable or disable finance integration",
432
+ "description" : "To enable or disable finance integration.",
433
+ "operationId" : "updateIntegration",
434
+ "parameters" : [ {
435
+ "$ref" : "#/components/parameters/financeService"
436
+ }, {
437
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
438
+ } ],
439
+ "requestBody" : {
440
+ "$ref" : "#/components/requestBodies/updateFinanceIntegration"
441
+ },
442
+ "responses" : {
443
+ "422" : {
444
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
445
+ },
446
+ "500" : {
447
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
448
+ },
449
+ "204" : {
450
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
451
+ },
452
+ "403" : {
453
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
454
+ }
455
+ },
456
+ "security" : [ {
457
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
458
+ }, {
459
+ "iam-oauth2-schema" : [ "Desk.settings.UPDATE" ]
460
+ } ],
461
+ "x-audience" : [ "company-internal" ],
462
+ "x-custom-url-attribute" : {
463
+ "security" : {
464
+ "throttle" : {
465
+ "inline" : [ {
466
+ "scope" : "APPSERVER",
467
+ "rules" : [ {
468
+ "duration" : 60000,
469
+ "lock-period" : 180000,
470
+ "threshold" : 50,
471
+ "hip" : false
472
+ }, {
473
+ "duration" : 3600000,
474
+ "lock-period" : 600000,
475
+ "threshold" : 200,
476
+ "hip" : false
477
+ } ],
478
+ "window" : "ROLLING",
479
+ "key" : "url.path+user.zuid"
480
+ } ]
481
+ },
482
+ "extraparams" : {
483
+ "disable" : true,
484
+ "ignore" : false
485
+ },
486
+ "authentication" : { }
487
+ },
488
+ "clan-group" : "integration",
489
+ "apihash" : "284cb8ce3531c49838a97e0c9d73cebf",
490
+ "module-group" : "integration",
491
+ "apimethod" : "com.zoho.support.restapi.FinanceService.updateIntegration"
492
+ }
493
+ }
494
+ },
495
+ "/api/v1/zohoFinance/{financeService}/estimates" : {
496
+ "get" : {
497
+ "tags" : [ "Finance" ],
498
+ "summary" : "List estimates",
499
+ "description" : "To list estimates.",
500
+ "operationId" : "getEstimates",
501
+ "parameters" : [ {
502
+ "$ref" : "#/components/parameters/deskEntityId"
503
+ }, {
504
+ "$ref" : "#/components/parameters/pageNumber"
505
+ }, {
506
+ "$ref" : "#/components/parameters/deskModuleName"
507
+ }, {
508
+ "$ref" : "#/components/parameters/status"
509
+ }, {
510
+ "$ref" : "#/components/parameters/financeService"
511
+ }, {
512
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
513
+ } ],
514
+ "responses" : {
515
+ "200" : {
516
+ "$ref" : "#/components/responses/getEstimates"
517
+ },
518
+ "422" : {
519
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
520
+ },
521
+ "500" : {
522
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
523
+ },
524
+ "204" : {
525
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
526
+ },
527
+ "403" : {
528
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
529
+ }
530
+ },
531
+ "security" : [ {
532
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
533
+ }, {
534
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
535
+ } ],
536
+ "x-audience" : [ "external-public" ],
537
+ "x-custom-url-attribute" : {
538
+ "security" : {
539
+ "throttle" : {
540
+ "inline" : [ {
541
+ "scope" : "APPSERVER",
542
+ "rules" : [ {
543
+ "duration" : 60000,
544
+ "lock-period" : 180000,
545
+ "threshold" : 50,
546
+ "hip" : false
547
+ }, {
548
+ "duration" : 3600000,
549
+ "lock-period" : 600000,
550
+ "threshold" : 500,
551
+ "hip" : false
552
+ } ],
553
+ "window" : "ROLLING",
554
+ "key" : "url.path+user.zuid"
555
+ } ]
556
+ },
557
+ "extraparams" : {
558
+ "disable" : true,
559
+ "ignore" : false
560
+ },
561
+ "authentication" : { }
562
+ },
563
+ "clan-group" : "integration",
564
+ "apihash" : "3bfdc57a938e7a17afa90f56a212925a",
565
+ "module-group" : "integration",
566
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getEstimates"
567
+ }
568
+ }
569
+ },
570
+ "/api/v1/zohoFinance/{financeService}/estimates/{id}" : {
571
+ "patch" : {
572
+ "tags" : [ "Finance" ],
573
+ "summary" : "Update estimate status ",
574
+ "description" : "This will update status of estimate.",
575
+ "operationId" : "updateEstimateStatus",
576
+ "parameters" : [ {
577
+ "$ref" : "#/components/parameters/financeService"
578
+ }, {
579
+ "$ref" : "#/components/parameters/id"
580
+ }, {
581
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
582
+ } ],
583
+ "requestBody" : {
584
+ "$ref" : "#/components/requestBodies/financeUpdateStatus"
585
+ },
586
+ "responses" : {
587
+ "422" : {
588
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
589
+ },
590
+ "500" : {
591
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
592
+ },
593
+ "204" : {
594
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
595
+ },
596
+ "403" : {
597
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
598
+ }
599
+ },
600
+ "security" : [ {
601
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
602
+ }, {
603
+ "iam-oauth2-schema" : [ "Desk.integrations.UPDATE" ]
604
+ } ],
605
+ "x-audience" : [ "external-public" ],
606
+ "x-custom-url-attribute" : {
607
+ "security" : {
608
+ "throttle" : {
609
+ "inline" : [ {
610
+ "scope" : "APPSERVER",
611
+ "rules" : [ {
612
+ "duration" : 60000,
613
+ "lock-period" : 180000,
614
+ "threshold" : 50,
615
+ "hip" : false
616
+ }, {
617
+ "duration" : 3600000,
618
+ "lock-period" : 600000,
619
+ "threshold" : 400,
620
+ "hip" : false
621
+ } ],
622
+ "window" : "ROLLING",
623
+ "key" : "url.path+user.zuid"
624
+ } ]
625
+ },
626
+ "extraparams" : {
627
+ "disable" : true,
628
+ "ignore" : false
629
+ },
630
+ "authentication" : { }
631
+ },
632
+ "clan-group" : "integration",
633
+ "apihash" : "a73d9fab930499c294c7d1ab2e865742",
634
+ "module-group" : "integration",
635
+ "apimethod" : "com.zoho.support.restapi.FinanceService.updateEstimateStatus"
636
+ }
637
+ }
638
+ },
639
+ "/api/v1/zohoFinance/inventory/syncHistory" : {
640
+ "get" : {
641
+ "tags" : [ "Finance" ],
642
+ "summary" : "Get sync history for last 7 days",
643
+ "description" : "This API is used to get the sync history for last 7 days",
644
+ "operationId" : "getSyncHistory",
645
+ "parameters" : [ {
646
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
647
+ } ],
648
+ "responses" : {
649
+ "500" : {
650
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
651
+ },
652
+ "200" : {
653
+ "$ref" : "#/components/responses/syncHistoryResponse"
654
+ },
655
+ "403" : {
656
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
657
+ }
658
+ },
659
+ "security" : [ {
660
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
661
+ }, {
662
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
663
+ }, {
664
+ "cookie-auth" : [ "cookie-auth" ]
665
+ } ],
666
+ "x-audience" : [ "company-internal" ],
667
+ "x-custom-url-attribute" : {
668
+ "security" : {
669
+ "throttle" : {
670
+ "inline" : [ {
671
+ "scope" : "APPSERVER",
672
+ "rules" : [ {
673
+ "duration" : 60000,
674
+ "lock-period" : 180000,
675
+ "threshold" : 20,
676
+ "hip" : false
677
+ }, {
678
+ "duration" : 3600000,
679
+ "lock-period" : 600000,
680
+ "threshold" : 50,
681
+ "hip" : false
682
+ } ],
683
+ "window" : "ROLLING",
684
+ "key" : "url.path+user.zuid"
685
+ } ]
686
+ },
687
+ "extraparams" : {
688
+ "disable" : true,
689
+ "ignore" : false
690
+ },
691
+ "authentication" : { }
692
+ },
693
+ "clan-group" : "integration",
694
+ "apihash" : "fb07fd8f96d0e445e9075cec6ef06f1e",
695
+ "module-group" : "integration",
696
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getSyncHistory"
697
+ }
698
+ }
699
+ },
700
+ "/api/v1/zohoFinance/{financeService}/{financeEntity}/{financeEntityId}/link" : {
701
+ "patch" : {
702
+ "tags" : [ "Finance" ],
703
+ "operationId" : "linkFinanceEntity",
704
+ "parameters" : [ {
705
+ "name" : "financeEntityId",
706
+ "in" : "path",
707
+ "required" : true,
708
+ "style" : "simple",
709
+ "explode" : false,
710
+ "schema" : {
711
+ "type" : [ "string", "null", "integer" ],
712
+ "format" : "int64",
713
+ "pattern" : "([0-9]+)"
714
+ }
715
+ }, {
716
+ "name" : "financeEntity",
717
+ "in" : "path",
718
+ "required" : true,
719
+ "style" : "simple",
720
+ "explode" : false,
721
+ "schema" : {
722
+ "type" : [ "string", "null" ],
723
+ "enum" : [ "invoices", "estimates", "salesorders", "contacts" ],
724
+ "maxLength" : 100,
725
+ "minLength" : 0,
726
+ "pattern" : "([a-z]+)"
727
+ }
728
+ }, {
729
+ "$ref" : "#/components/parameters/financeService"
730
+ }, {
731
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
732
+ } ],
733
+ "requestBody" : {
734
+ "$ref" : "#/components/requestBodies/linkFinanceEntity"
735
+ },
736
+ "responses" : {
737
+ "422" : {
738
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
739
+ },
740
+ "500" : {
741
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
742
+ },
743
+ "204" : {
744
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
745
+ },
746
+ "403" : {
747
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
748
+ }
749
+ },
750
+ "security" : [ {
751
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
752
+ }, {
753
+ "iam-oauth2-schema" : [ "Desk.integrations.UPDATE" ]
754
+ } ],
755
+ "x-audience" : [ "company-internal" ],
756
+ "x-custom-url-attribute" : {
757
+ "security" : {
758
+ "throttle" : {
759
+ "inline" : [ {
760
+ "scope" : "APPSERVER",
761
+ "rules" : [ {
762
+ "duration" : 60000,
763
+ "lock-period" : 180000,
764
+ "threshold" : 50,
765
+ "hip" : false
766
+ }, {
767
+ "duration" : 3600000,
768
+ "lock-period" : 600000,
769
+ "threshold" : 400,
770
+ "hip" : false
771
+ } ],
772
+ "window" : "ROLLING",
773
+ "key" : "url.path+user.zuid"
774
+ } ]
775
+ },
776
+ "extraparams" : {
777
+ "disable" : true,
778
+ "ignore" : false
779
+ },
780
+ "authentication" : { }
781
+ },
782
+ "clan-group" : "integration",
783
+ "apihash" : "ab301ed699c436f17e7eb206912a562e",
784
+ "module-group" : "integration",
785
+ "apimethod" : "com.zoho.support.restapi.FinanceService.linkFinanceEntity"
786
+ }
787
+ }
788
+ },
789
+ "/api/v1/zohoFinance/{financeService}/invoices/{id}" : {
790
+ "patch" : {
791
+ "tags" : [ "Finance" ],
792
+ "summary" : "Update invoice status ",
793
+ "description" : "This will update status of invoice.",
794
+ "operationId" : "updateInvoiceStatus",
795
+ "parameters" : [ {
796
+ "$ref" : "#/components/parameters/financeService"
797
+ }, {
798
+ "$ref" : "#/components/parameters/id"
799
+ }, {
800
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
801
+ } ],
802
+ "requestBody" : {
803
+ "$ref" : "#/components/requestBodies/updateInvoiceStatus_financeUpdateStatus"
804
+ },
805
+ "responses" : {
806
+ "422" : {
807
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
808
+ },
809
+ "500" : {
810
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
811
+ },
812
+ "204" : {
813
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
814
+ },
815
+ "403" : {
816
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
817
+ }
818
+ },
819
+ "security" : [ {
820
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
821
+ }, {
822
+ "iam-oauth2-schema" : [ "Desk.integrations.UPDATE" ]
823
+ } ],
824
+ "x-audience" : [ "external-public" ],
825
+ "x-custom-url-attribute" : {
826
+ "security" : {
827
+ "throttle" : {
828
+ "inline" : [ {
829
+ "scope" : "APPSERVER",
830
+ "rules" : [ {
831
+ "duration" : 60000,
832
+ "lock-period" : 180000,
833
+ "threshold" : 50,
834
+ "hip" : false
835
+ }, {
836
+ "duration" : 3600000,
837
+ "lock-period" : 600000,
838
+ "threshold" : 400,
839
+ "hip" : false
840
+ } ],
841
+ "window" : "ROLLING",
842
+ "key" : "url.path+user.zuid"
843
+ } ]
844
+ },
845
+ "extraparams" : {
846
+ "disable" : true,
847
+ "ignore" : false
848
+ },
849
+ "authentication" : { }
850
+ },
851
+ "clan-group" : "integration",
852
+ "apihash" : "8587bd0ee84520b95f769dd4b730e4e8",
853
+ "module-group" : "integration",
854
+ "apimethod" : "com.zoho.support.restapi.FinanceService.updateInvoiceStatus"
855
+ }
856
+ }
857
+ },
858
+ "/api/v1/zohoFinance/{financeService}/salesorders" : {
859
+ "get" : {
860
+ "tags" : [ "Finance" ],
861
+ "summary" : "List salesorders",
862
+ "description" : "To list salesorders.",
863
+ "operationId" : "getSalesOrders",
864
+ "parameters" : [ {
865
+ "$ref" : "#/components/parameters/deskEntityId"
866
+ }, {
867
+ "$ref" : "#/components/parameters/pageNumber"
868
+ }, {
869
+ "$ref" : "#/components/parameters/deskModuleName"
870
+ }, {
871
+ "$ref" : "#/components/parameters/financeService"
872
+ }, {
873
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
874
+ } ],
875
+ "responses" : {
876
+ "200" : {
877
+ "$ref" : "#/components/responses/getSalesOrdersResponse"
878
+ },
879
+ "500" : {
880
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
881
+ },
882
+ "204" : {
883
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
884
+ },
885
+ "403" : {
886
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
887
+ }
888
+ },
889
+ "security" : [ {
890
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
891
+ }, {
892
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
893
+ } ],
894
+ "x-audience" : [ "company-internal" ],
895
+ "x-custom-url-attribute" : {
896
+ "security" : {
897
+ "throttle" : {
898
+ "inline" : [ {
899
+ "scope" : "APPSERVER",
900
+ "rules" : [ {
901
+ "duration" : 60000,
902
+ "lock-period" : 180000,
903
+ "threshold" : 50,
904
+ "hip" : false
905
+ }, {
906
+ "duration" : 3600000,
907
+ "lock-period" : 600000,
908
+ "threshold" : 500,
909
+ "hip" : false
910
+ } ],
911
+ "window" : "ROLLING",
912
+ "key" : "url.path+user.zuid"
913
+ } ]
914
+ },
915
+ "extraparams" : {
916
+ "disable" : true,
917
+ "ignore" : false
918
+ },
919
+ "authentication" : { }
920
+ },
921
+ "clan-group" : "integration",
922
+ "apihash" : "c05a84c79bc56cee53fd6013f3ab1c0b",
923
+ "module-group" : "integration",
924
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getSalesOrders"
925
+ }
926
+ }
927
+ },
928
+ "/api/v1/zohoFinance/{financeService}/estimates/markAsSent" : {
929
+ "post" : {
930
+ "tags" : [ "Finance" ],
931
+ "summary" : "MarkAllEstimateSent",
932
+ "description" : "This will update status of estimates to sent.",
933
+ "operationId" : "markEstimatesAsSent",
934
+ "parameters" : [ {
935
+ "$ref" : "#/components/parameters/financeService"
936
+ }, {
937
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
938
+ } ],
939
+ "requestBody" : {
940
+ "$ref" : "#/components/requestBodies/financeMarkAsSent"
941
+ },
942
+ "responses" : {
943
+ "422" : {
944
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
945
+ },
946
+ "500" : {
947
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
948
+ },
949
+ "204" : {
950
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
951
+ },
952
+ "403" : {
953
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
954
+ }
955
+ },
956
+ "security" : [ {
957
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
958
+ }, {
959
+ "iam-oauth2-schema" : [ "Desk.integrations.CREATE" ]
960
+ }, {
961
+ "cookie-auth" : [ "cookie-auth" ]
962
+ } ],
963
+ "x-audience" : [ "company-internal" ],
964
+ "x-custom-url-attribute" : {
965
+ "security" : {
966
+ "throttle" : {
967
+ "inline" : [ {
968
+ "scope" : "APPSERVER",
969
+ "rules" : [ {
970
+ "duration" : 60000,
971
+ "lock-period" : 180000,
972
+ "threshold" : 50,
973
+ "hip" : false
974
+ }, {
975
+ "duration" : 3600000,
976
+ "lock-period" : 600000,
977
+ "threshold" : 400,
978
+ "hip" : false
979
+ } ],
980
+ "window" : "ROLLING",
981
+ "key" : "url.path+user.zuid"
982
+ } ]
983
+ },
984
+ "extraparams" : {
985
+ "disable" : true,
986
+ "ignore" : false
987
+ },
988
+ "authentication" : { }
989
+ },
990
+ "clan-group" : "integration",
991
+ "apihash" : "2c505ebd6ccc94731eae6a99da6c4430",
992
+ "module-group" : "integration",
993
+ "apimethod" : "com.zoho.support.restapi.FinanceService.markEstimatesAsSent"
994
+ }
995
+ }
996
+ },
997
+ "/api/v1/zohoFinance/{financeService}/contacts" : {
998
+ "get" : {
999
+ "tags" : [ "Finance" ],
1000
+ "summary" : "Get contacts",
1001
+ "description" : "This will get integrated finance contacts or contactPerson.",
1002
+ "operationId" : "getFinanceContact",
1003
+ "parameters" : [ {
1004
+ "$ref" : "#/components/parameters/deskEntityId"
1005
+ }, {
1006
+ "$ref" : "#/components/parameters/deskModuleName"
1007
+ }, {
1008
+ "$ref" : "#/components/parameters/financeService"
1009
+ }, {
1010
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1011
+ } ],
1012
+ "responses" : {
1013
+ "200" : {
1014
+ "$ref" : "#/components/responses/getFinanceContact"
1015
+ },
1016
+ "422" : {
1017
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1018
+ },
1019
+ "500" : {
1020
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1021
+ },
1022
+ "204" : {
1023
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1024
+ },
1025
+ "403" : {
1026
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1027
+ }
1028
+ },
1029
+ "security" : [ {
1030
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1031
+ }, {
1032
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1033
+ }, {
1034
+ "cookie-auth" : [ "cookie-auth" ]
1035
+ } ],
1036
+ "x-audience" : [ "company-internal" ],
1037
+ "x-custom-url-attribute" : {
1038
+ "security" : {
1039
+ "throttle" : {
1040
+ "inline" : [ {
1041
+ "scope" : "APPSERVER",
1042
+ "rules" : [ {
1043
+ "duration" : 60000,
1044
+ "lock-period" : 180000,
1045
+ "threshold" : 50,
1046
+ "hip" : false
1047
+ }, {
1048
+ "duration" : 3600000,
1049
+ "lock-period" : 600000,
1050
+ "threshold" : 900,
1051
+ "hip" : false
1052
+ } ],
1053
+ "window" : "ROLLING",
1054
+ "key" : "url.path+user.zuid"
1055
+ } ]
1056
+ },
1057
+ "extraparams" : {
1058
+ "disable" : true,
1059
+ "ignore" : false
1060
+ },
1061
+ "authentication" : { }
1062
+ },
1063
+ "clan-group" : "integration",
1064
+ "apihash" : "f8ea5a8c78b733f7926d1df429491c86",
1065
+ "module-group" : "integration",
1066
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getFinanceContact"
1067
+ }
1068
+ },
1069
+ "post" : {
1070
+ "tags" : [ "Finance" ],
1071
+ "operationId" : "createFinanceContactRequestHandler",
1072
+ "parameters" : [ {
1073
+ "$ref" : "#/components/parameters/financeService"
1074
+ }, {
1075
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1076
+ } ],
1077
+ "requestBody" : {
1078
+ "$ref" : "#/components/requestBodies/createFinanceContact"
1079
+ },
1080
+ "responses" : {
1081
+ "422" : {
1082
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1083
+ },
1084
+ "500" : {
1085
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1086
+ },
1087
+ "204" : {
1088
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1089
+ },
1090
+ "403" : {
1091
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1092
+ }
1093
+ },
1094
+ "security" : [ {
1095
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1096
+ }, {
1097
+ "iam-oauth2-schema" : [ "Desk.integrations.CREATE" ]
1098
+ }, {
1099
+ "cookie-auth" : [ "cookie-auth" ]
1100
+ } ],
1101
+ "x-audience" : [ "company-internal" ],
1102
+ "x-custom-url-attribute" : {
1103
+ "security" : {
1104
+ "throttle" : {
1105
+ "inline" : [ {
1106
+ "scope" : "APPSERVER",
1107
+ "rules" : [ {
1108
+ "duration" : 60000,
1109
+ "lock-period" : 180000,
1110
+ "threshold" : 50,
1111
+ "hip" : false
1112
+ }, {
1113
+ "duration" : 3600000,
1114
+ "lock-period" : 600000,
1115
+ "threshold" : 200,
1116
+ "hip" : false
1117
+ } ],
1118
+ "window" : "ROLLING",
1119
+ "key" : "url.path+user.zuid"
1120
+ } ]
1121
+ },
1122
+ "extraparams" : {
1123
+ "disable" : true,
1124
+ "ignore" : false
1125
+ },
1126
+ "authentication" : { }
1127
+ },
1128
+ "clan-group" : "integration",
1129
+ "apihash" : "8984cef9b006d1d0556c2a7f371096a6",
1130
+ "module-group" : "integration",
1131
+ "apimethod" : "com.zoho.support.restapi.FinanceService.createFinanceContactRequestHandler"
1132
+ }
1133
+ }
1134
+ },
1135
+ "/api/v1/zohoFinance/{financeService}/invoices/markAsSent" : {
1136
+ "post" : {
1137
+ "tags" : [ "Finance" ],
1138
+ "summary" : "MarkAllInvoicesSent",
1139
+ "description" : "This will update status of invoice to sent.",
1140
+ "operationId" : "markInvoicesAsSent",
1141
+ "parameters" : [ {
1142
+ "$ref" : "#/components/parameters/financeService"
1143
+ }, {
1144
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1145
+ } ],
1146
+ "requestBody" : {
1147
+ "$ref" : "#/components/requestBodies/markInvoicesAsSent_financeMarkAsSent"
1148
+ },
1149
+ "responses" : {
1150
+ "422" : {
1151
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1152
+ },
1153
+ "500" : {
1154
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1155
+ },
1156
+ "204" : {
1157
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1158
+ },
1159
+ "403" : {
1160
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1161
+ }
1162
+ },
1163
+ "security" : [ {
1164
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1165
+ }, {
1166
+ "iam-oauth2-schema" : [ "Desk.integrations.CREATE" ]
1167
+ } ],
1168
+ "x-audience" : [ "external-public" ],
1169
+ "x-custom-url-attribute" : {
1170
+ "security" : {
1171
+ "throttle" : {
1172
+ "inline" : [ {
1173
+ "scope" : "APPSERVER",
1174
+ "rules" : [ {
1175
+ "duration" : 60000,
1176
+ "lock-period" : 180000,
1177
+ "threshold" : 50,
1178
+ "hip" : false
1179
+ }, {
1180
+ "duration" : 3600000,
1181
+ "lock-period" : 600000,
1182
+ "threshold" : 400,
1183
+ "hip" : false
1184
+ } ],
1185
+ "window" : "ROLLING",
1186
+ "key" : "url.path+user.zuid"
1187
+ } ]
1188
+ },
1189
+ "extraparams" : {
1190
+ "disable" : true,
1191
+ "ignore" : false
1192
+ },
1193
+ "authentication" : { }
1194
+ },
1195
+ "clan-group" : "integration",
1196
+ "apihash" : "438e61afaec3138eb5d3f375d40d4038",
1197
+ "module-group" : "integration",
1198
+ "apimethod" : "com.zoho.support.restapi.FinanceService.markInvoicesAsSent"
1199
+ }
1200
+ }
1201
+ },
1202
+ "/api/v1/zohoFinance/{financeService}/contacts/{id}/activity" : {
1203
+ "get" : {
1204
+ "tags" : [ "Finance" ],
1205
+ "summary" : "Get history",
1206
+ "description" : "To get history of invoice for the contact",
1207
+ "operationId" : "getActivity",
1208
+ "parameters" : [ {
1209
+ "$ref" : "#/components/parameters/pageNumber"
1210
+ }, {
1211
+ "$ref" : "#/components/parameters/financeService"
1212
+ }, {
1213
+ "$ref" : "#/components/parameters/id"
1214
+ }, {
1215
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1216
+ } ],
1217
+ "responses" : {
1218
+ "200" : {
1219
+ "$ref" : "#/components/responses/getActivity"
1220
+ },
1221
+ "422" : {
1222
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1223
+ },
1224
+ "500" : {
1225
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1226
+ },
1227
+ "204" : {
1228
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1229
+ },
1230
+ "403" : {
1231
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1232
+ }
1233
+ },
1234
+ "security" : [ {
1235
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1236
+ }, {
1237
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1238
+ }, {
1239
+ "cookie-auth" : [ "cookie-auth" ]
1240
+ } ],
1241
+ "x-audience" : [ "company-internal" ],
1242
+ "x-custom-url-attribute" : {
1243
+ "security" : {
1244
+ "throttle" : {
1245
+ "inline" : [ {
1246
+ "scope" : "APPSERVER",
1247
+ "rules" : [ {
1248
+ "duration" : 60000,
1249
+ "lock-period" : 180000,
1250
+ "threshold" : 40,
1251
+ "hip" : false
1252
+ }, {
1253
+ "duration" : 3600000,
1254
+ "lock-period" : 600000,
1255
+ "threshold" : 500,
1256
+ "hip" : false
1257
+ } ],
1258
+ "window" : "ROLLING",
1259
+ "key" : "url.path+user.zuid"
1260
+ } ]
1261
+ },
1262
+ "extraparams" : {
1263
+ "disable" : true,
1264
+ "ignore" : false
1265
+ },
1266
+ "authentication" : { }
1267
+ },
1268
+ "clan-group" : "integration",
1269
+ "apihash" : "46df2ec3f8f6c0a5ac662963c22f4ff2",
1270
+ "module-group" : "integration",
1271
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getActivity"
1272
+ }
1273
+ }
1274
+ },
1275
+ "/api/v1/zohoFinance/{financeService}/organizations" : {
1276
+ "get" : {
1277
+ "tags" : [ "Finance" ],
1278
+ "summary" : "list finance organizations",
1279
+ "description" : "To get finance organizations.",
1280
+ "operationId" : "listOrganizations",
1281
+ "parameters" : [ {
1282
+ "$ref" : "#/components/parameters/financeService"
1283
+ }, {
1284
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1285
+ } ],
1286
+ "responses" : {
1287
+ "200" : {
1288
+ "$ref" : "#/components/responses/listOrganizations"
1289
+ },
1290
+ "422" : {
1291
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1292
+ },
1293
+ "500" : {
1294
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1295
+ },
1296
+ "204" : {
1297
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1298
+ },
1299
+ "403" : {
1300
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1301
+ }
1302
+ },
1303
+ "security" : [ {
1304
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1305
+ }, {
1306
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1307
+ }, {
1308
+ "cookie-auth" : [ "cookie-auth" ]
1309
+ } ],
1310
+ "x-audience" : [ "company-internal" ],
1311
+ "x-custom-url-attribute" : {
1312
+ "security" : {
1313
+ "throttle" : {
1314
+ "inline" : [ {
1315
+ "scope" : "APPSERVER",
1316
+ "rules" : [ {
1317
+ "duration" : 60000,
1318
+ "lock-period" : 180000,
1319
+ "threshold" : 50,
1320
+ "hip" : false
1321
+ }, {
1322
+ "duration" : 3600000,
1323
+ "lock-period" : 600000,
1324
+ "threshold" : 200,
1325
+ "hip" : false
1326
+ } ],
1327
+ "window" : "ROLLING",
1328
+ "key" : "url.path+user.zuid"
1329
+ } ]
1330
+ },
1331
+ "extraparams" : {
1332
+ "disable" : true,
1333
+ "ignore" : false
1334
+ },
1335
+ "authentication" : { }
1336
+ },
1337
+ "clan-group" : "integration",
1338
+ "apihash" : "babbe862b88453b1ae23fb6d334f237c",
1339
+ "module-group" : "integration",
1340
+ "apimethod" : "com.zoho.support.restapi.FinanceService.listOrganizations"
1341
+ }
1342
+ }
1343
+ },
1344
+ "/api/v1/zohoFinance" : {
1345
+ "get" : {
1346
+ "tags" : [ "Finance" ],
1347
+ "summary" : "List finance integration",
1348
+ "description" : "To list finance integration services.",
1349
+ "operationId" : "getFinanceApps",
1350
+ "parameters" : [ {
1351
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1352
+ } ],
1353
+ "responses" : {
1354
+ "200" : {
1355
+ "$ref" : "#/components/responses/getFinanceApps"
1356
+ },
1357
+ "422" : {
1358
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1359
+ },
1360
+ "500" : {
1361
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1362
+ },
1363
+ "204" : {
1364
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1365
+ },
1366
+ "403" : {
1367
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1368
+ }
1369
+ },
1370
+ "security" : [ {
1371
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1372
+ }, {
1373
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1374
+ }, {
1375
+ "cookie-auth" : [ "cookie-auth" ]
1376
+ } ],
1377
+ "x-audience" : [ "company-internal" ],
1378
+ "x-custom-url-attribute" : {
1379
+ "security" : {
1380
+ "throttle" : {
1381
+ "inline" : [ {
1382
+ "scope" : "APPSERVER",
1383
+ "rules" : [ {
1384
+ "duration" : 60000,
1385
+ "lock-period" : 180000,
1386
+ "threshold" : 20,
1387
+ "hip" : false
1388
+ }, {
1389
+ "duration" : 3600000,
1390
+ "lock-period" : 600000,
1391
+ "threshold" : 80,
1392
+ "hip" : false
1393
+ } ],
1394
+ "window" : "ROLLING",
1395
+ "key" : "url.path+user.zuid"
1396
+ } ]
1397
+ },
1398
+ "extraparams" : {
1399
+ "disable" : true,
1400
+ "ignore" : false
1401
+ },
1402
+ "authentication" : { }
1403
+ },
1404
+ "clan-group" : "integration",
1405
+ "apihash" : "2c4c90db74eecfdacbb9dd5f79cd142c",
1406
+ "module-group" : "integration",
1407
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getFinanceApps"
1408
+ }
1409
+ }
1410
+ },
1411
+ "/api/v1/zohoFinance/{financeService}/contacts/search" : {
1412
+ "get" : {
1413
+ "tags" : [ "Finance" ],
1414
+ "operationId" : "searchContacts",
1415
+ "parameters" : [ {
1416
+ "$ref" : "#/components/parameters/deskEntityId"
1417
+ }, {
1418
+ "$ref" : "#/components/parameters/deskModuleName"
1419
+ }, {
1420
+ "$ref" : "#/components/parameters/financeService"
1421
+ }, {
1422
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1423
+ } ],
1424
+ "responses" : {
1425
+ "200" : {
1426
+ "$ref" : "#/components/responses/searchContacts"
1427
+ },
1428
+ "422" : {
1429
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1430
+ },
1431
+ "500" : {
1432
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1433
+ },
1434
+ "204" : {
1435
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1436
+ },
1437
+ "403" : {
1438
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1439
+ }
1440
+ },
1441
+ "security" : [ {
1442
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1443
+ }, {
1444
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1445
+ }, {
1446
+ "cookie-auth" : [ "cookie-auth" ]
1447
+ } ],
1448
+ "x-audience" : [ "company-internal" ],
1449
+ "x-custom-url-attribute" : {
1450
+ "security" : {
1451
+ "throttle" : {
1452
+ "inline" : [ {
1453
+ "scope" : "APPSERVER",
1454
+ "rules" : [ {
1455
+ "duration" : 60000,
1456
+ "lock-period" : 180000,
1457
+ "threshold" : 50,
1458
+ "hip" : false
1459
+ }, {
1460
+ "duration" : 3600000,
1461
+ "lock-period" : 600000,
1462
+ "threshold" : 900,
1463
+ "hip" : false
1464
+ } ],
1465
+ "window" : "ROLLING",
1466
+ "key" : "url.path+user.zuid"
1467
+ } ]
1468
+ },
1469
+ "extraparams" : {
1470
+ "disable" : true,
1471
+ "ignore" : false
1472
+ },
1473
+ "authentication" : { }
1474
+ },
1475
+ "clan-group" : "integration",
1476
+ "apihash" : "0c439acabf2eb37609239613a99179cf",
1477
+ "module-group" : "integration",
1478
+ "apimethod" : "com.zoho.support.restapi.FinanceService.searchContacts"
1479
+ }
1480
+ }
1481
+ },
1482
+ "/api/v1/zohoFinance/{financeService}/modules" : {
1483
+ "get" : {
1484
+ "tags" : [ "Finance" ],
1485
+ "summary" : "Get Finance Module Names",
1486
+ "description" : "To get module names from Zoho Finance",
1487
+ "operationId" : "getFinanceModules",
1488
+ "parameters" : [ {
1489
+ "$ref" : "#/components/parameters/financeService"
1490
+ }, {
1491
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1492
+ } ],
1493
+ "responses" : {
1494
+ "200" : {
1495
+ "$ref" : "#/components/responses/financeModulesArray"
1496
+ },
1497
+ "500" : {
1498
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1499
+ },
1500
+ "204" : {
1501
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1502
+ },
1503
+ "403" : {
1504
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1505
+ }
1506
+ },
1507
+ "security" : [ {
1508
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1509
+ }, {
1510
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1511
+ } ],
1512
+ "x-audience" : [ "company-internal" ],
1513
+ "x-custom-url-attribute" : {
1514
+ "security" : {
1515
+ "throttle" : {
1516
+ "inline" : [ {
1517
+ "scope" : "APPSERVER",
1518
+ "rules" : [ {
1519
+ "duration" : 60000,
1520
+ "lock-period" : 180000,
1521
+ "threshold" : 50,
1522
+ "hip" : false
1523
+ }, {
1524
+ "duration" : 3600000,
1525
+ "lock-period" : 600000,
1526
+ "threshold" : 900,
1527
+ "hip" : false
1528
+ } ],
1529
+ "window" : "ROLLING",
1530
+ "key" : "url.path+user.zuid"
1531
+ } ]
1532
+ },
1533
+ "extraparams" : {
1534
+ "disable" : true,
1535
+ "ignore" : false
1536
+ },
1537
+ "authentication" : { }
1538
+ },
1539
+ "clan-group" : "integration",
1540
+ "apihash" : "db914c0767a2b5fb7b8b4d62e373d02d",
1541
+ "module-group" : "integration",
1542
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getFinanceModules"
1543
+ }
1544
+ }
1545
+ },
1546
+ "/api/v1/zohoFinance/{financeService}/salesorders/{id}/salesreturns" : {
1547
+ "get" : {
1548
+ "tags" : [ "Finance" ],
1549
+ "summary" : "Get salesorder salesreturns",
1550
+ "description" : "To get salesorder salesreturns.",
1551
+ "operationId" : "getSalesReturns",
1552
+ "parameters" : [ {
1553
+ "$ref" : "#/components/parameters/financeService"
1554
+ }, {
1555
+ "$ref" : "#/components/parameters/id"
1556
+ }, {
1557
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1558
+ } ],
1559
+ "responses" : {
1560
+ "200" : {
1561
+ "$ref" : "#/components/responses/getSalesReturnsResponse"
1562
+ },
1563
+ "500" : {
1564
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1565
+ },
1566
+ "204" : {
1567
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1568
+ },
1569
+ "403" : {
1570
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1571
+ }
1572
+ },
1573
+ "security" : [ {
1574
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1575
+ }, {
1576
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1577
+ } ],
1578
+ "x-audience" : [ "company-internal" ],
1579
+ "x-custom-url-attribute" : {
1580
+ "security" : {
1581
+ "throttle" : {
1582
+ "inline" : [ {
1583
+ "scope" : "APPSERVER",
1584
+ "rules" : [ {
1585
+ "duration" : 60000,
1586
+ "lock-period" : 180000,
1587
+ "threshold" : 50,
1588
+ "hip" : false
1589
+ }, {
1590
+ "duration" : 3600000,
1591
+ "lock-period" : 600000,
1592
+ "threshold" : 500,
1593
+ "hip" : false
1594
+ } ],
1595
+ "window" : "ROLLING",
1596
+ "key" : "url.path+user.zuid"
1597
+ } ]
1598
+ },
1599
+ "extraparams" : {
1600
+ "disable" : true,
1601
+ "ignore" : false
1602
+ },
1603
+ "authentication" : { }
1604
+ },
1605
+ "clan-group" : "integration",
1606
+ "apihash" : "00f0a973bcd8d2157bd37e864ef91240",
1607
+ "module-group" : "integration",
1608
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getSalesReturns"
1609
+ }
1610
+ }
1611
+ },
1612
+ "/api/v1/zohoFinance/preferences" : {
1613
+ "get" : {
1614
+ "tags" : [ "Finance" ],
1615
+ "summary" : "Get Finance TimeEntry Prefernces",
1616
+ "description" : "To get time entry preferences.",
1617
+ "operationId" : "getPreferences",
1618
+ "parameters" : [ {
1619
+ "$ref" : "#/components/parameters/deskModuleName"
1620
+ }, {
1621
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1622
+ } ],
1623
+ "responses" : {
1624
+ "200" : {
1625
+ "$ref" : "#/components/responses/getPreferences"
1626
+ },
1627
+ "422" : {
1628
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1629
+ },
1630
+ "500" : {
1631
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1632
+ },
1633
+ "204" : {
1634
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1635
+ },
1636
+ "403" : {
1637
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1638
+ }
1639
+ },
1640
+ "security" : [ {
1641
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1642
+ }, {
1643
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1644
+ } ],
1645
+ "x-audience" : [ "company-internal" ],
1646
+ "x-custom-url-attribute" : {
1647
+ "security" : {
1648
+ "throttle" : {
1649
+ "inline" : [ {
1650
+ "scope" : "APPSERVER",
1651
+ "rules" : [ {
1652
+ "duration" : 60000,
1653
+ "lock-period" : 180000,
1654
+ "threshold" : 50,
1655
+ "hip" : false
1656
+ }, {
1657
+ "duration" : 3600000,
1658
+ "lock-period" : 600000,
1659
+ "threshold" : 500,
1660
+ "hip" : false
1661
+ } ],
1662
+ "window" : "ROLLING",
1663
+ "key" : "url.path+user.zuid"
1664
+ } ]
1665
+ },
1666
+ "extraparams" : {
1667
+ "disable" : true,
1668
+ "ignore" : false
1669
+ },
1670
+ "authentication" : { }
1671
+ },
1672
+ "clan-group" : "integration",
1673
+ "apihash" : "5d4dcb57aa394f2ee0fdae8848904498",
1674
+ "module-group" : "integration",
1675
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getPreferences"
1676
+ }
1677
+ }
1678
+ },
1679
+ "/api/v1/finance/invoices/{id}/tickets" : {
1680
+ "get" : {
1681
+ "tags" : [ "Finance" ],
1682
+ "summary" : "Get tickets for invoices",
1683
+ "description" : "To get associated tickets for invoice id.",
1684
+ "operationId" : "getTicketsForInvoiceId",
1685
+ "parameters" : [ {
1686
+ "$ref" : "#/components/parameters/id"
1687
+ }, {
1688
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1689
+ } ],
1690
+ "responses" : {
1691
+ "200" : {
1692
+ "$ref" : "#/components/responses/getTicketsForInvoiceId"
1693
+ },
1694
+ "422" : {
1695
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1696
+ },
1697
+ "500" : {
1698
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1699
+ },
1700
+ "204" : {
1701
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1702
+ },
1703
+ "403" : {
1704
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1705
+ }
1706
+ },
1707
+ "security" : [ {
1708
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1709
+ }, {
1710
+ "iam-oauth2-schema" : [ "Desk.tickets.READ" ]
1711
+ } ],
1712
+ "x-audience" : [ "external-public" ],
1713
+ "x-custom-url-attribute" : {
1714
+ "security" : {
1715
+ "throttle" : {
1716
+ "inline" : [ {
1717
+ "scope" : "APPSERVER",
1718
+ "rules" : [ {
1719
+ "duration" : 60000,
1720
+ "lock-period" : 600000,
1721
+ "threshold" : 20,
1722
+ "hip" : false
1723
+ }, {
1724
+ "duration" : 3600000,
1725
+ "lock-period" : 1200000,
1726
+ "threshold" : 80,
1727
+ "hip" : false
1728
+ } ],
1729
+ "window" : "ROLLING",
1730
+ "key" : "url.path+user.zuid"
1731
+ } ]
1732
+ },
1733
+ "extraparams" : {
1734
+ "disable" : true,
1735
+ "ignore" : false
1736
+ },
1737
+ "authentication" : { }
1738
+ },
1739
+ "clan-group" : "integration",
1740
+ "apihash" : "d951d5f12a00d343ba4588389d4a7ddc",
1741
+ "module-group" : "integration",
1742
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getTicketsForInvoiceId"
1743
+ }
1744
+ }
1745
+ },
1746
+ "/api/v1/zohoFinance/inventory/sync" : {
1747
+ "get" : {
1748
+ "tags" : [ "Finance" ],
1749
+ "summary" : "Get sync Configuration Between Desk - Inventory",
1750
+ "description" : "This API is used to get the sync Configuration between Desk - Inventory",
1751
+ "operationId" : "getInventoyDeskConfigution",
1752
+ "parameters" : [ {
1753
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1754
+ } ],
1755
+ "responses" : {
1756
+ "200" : {
1757
+ "$ref" : "#/components/responses/productsSyncConfigResponse"
1758
+ },
1759
+ "500" : {
1760
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1761
+ },
1762
+ "204" : {
1763
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1764
+ },
1765
+ "403" : {
1766
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1767
+ }
1768
+ },
1769
+ "security" : [ {
1770
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1771
+ }, {
1772
+ "iam-oauth2-schema" : [ "Desk.integrations.READ" ]
1773
+ }, {
1774
+ "cookie-auth" : [ "cookie-auth" ]
1775
+ } ],
1776
+ "x-audience" : [ "company-internal" ],
1777
+ "x-custom-url-attribute" : {
1778
+ "security" : {
1779
+ "throttle" : {
1780
+ "inline" : [ {
1781
+ "scope" : "APPSERVER",
1782
+ "rules" : [ {
1783
+ "duration" : 60000,
1784
+ "lock-period" : 180000,
1785
+ "threshold" : 20,
1786
+ "hip" : false
1787
+ }, {
1788
+ "duration" : 3600000,
1789
+ "lock-period" : 600000,
1790
+ "threshold" : 50,
1791
+ "hip" : false
1792
+ } ],
1793
+ "window" : "ROLLING",
1794
+ "key" : "url.path+user.zuid"
1795
+ } ]
1796
+ },
1797
+ "extraparams" : {
1798
+ "disable" : true,
1799
+ "ignore" : false
1800
+ },
1801
+ "authentication" : { }
1802
+ },
1803
+ "clan-group" : "integration",
1804
+ "apihash" : "20f72fd514630226002c7c31e700fc1a",
1805
+ "module-group" : "integration",
1806
+ "apimethod" : "com.zoho.support.restapi.FinanceService.getInventoyDeskConfigution"
1807
+ }
1808
+ }
1809
+ },
1810
+ "/api/v1/zohoFinance/{financeService}/contacts/disassociate" : {
1811
+ "delete" : {
1812
+ "tags" : [ "Finance" ],
1813
+ "summary" : "Disassociate desk contact from finance contact",
1814
+ "description" : "This will delink desk, finance contact mepping.",
1815
+ "operationId" : "delinkContactMapping",
1816
+ "parameters" : [ {
1817
+ "$ref" : "#/components/parameters/deskEntityId"
1818
+ }, {
1819
+ "$ref" : "#/components/parameters/financeService"
1820
+ }, {
1821
+ "$ref" : "../common/Common.json#/components/parameters/orgId"
1822
+ } ],
1823
+ "responses" : {
1824
+ "422" : {
1825
+ "$ref" : "../common/Common.json#/components/responses/multipleUnprocessEntityResponse"
1826
+ },
1827
+ "500" : {
1828
+ "$ref" : "../common/Common.json#/components/responses/internalErrorResponse"
1829
+ },
1830
+ "204" : {
1831
+ "$ref" : "../common/Common.json#/components/responses/emptyResponse"
1832
+ },
1833
+ "403" : {
1834
+ "$ref" : "../common/Common.json#/components/responses/forbiddenErrorResponse"
1835
+ }
1836
+ },
1837
+ "security" : [ {
1838
+ "org-oauth" : [ "Desk.accessAll.ALL" ]
1839
+ }, {
1840
+ "iam-oauth2-schema" : [ "Desk.integrations.DELETE" ]
1841
+ }, {
1842
+ "cookie-auth" : [ "cookie-auth" ]
1843
+ } ],
1844
+ "x-audience" : [ "company-internal" ],
1845
+ "x-custom-url-attribute" : {
1846
+ "security" : {
1847
+ "throttle" : {
1848
+ "inline" : [ {
1849
+ "scope" : "APPSERVER",
1850
+ "rules" : [ {
1851
+ "duration" : 60000,
1852
+ "lock-period" : 180000,
1853
+ "threshold" : 50,
1854
+ "hip" : false
1855
+ }, {
1856
+ "duration" : 3600000,
1857
+ "lock-period" : 600000,
1858
+ "threshold" : 200,
1859
+ "hip" : false
1860
+ } ],
1861
+ "window" : "ROLLING",
1862
+ "key" : "url.path+user.zuid"
1863
+ } ]
1864
+ },
1865
+ "extraparams" : {
1866
+ "disable" : true,
1867
+ "ignore" : false
1868
+ },
1869
+ "authentication" : { }
1870
+ },
1871
+ "clan-group" : "integration",
1872
+ "apihash" : "c1afc0d33b6eaa9764f42d1c2c5fc358",
1873
+ "module-group" : "integration",
1874
+ "apimethod" : "com.zoho.support.restapi.FinanceService.delinkContactMapping"
1875
+ }
1876
+ }
1877
+ }
1878
+ },
1879
+ "components" : {
1880
+ "schemas" : {
1881
+ "payment_terms" : {
1882
+ "type" : [ "null", "object" ],
1883
+ "additionalProperties" : false,
1884
+ "properties" : {
1885
+ "paymentTermLabel" : {
1886
+ "type" : [ "string", "null" ],
1887
+ "maxLength" : 100,
1888
+ "minLength" : 0
1889
+ },
1890
+ "id" : {
1891
+ "type" : [ "string", "null" ],
1892
+ "maxLength" : 100,
1893
+ "minLength" : 0
1894
+ },
1895
+ "paymentTerm" : {
1896
+ "type" : [ "string", "null", "integer" ],
1897
+ "format" : "int64",
1898
+ "pattern" : "([0-9]+)"
1899
+ }
1900
+ },
1901
+ "required" : [ "id", "paymentTerm", "paymentTermLabel" ]
1902
+ },
1903
+ "payment_termsArr" : {
1904
+ "type" : [ "null", "array" ],
1905
+ "items" : {
1906
+ "$ref" : "./Finance.json#/components/schemas/payment_terms"
1907
+ }
1908
+ },
1909
+ "currencies" : {
1910
+ "type" : [ "null", "object" ],
1911
+ "additionalProperties" : false,
1912
+ "properties" : {
1913
+ "currencyName" : {
1914
+ "type" : [ "string", "null" ],
1915
+ "maxLength" : 100,
1916
+ "minLength" : 0
1917
+ },
1918
+ "isBaseCurrency" : {
1919
+ "type" : [ "boolean", "null" ]
1920
+ },
1921
+ "currencySymbol" : {
1922
+ "type" : [ "string", "null" ],
1923
+ "maxLength" : 100,
1924
+ "minLength" : 0
1925
+ },
1926
+ "id" : {
1927
+ "type" : [ "string", "null", "integer" ],
1928
+ "format" : "int64",
1929
+ "pattern" : "([0-9]+)"
1930
+ },
1931
+ "currencyCode" : {
1932
+ "type" : [ "string", "null" ],
1933
+ "maxLength" : 100,
1934
+ "minLength" : 0
1935
+ }
1936
+ },
1937
+ "required" : [ "currencyCode", "currencyName", "currencySymbol", "id", "isBaseCurrency" ]
1938
+ },
1939
+ "currenciesArr" : {
1940
+ "type" : [ "null", "array" ],
1941
+ "items" : {
1942
+ "$ref" : "./Finance.json#/components/schemas/currencies"
1943
+ }
1944
+ },
1945
+ "shipment_order" : {
1946
+ "type" : [ "null", "object" ],
1947
+ "additionalProperties" : false,
1948
+ "properties" : {
1949
+ "carrier" : {
1950
+ "type" : [ "string", "null" ],
1951
+ "maxLength" : 100,
1952
+ "minLength" : 0
1953
+ },
1954
+ "shipment_id" : {
1955
+ "type" : [ "string", "null", "integer" ],
1956
+ "format" : "int64",
1957
+ "pattern" : "([0-9]+)"
1958
+ },
1959
+ "shipment_number" : {
1960
+ "type" : [ "string", "null" ],
1961
+ "maxLength" : 100,
1962
+ "minLength" : 0
1963
+ }
1964
+ },
1965
+ "required" : [ "carrier", "shipment_id", "shipment_number" ]
1966
+ },
1967
+ "packagesJson" : {
1968
+ "type" : [ "null", "object" ],
1969
+ "additionalProperties" : false,
1970
+ "properties" : {
1971
+ "date" : {
1972
+ "type" : [ "string", "null" ],
1973
+ "maxLength" : 100,
1974
+ "minLength" : 0,
1975
+ "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
1976
+ },
1977
+ "package_number" : {
1978
+ "type" : [ "string", "null" ],
1979
+ "maxLength" : 100,
1980
+ "minLength" : 0
1981
+ },
1982
+ "quantity" : {
1983
+ "type" : [ "string", "null" ],
1984
+ "maxLength" : 100,
1985
+ "minLength" : 0,
1986
+ "pattern" : "^[0-9]{0,19}$"
1987
+ },
1988
+ "shipment_order" : {
1989
+ "$ref" : "./Finance.json#/components/schemas/shipment_order"
1990
+ },
1991
+ "id" : {
1992
+ "type" : [ "string", "null", "integer" ],
1993
+ "format" : "int64",
1994
+ "pattern" : "([0-9]+)"
1995
+ },
1996
+ "statusFormatted" : {
1997
+ "type" : [ "string", "null" ],
1998
+ "maxLength" : 100,
1999
+ "minLength" : 0
2000
+ },
2001
+ "status" : {
2002
+ "type" : [ "string", "null" ],
2003
+ "maxLength" : 100,
2004
+ "minLength" : 0
2005
+ }
2006
+ },
2007
+ "required" : [ "date", "id", "package_number", "quantity", "shipment_order", "status", "statusFormatted" ]
2008
+ },
2009
+ "packagesArray" : {
2010
+ "type" : [ "null", "array" ],
2011
+ "items" : {
2012
+ "$ref" : "./Finance.json#/components/schemas/packagesJson"
2013
+ }
2014
+ },
2015
+ "data4" : {
2016
+ "type" : [ "null", "object" ],
2017
+ "additionalProperties" : false,
2018
+ "properties" : {
2019
+ "date" : {
2020
+ "type" : [ "string", "null" ],
2021
+ "maxLength" : 100,
2022
+ "minLength" : 0,
2023
+ "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
2024
+ },
2025
+ "total" : {
2026
+ "type" : [ "string", "null", "integer" ],
2027
+ "format" : "int32",
2028
+ "pattern" : "([0-9]+)"
2029
+ },
2030
+ "isViewdByClient" : {
2031
+ "type" : [ "boolean", "null" ]
2032
+ },
2033
+ "totalFormatted" : {
2034
+ "type" : [ "string", "null" ],
2035
+ "maxLength" : 100,
2036
+ "minLength" : 0
2037
+ },
2038
+ "invoiceNumber" : {
2039
+ "type" : [ "string", "null" ],
2040
+ "maxLength" : 100,
2041
+ "minLength" : 0
2042
+ },
2043
+ "dateFormatted" : {
2044
+ "type" : [ "string", "null" ],
2045
+ "maxLength" : 100,
2046
+ "minLength" : 0
2047
+ },
2048
+ "id" : {
2049
+ "type" : [ "string", "null", "integer" ],
2050
+ "format" : "int64",
2051
+ "pattern" : "([0-9]+)"
2052
+ },
2053
+ "currencyCode" : {
2054
+ "type" : [ "string", "null" ],
2055
+ "maxLength" : 100,
2056
+ "minLength" : 0
2057
+ },
2058
+ "statusFormatted" : {
2059
+ "type" : [ "string", "null" ],
2060
+ "maxLength" : 100,
2061
+ "minLength" : 0
2062
+ },
2063
+ "status" : {
2064
+ "type" : [ "string", "null" ],
2065
+ "enum" : [ "sent", "draft", "overdue", "paid", "void", "partially_paid" ],
2066
+ "maxLength" : 100,
2067
+ "minLength" : 0
2068
+ }
2069
+ },
2070
+ "required" : [ "currencyCode", "date", "dateFormatted", "id", "invoiceNumber", "isViewdByClient", "status", "statusFormatted", "total", "totalFormatted" ]
2071
+ },
2072
+ "dataArr4" : {
2073
+ "type" : [ "null", "array" ],
2074
+ "items" : {
2075
+ "$ref" : "./Finance.json#/components/schemas/data4"
2076
+ }
2077
+ },
2078
+ "inventoryFieldsJson" : {
2079
+ "type" : [ "null", "object" ],
2080
+ "additionalProperties" : false,
2081
+ "properties" : {
2082
+ "fieldLabel" : {
2083
+ "type" : [ "string", "null" ],
2084
+ "maxLength" : 300,
2085
+ "minLength" : 0,
2086
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2087
+ },
2088
+ "fieldType" : {
2089
+ "type" : [ "string", "null" ],
2090
+ "maxLength" : 300,
2091
+ "minLength" : 0,
2092
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2093
+ }
2094
+ },
2095
+ "required" : [ "fieldLabel", "fieldType" ]
2096
+ },
2097
+ "inventoryFieldJsonArray" : {
2098
+ "type" : [ "null", "array" ],
2099
+ "items" : {
2100
+ "$ref" : "./Finance.json#/components/schemas/inventoryFieldsJson"
2101
+ }
2102
+ },
2103
+ "data5" : {
2104
+ "type" : [ "null", "object" ],
2105
+ "additionalProperties" : false,
2106
+ "properties" : {
2107
+ "date" : {
2108
+ "type" : [ "string", "null" ],
2109
+ "maxLength" : 100,
2110
+ "minLength" : 0,
2111
+ "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
2112
+ },
2113
+ "total" : {
2114
+ "type" : [ "string", "null", "integer" ],
2115
+ "format" : "int32",
2116
+ "pattern" : "([0-9]+)"
2117
+ },
2118
+ "isViewdByClient" : {
2119
+ "type" : [ "boolean", "null" ]
2120
+ },
2121
+ "estimateNumber" : {
2122
+ "type" : [ "string", "null" ],
2123
+ "maxLength" : 100,
2124
+ "minLength" : 0
2125
+ },
2126
+ "totalFormatted" : {
2127
+ "type" : [ "string", "null" ],
2128
+ "maxLength" : 100,
2129
+ "minLength" : 0
2130
+ },
2131
+ "dateFormatted" : {
2132
+ "type" : [ "string", "null" ],
2133
+ "maxLength" : 100,
2134
+ "minLength" : 0
2135
+ },
2136
+ "id" : {
2137
+ "type" : [ "string", "null", "integer" ],
2138
+ "format" : "int64",
2139
+ "pattern" : "([0-9]+)"
2140
+ },
2141
+ "currencyCode" : {
2142
+ "type" : [ "string", "null" ],
2143
+ "maxLength" : 100,
2144
+ "minLength" : 0
2145
+ },
2146
+ "statusFormatted" : {
2147
+ "type" : [ "string", "null" ],
2148
+ "maxLength" : 100,
2149
+ "minLength" : 0
2150
+ },
2151
+ "status" : {
2152
+ "type" : [ "string", "null" ],
2153
+ "enum" : [ "sent", "draft", "void", "invoiced", "accepted", "declined", "expired" ],
2154
+ "maxLength" : 100,
2155
+ "minLength" : 0
2156
+ }
2157
+ },
2158
+ "required" : [ "currencyCode", "date", "dateFormatted", "estimateNumber", "id", "isViewdByClient", "status", "statusFormatted", "total", "totalFormatted" ]
2159
+ },
2160
+ "dataArr5" : {
2161
+ "type" : [ "null", "array" ],
2162
+ "items" : {
2163
+ "$ref" : "./Finance.json#/components/schemas/data5"
2164
+ }
2165
+ },
2166
+ "subscriptionsJson" : {
2167
+ "type" : [ "null", "object" ],
2168
+ "additionalProperties" : false,
2169
+ "properties" : {
2170
+ "total" : {
2171
+ "type" : [ "string", "null", "integer" ],
2172
+ "format" : "int32",
2173
+ "pattern" : "([0-9]+)"
2174
+ },
2175
+ "subscription_number" : {
2176
+ "type" : [ "string", "null" ],
2177
+ "maxLength" : 100,
2178
+ "minLength" : 0
2179
+ },
2180
+ "id" : {
2181
+ "type" : [ "string", "null", "integer" ],
2182
+ "format" : "int64",
2183
+ "pattern" : "([0-9]+)"
2184
+ },
2185
+ "statusFormatted" : {
2186
+ "type" : [ "string", "null" ],
2187
+ "maxLength" : 100,
2188
+ "minLength" : 0
2189
+ },
2190
+ "currency_code" : {
2191
+ "type" : [ "string", "null" ],
2192
+ "maxLength" : 100,
2193
+ "minLength" : 0
2194
+ },
2195
+ "plan_name" : {
2196
+ "type" : [ "string", "null" ],
2197
+ "maxLength" : 100,
2198
+ "minLength" : 0
2199
+ },
2200
+ "status" : {
2201
+ "type" : [ "string", "null" ],
2202
+ "maxLength" : 100,
2203
+ "minLength" : 0
2204
+ }
2205
+ },
2206
+ "required" : [ "currency_code", "id", "plan_name", "status", "statusFormatted", "subscription_number", "total" ]
2207
+ },
2208
+ "subscriptionsArray" : {
2209
+ "type" : [ "null", "array" ],
2210
+ "items" : {
2211
+ "$ref" : "./Finance.json#/components/schemas/subscriptionsJson"
2212
+ }
2213
+ },
2214
+ "salesOrderJson" : {
2215
+ "type" : [ "null", "object" ],
2216
+ "additionalProperties" : false,
2217
+ "properties" : {
2218
+ "date" : {
2219
+ "type" : [ "string", "null" ],
2220
+ "maxLength" : 100,
2221
+ "minLength" : 0,
2222
+ "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
2223
+ },
2224
+ "total" : {
2225
+ "type" : [ "string", "null", "integer" ],
2226
+ "format" : "int32",
2227
+ "pattern" : "([0-9]+)"
2228
+ },
2229
+ "salesorder_number" : {
2230
+ "type" : [ "string", "null" ],
2231
+ "maxLength" : 100,
2232
+ "minLength" : 0
2233
+ },
2234
+ "id" : {
2235
+ "type" : [ "string", "null", "integer" ],
2236
+ "format" : "int64",
2237
+ "pattern" : "([0-9]+)"
2238
+ },
2239
+ "statusFormatted" : {
2240
+ "type" : [ "string", "null" ],
2241
+ "maxLength" : 100,
2242
+ "minLength" : 0
2243
+ },
2244
+ "currency_code" : {
2245
+ "type" : [ "string", "null" ],
2246
+ "maxLength" : 100,
2247
+ "minLength" : 0
2248
+ },
2249
+ "status" : {
2250
+ "type" : [ "string", "null" ],
2251
+ "maxLength" : 100,
2252
+ "minLength" : 0
2253
+ }
2254
+ },
2255
+ "required" : [ "currency_code", "date", "id", "salesorder_number", "status", "statusFormatted", "total" ]
2256
+ },
2257
+ "salesOrderArray" : {
2258
+ "type" : [ "null", "array" ],
2259
+ "items" : {
2260
+ "$ref" : "./Finance.json#/components/schemas/salesOrderJson"
2261
+ }
2262
+ },
2263
+ "shippingAddress" : {
2264
+ "type" : [ "null", "object" ],
2265
+ "additionalProperties" : false,
2266
+ "properties" : {
2267
+ "zip" : {
2268
+ "type" : [ "string", "null" ],
2269
+ "maxLength" : 100,
2270
+ "minLength" : 0
2271
+ },
2272
+ "country" : {
2273
+ "type" : [ "string", "null" ],
2274
+ "maxLength" : 100,
2275
+ "minLength" : 0
2276
+ },
2277
+ "address" : {
2278
+ "type" : [ "string", "null" ],
2279
+ "maxLength" : 100,
2280
+ "minLength" : 0
2281
+ },
2282
+ "city" : {
2283
+ "type" : [ "string", "null" ],
2284
+ "maxLength" : 100,
2285
+ "minLength" : 0
2286
+ },
2287
+ "phone" : {
2288
+ "type" : [ "string", "null" ],
2289
+ "maxLength" : 100,
2290
+ "minLength" : 0
2291
+ },
2292
+ "address_id" : {
2293
+ "type" : [ "string", "null", "integer" ],
2294
+ "format" : "int64",
2295
+ "pattern" : "([0-9]+)"
2296
+ },
2297
+ "attention" : {
2298
+ "type" : [ "string", "null" ],
2299
+ "maxLength" : 100,
2300
+ "minLength" : 0
2301
+ },
2302
+ "street2" : {
2303
+ "type" : [ "string", "null" ],
2304
+ "maxLength" : 100,
2305
+ "minLength" : 0
2306
+ },
2307
+ "state" : {
2308
+ "type" : [ "string", "null" ],
2309
+ "maxLength" : 100,
2310
+ "minLength" : 0
2311
+ },
2312
+ "state_code" : {
2313
+ "type" : [ "string", "null" ],
2314
+ "maxLength" : 100,
2315
+ "minLength" : 0
2316
+ },
2317
+ "fax" : {
2318
+ "type" : [ "string", "null" ],
2319
+ "maxLength" : 100,
2320
+ "minLength" : 0
2321
+ }
2322
+ },
2323
+ "required" : [ "address", "address_id", "attention", "city", "country", "fax", "phone", "state", "state_code", "street2", "zip" ]
2324
+ },
2325
+ "billingAddress" : {
2326
+ "type" : [ "null", "object" ],
2327
+ "additionalProperties" : false,
2328
+ "properties" : {
2329
+ "zip" : {
2330
+ "type" : [ "string", "null" ],
2331
+ "maxLength" : 100,
2332
+ "minLength" : 0
2333
+ },
2334
+ "country" : {
2335
+ "type" : [ "string", "null" ],
2336
+ "maxLength" : 100,
2337
+ "minLength" : 0
2338
+ },
2339
+ "address" : {
2340
+ "type" : [ "string", "null" ],
2341
+ "maxLength" : 100,
2342
+ "minLength" : 0
2343
+ },
2344
+ "city" : {
2345
+ "type" : [ "string", "null" ],
2346
+ "maxLength" : 100,
2347
+ "minLength" : 0
2348
+ },
2349
+ "phone" : {
2350
+ "type" : [ "string", "null" ],
2351
+ "maxLength" : 100,
2352
+ "minLength" : 0
2353
+ },
2354
+ "address_id" : {
2355
+ "type" : [ "string", "null", "integer" ],
2356
+ "format" : "int64",
2357
+ "pattern" : "([0-9]+)"
2358
+ },
2359
+ "attention" : {
2360
+ "type" : [ "string", "null" ],
2361
+ "maxLength" : 100,
2362
+ "minLength" : 0
2363
+ },
2364
+ "street2" : {
2365
+ "type" : [ "string", "null" ],
2366
+ "maxLength" : 100,
2367
+ "minLength" : 0
2368
+ },
2369
+ "state" : {
2370
+ "type" : [ "string", "null" ],
2371
+ "maxLength" : 100,
2372
+ "minLength" : 0
2373
+ },
2374
+ "state_code" : {
2375
+ "type" : [ "string", "null" ],
2376
+ "maxLength" : 100,
2377
+ "minLength" : 0
2378
+ },
2379
+ "fax" : {
2380
+ "type" : [ "string", "null" ],
2381
+ "maxLength" : 100,
2382
+ "minLength" : 0
2383
+ }
2384
+ },
2385
+ "required" : [ "address", "address_id", "attention", "city", "country", "fax", "phone", "state", "state_code", "street2", "zip" ]
2386
+ },
2387
+ "data6" : {
2388
+ "type" : [ "null", "object" ],
2389
+ "additionalProperties" : false,
2390
+ "properties" : {
2391
+ "date" : {
2392
+ "type" : [ "string", "null" ],
2393
+ "maxLength" : 100,
2394
+ "minLength" : 0,
2395
+ "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
2396
+ },
2397
+ "transactionType" : {
2398
+ "type" : [ "string", "null" ],
2399
+ "maxLength" : 100,
2400
+ "minLength" : 0
2401
+ },
2402
+ "transacationId" : {
2403
+ "type" : [ "string", "null" ],
2404
+ "maxLength" : 100,
2405
+ "minLength" : 0
2406
+ },
2407
+ "commentedById" : {
2408
+ "type" : [ "string", "null" ],
2409
+ "maxLength" : 100,
2410
+ "minLength" : 0
2411
+ },
2412
+ "contactId" : {
2413
+ "type" : [ "string", "null" ],
2414
+ "maxLength" : 100,
2415
+ "minLength" : 0
2416
+ },
2417
+ "description" : {
2418
+ "type" : [ "string", "null" ],
2419
+ "maxLength" : 100,
2420
+ "minLength" : 0
2421
+ },
2422
+ "operationType" : {
2423
+ "type" : [ "string", "null" ],
2424
+ "maxLength" : 100,
2425
+ "minLength" : 0
2426
+ },
2427
+ "id" : {
2428
+ "type" : [ "string", "null", "integer" ],
2429
+ "format" : "int64",
2430
+ "pattern" : "([0-9]+)"
2431
+ },
2432
+ "time" : {
2433
+ "type" : [ "string", "null" ],
2434
+ "maxLength" : 100,
2435
+ "minLength" : 0
2436
+ },
2437
+ "dateDescription" : {
2438
+ "type" : [ "string", "null" ],
2439
+ "maxLength" : 100,
2440
+ "minLength" : 0
2441
+ }
2442
+ },
2443
+ "required" : [ "commentedById", "contactId", "date", "dateDescription", "description", "id", "operationType", "time", "transacationId", "transactionType" ]
2444
+ },
2445
+ "dataArr6" : {
2446
+ "type" : [ "null", "array" ],
2447
+ "items" : {
2448
+ "$ref" : "./Finance.json#/components/schemas/data6"
2449
+ }
2450
+ },
2451
+ "data3" : {
2452
+ "type" : [ "null", "object" ],
2453
+ "additionalProperties" : false,
2454
+ "properties" : {
2455
+ "organizationName" : {
2456
+ "type" : [ "string", "null" ],
2457
+ "maxLength" : 100,
2458
+ "minLength" : 0
2459
+ },
2460
+ "planName" : {
2461
+ "type" : [ "string", "null" ],
2462
+ "maxLength" : 100,
2463
+ "minLength" : 0
2464
+ },
2465
+ "id" : {
2466
+ "type" : [ "string", "null", "integer" ],
2467
+ "format" : "int64",
2468
+ "pattern" : "([0-9]+)"
2469
+ },
2470
+ "currency_code" : {
2471
+ "type" : [ "string", "null" ],
2472
+ "maxLength" : 100,
2473
+ "minLength" : 0
2474
+ }
2475
+ },
2476
+ "required" : [ "currency_code", "id", "organizationName", "planName" ]
2477
+ },
2478
+ "dataArr3" : {
2479
+ "type" : [ "null", "array" ],
2480
+ "items" : {
2481
+ "$ref" : "./Finance.json#/components/schemas/data3"
2482
+ }
2483
+ },
2484
+ "data1" : {
2485
+ "type" : [ "null", "object" ],
2486
+ "additionalProperties" : false,
2487
+ "properties" : {
2488
+ "name" : {
2489
+ "type" : [ "string", "null" ],
2490
+ "maxLength" : 100,
2491
+ "minLength" : 0
2492
+ },
2493
+ "label" : {
2494
+ "type" : [ "string", "null" ],
2495
+ "maxLength" : 100,
2496
+ "minLength" : 0
2497
+ },
2498
+ "isActive" : {
2499
+ "type" : [ "boolean", "null" ]
2500
+ },
2501
+ "status" : {
2502
+ "type" : [ "string", "null" ],
2503
+ "maxLength" : 100,
2504
+ "minLength" : 0
2505
+ }
2506
+ },
2507
+ "required" : [ "isActive", "label", "name", "status" ]
2508
+ },
2509
+ "dataArr1" : {
2510
+ "type" : [ "null", "array" ],
2511
+ "items" : {
2512
+ "$ref" : "./Finance.json#/components/schemas/data1"
2513
+ }
2514
+ },
2515
+ "contacts" : {
2516
+ "type" : [ "null", "object" ],
2517
+ "additionalProperties" : false,
2518
+ "properties" : {
2519
+ "firstName" : {
2520
+ "type" : [ "string", "null" ],
2521
+ "maxLength" : 100,
2522
+ "minLength" : 0
2523
+ },
2524
+ "lastName" : {
2525
+ "type" : [ "string", "null" ],
2526
+ "maxLength" : 100,
2527
+ "minLength" : 0
2528
+ },
2529
+ "contactPersonId" : {
2530
+ "type" : [ "string", "null", "integer" ],
2531
+ "format" : "int64",
2532
+ "pattern" : "([0-9]+)"
2533
+ },
2534
+ "phone" : {
2535
+ "type" : [ "string", "null" ],
2536
+ "maxLength" : 100,
2537
+ "minLength" : 0
2538
+ },
2539
+ "contactName" : {
2540
+ "type" : [ "string", "null" ],
2541
+ "maxLength" : 100,
2542
+ "minLength" : 0
2543
+ },
2544
+ "id" : {
2545
+ "type" : [ "string", "null", "integer" ],
2546
+ "format" : "int64",
2547
+ "pattern" : "([0-9]+)"
2548
+ },
2549
+ "currencycode" : {
2550
+ "type" : [ "string", "null" ],
2551
+ "maxLength" : 100,
2552
+ "minLength" : 0
2553
+ },
2554
+ "isPrimaryContact" : {
2555
+ "type" : [ "boolean", "null" ]
2556
+ },
2557
+ "email" : {
2558
+ "type" : [ "string", "null" ],
2559
+ "maxLength" : 100,
2560
+ "minLength" : 0,
2561
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
2562
+ }
2563
+ },
2564
+ "required" : [ "contactName", "contactPersonId", "currencycode", "email", "firstName", "id", "isPrimaryContact", "lastName", "phone" ]
2565
+ },
2566
+ "contactsArr" : {
2567
+ "type" : [ "null", "array" ],
2568
+ "items" : {
2569
+ "$ref" : "./Finance.json#/components/schemas/contacts"
2570
+ }
2571
+ },
2572
+ "financeModulesJson" : {
2573
+ "type" : [ "null", "object" ],
2574
+ "additionalProperties" : false,
2575
+ "properties" : {
2576
+ "singular_label" : {
2577
+ "type" : [ "string", "null" ],
2578
+ "maxLength" : 100,
2579
+ "minLength" : 0
2580
+ },
2581
+ "plural_label" : {
2582
+ "type" : [ "string", "null" ],
2583
+ "maxLength" : 100,
2584
+ "minLength" : 0
2585
+ },
2586
+ "api_name" : {
2587
+ "type" : [ "string", "null" ],
2588
+ "maxLength" : 100,
2589
+ "minLength" : 0
2590
+ }
2591
+ },
2592
+ "required" : [ "api_name", "plural_label", "singular_label" ]
2593
+ },
2594
+ "createFinanceContactPerson" : {
2595
+ "type" : [ "null", "object" ],
2596
+ "additionalProperties" : false,
2597
+ "properties" : {
2598
+ "phone" : {
2599
+ "type" : [ "string", "null" ],
2600
+ "maxLength" : 100,
2601
+ "minLength" : 0
2602
+ },
2603
+ "name" : {
2604
+ "type" : [ "string", "null" ],
2605
+ "maxLength" : 100,
2606
+ "minLength" : 0
2607
+ },
2608
+ "email" : {
2609
+ "type" : [ "string", "null" ],
2610
+ "maxLength" : 100,
2611
+ "minLength" : 0,
2612
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
2613
+ }
2614
+ },
2615
+ "required" : [ "email", "name", "phone" ]
2616
+ },
2617
+ "salesReturnsJson" : {
2618
+ "type" : [ "null", "object" ],
2619
+ "additionalProperties" : false,
2620
+ "properties" : {
2621
+ "date" : {
2622
+ "type" : [ "string", "null" ],
2623
+ "maxLength" : 100,
2624
+ "minLength" : 0,
2625
+ "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
2626
+ },
2627
+ "total" : {
2628
+ "type" : [ "string", "null", "integer" ],
2629
+ "format" : "int32",
2630
+ "pattern" : "([0-9]+)"
2631
+ },
2632
+ "salesreturn_number" : {
2633
+ "type" : [ "string", "null" ],
2634
+ "maxLength" : 100,
2635
+ "minLength" : 0
2636
+ },
2637
+ "id" : {
2638
+ "type" : [ "string", "null", "integer" ],
2639
+ "format" : "int64",
2640
+ "pattern" : "([0-9]+)"
2641
+ },
2642
+ "status_formatted" : {
2643
+ "type" : [ "string", "null" ],
2644
+ "maxLength" : 100,
2645
+ "minLength" : 0
2646
+ },
2647
+ "status" : {
2648
+ "type" : [ "string", "null" ],
2649
+ "maxLength" : 100,
2650
+ "minLength" : 0
2651
+ }
2652
+ },
2653
+ "required" : [ "date", "id", "salesreturn_number", "status", "status_formatted", "total" ]
2654
+ },
2655
+ "salesreturnsArray" : {
2656
+ "type" : [ "null", "array" ],
2657
+ "items" : {
2658
+ "$ref" : "./Finance.json#/components/schemas/salesReturnsJson"
2659
+ }
2660
+ },
2661
+ "assignee" : {
2662
+ "type" : [ "null", "object" ],
2663
+ "additionalProperties" : false,
2664
+ "properties" : {
2665
+ "firstName" : {
2666
+ "type" : [ "string", "null" ],
2667
+ "maxLength" : 100,
2668
+ "minLength" : 0
2669
+ },
2670
+ "lastName" : {
2671
+ "type" : [ "string", "null" ],
2672
+ "maxLength" : 100,
2673
+ "minLength" : 0
2674
+ }
2675
+ },
2676
+ "required" : [ "firstName", "lastName" ]
2677
+ },
2678
+ "data" : {
2679
+ "type" : [ "null", "object" ],
2680
+ "additionalProperties" : false,
2681
+ "properties" : {
2682
+ "ticketNumber" : {
2683
+ "type" : [ "string", "null", "integer" ],
2684
+ "format" : "int32",
2685
+ "pattern" : "([0-9]+)"
2686
+ },
2687
+ "subject" : {
2688
+ "type" : [ "string", "null" ],
2689
+ "maxLength" : 1000,
2690
+ "minLength" : 0
2691
+ },
2692
+ "dueDate" : {
2693
+ "type" : [ "string", "null" ],
2694
+ "maxLength" : 100,
2695
+ "minLength" : 0,
2696
+ "pattern" : "(((19|20)\\d\\d)[-/.]{1}(0?[1-9]|1[012])[-/.]{1}(0?[1-9]|[12][0-9]|3[01])(T)([01]?[0-9]|2[0-3]):[0-5]?[0-9]:[0-5]?[0-9]([/.][\\d]{0,3})?(Z))"
2697
+ },
2698
+ "id" : {
2699
+ "type" : [ "string", "null", "integer" ],
2700
+ "format" : "int64",
2701
+ "pattern" : "([0-9]+)"
2702
+ },
2703
+ "assignee" : {
2704
+ "$ref" : "./Finance.json#/components/schemas/assignee"
2705
+ },
2706
+ "priority" : {
2707
+ "type" : [ "string", "null" ],
2708
+ "x-dynamic-enum" : true
2709
+ },
2710
+ "status" : {
2711
+ "type" : [ "string", "null" ],
2712
+ "x-dynamic-enum" : true
2713
+ },
2714
+ "commentCount" : {
2715
+ "type" : [ "string", "null", "integer" ],
2716
+ "format" : "int32",
2717
+ "pattern" : "([0-9]+)"
2718
+ }
2719
+ },
2720
+ "required" : [ "assignee", "commentCount", "dueDate", "id", "priority", "status", "subject", "ticketNumber" ]
2721
+ },
2722
+ "dataArr" : {
2723
+ "type" : [ "null", "array" ],
2724
+ "items" : {
2725
+ "$ref" : "./Finance.json#/components/schemas/data"
2726
+ }
2727
+ },
2728
+ "fieldMappingJson" : {
2729
+ "type" : [ "null", "object" ],
2730
+ "additionalProperties" : false,
2731
+ "properties" : {
2732
+ "deskField" : {
2733
+ "type" : [ "string", "null" ],
2734
+ "maxLength" : 300,
2735
+ "minLength" : 0,
2736
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2737
+ },
2738
+ "inventoryField" : {
2739
+ "type" : [ "string", "null" ],
2740
+ "maxLength" : 300,
2741
+ "minLength" : 0,
2742
+ "pattern" : "([0-9a-zA-Z_\\-\\.\\$@\\?\\,\\:\\'\\/\\!\\P{InBasicLatin}\\s])+"
2743
+ }
2744
+ },
2745
+ "required" : [ "deskField", "inventoryField" ]
2746
+ },
2747
+ "fieldMappingJsonArray" : {
2748
+ "type" : [ "null", "array" ],
2749
+ "items" : {
2750
+ "$ref" : "./Finance.json#/components/schemas/fieldMappingJson"
2751
+ }
2752
+ },
2753
+ "syncConfigurationSingleEntityResponse" : {
2754
+ "type" : [ "null", "object" ],
2755
+ "additionalProperties" : false,
2756
+ "properties" : {
2757
+ "fieldMapping" : {
2758
+ "$ref" : "./Finance.json#/components/schemas/fieldMappingJsonArray"
2759
+ },
2760
+ "syncState" : {
2761
+ "type" : [ "string", "null" ],
2762
+ "enum" : [ "on", "off" ],
2763
+ "maxLength" : 100,
2764
+ "minLength" : 0
2765
+ },
2766
+ "departmentIds" : {
2767
+ "type" : [ "null", "array" ],
2768
+ "items" : {
2769
+ "type" : [ "null", "object" ],
2770
+ "additionalProperties" : false
2771
+ },
2772
+ "uniqueItems" : false
2773
+ },
2774
+ "syncType" : {
2775
+ "type" : [ "string", "null" ],
2776
+ "enum" : [ "oneway", "twoway" ],
2777
+ "maxLength" : 100,
2778
+ "minLength" : 0
2779
+ }
2780
+ },
2781
+ "required" : [ "departmentIds", "fieldMapping", "syncState", "syncType" ]
2782
+ },
2783
+ "syncJson" : {
2784
+ "type" : [ "null", "object" ],
2785
+ "additionalProperties" : false,
2786
+ "properties" : {
2787
+ "added" : {
2788
+ "type" : [ "string", "null", "integer" ],
2789
+ "format" : "int32",
2790
+ "pattern" : "([0-9]+)"
2791
+ },
2792
+ "updated" : {
2793
+ "type" : [ "string", "null", "integer" ],
2794
+ "format" : "int32",
2795
+ "pattern" : "([0-9]+)"
2796
+ },
2797
+ "skipped" : {
2798
+ "type" : [ "string", "null", "integer" ],
2799
+ "format" : "int32",
2800
+ "pattern" : "([0-9]+)"
2801
+ }
2802
+ },
2803
+ "required" : [ "added", "skipped", "updated" ]
2804
+ },
2805
+ "productsSyncHistoryResponse" : {
2806
+ "type" : [ "null", "object" ],
2807
+ "additionalProperties" : false,
2808
+ "properties" : {
2809
+ "products" : {
2810
+ "$ref" : "./Finance.json#/components/schemas/syncJson"
2811
+ }
2812
+ },
2813
+ "required" : [ "products" ]
2814
+ },
2815
+ "daySyncHistoryResponse" : {
2816
+ "type" : [ "null", "object" ],
2817
+ "additionalProperties" : false,
2818
+ "properties" : {
2819
+ "date" : {
2820
+ "type" : [ "string", "null" ],
2821
+ "maxLength" : 100,
2822
+ "minLength" : 0,
2823
+ "pattern" : "^([12][0-9]{3})-(0?[1-9]|1[012])-(0?[1-9]|[12][0-9]|3[01])$"
2824
+ },
2825
+ "frominventory" : {
2826
+ "$ref" : "./Finance.json#/components/schemas/productsSyncHistoryResponse"
2827
+ }
2828
+ },
2829
+ "required" : [ "date", "frominventory" ]
2830
+ },
2831
+ "syncJSONArray" : {
2832
+ "type" : [ "null", "array" ],
2833
+ "items" : {
2834
+ "$ref" : "./Finance.json#/components/schemas/daySyncHistoryResponse"
2835
+ }
2836
+ }
2837
+ },
2838
+ "responses" : {
2839
+ "paymentMeta" : {
2840
+ "description" : "paymentMeta template definitions",
2841
+ "content" : {
2842
+ "application/json" : {
2843
+ "schema" : {
2844
+ "type" : [ "null", "object" ],
2845
+ "additionalProperties" : false,
2846
+ "properties" : {
2847
+ "payment_terms" : {
2848
+ "$ref" : "./Finance.json#/components/schemas/payment_termsArr"
2849
+ },
2850
+ "currencies" : {
2851
+ "$ref" : "./Finance.json#/components/schemas/currenciesArr"
2852
+ }
2853
+ },
2854
+ "required" : [ "currencies", "payment_terms" ]
2855
+ },
2856
+ "examples" : {
2857
+ "Valid responses Definitions" : {
2858
+ "value" : {
2859
+ "payment_terms" : [ {
2860
+ "paymentTermLabel" : "Net 15",
2861
+ "id" : "31000000000303",
2862
+ "paymentTerm" : 15
2863
+ }, {
2864
+ "paymentTermLabel" : "Net 30",
2865
+ "id" : "31000000000305",
2866
+ "paymentTerm" : 30
2867
+ }, {
2868
+ "paymentTermLabel" : "Net 45",
2869
+ "id" : "31000000000307",
2870
+ "paymentTerm" : 45
2871
+ }, {
2872
+ "paymentTermLabel" : "Net 60",
2873
+ "id" : "31000000000309",
2874
+ "paymentTerm" : 60
2875
+ } ],
2876
+ "currencies" : [ {
2877
+ "currencyName" : "AED- UAE Dirham",
2878
+ "currencySymbol" : "AED",
2879
+ "id" : "31000000002480",
2880
+ "currencyCode" : "AED"
2881
+ }, {
2882
+ "currencyName" : "AUD- Australian Dollar",
2883
+ "currencySymbol" : "$",
2884
+ "id" : "31000000000073",
2885
+ "currencyCode" : "AUD"
2886
+ }, {
2887
+ "currencyName" : "CAD- Canadian Dollar",
2888
+ "currencySymbol" : "$",
2889
+ "id" : "31000000000067",
2890
+ "currencyCode" : "CAD"
2891
+ }, {
2892
+ "currencyName" : "CNY- Yuan Renminbi",
2893
+ "currencySymbol" : "CNY",
2894
+ "id" : "31000000000085",
2895
+ "currencyCode" : "CNY"
2896
+ } ]
2897
+ }
2898
+ }
2899
+ }
2900
+ }
2901
+ },
2902
+ "x-custom-response-attributes" : {
2903
+ "disable-safe-headers" : "[]"
2904
+ }
2905
+ },
2906
+ "getSalesOrderPackagesResponse" : {
2907
+ "description" : "getSalesOrderPackagesResponse template definitions",
2908
+ "content" : {
2909
+ "application/json" : {
2910
+ "schema" : {
2911
+ "type" : [ "null", "object" ],
2912
+ "additionalProperties" : false,
2913
+ "properties" : {
2914
+ "data" : {
2915
+ "$ref" : "./Finance.json#/components/schemas/packagesArray"
2916
+ }
2917
+ },
2918
+ "required" : [ "data" ]
2919
+ },
2920
+ "examples" : {
2921
+ "Valid responses Definitions" : {
2922
+ "value" : {
2923
+ "data" : [ {
2924
+ "date" : "2018-09-23",
2925
+ "package_number" : "PKG-111",
2926
+ "quantity" : "0",
2927
+ "shipment_order" : {
2928
+ "carrier" : "FedEx",
2929
+ "shipment_id" : "8237838383",
2930
+ "shipment_number" : "101"
2931
+ },
2932
+ "id" : "83474747784",
2933
+ "status_formatted" : "Shipped",
2934
+ "status" : "shipped"
2935
+ }, {
2936
+ "date" : "2018-09-3",
2937
+ "package_number" : "PKG-112",
2938
+ "quantity" : "0",
2939
+ "shipment_order" : {
2940
+ "carrier" : "FedEx",
2941
+ "shipment_id" : "894383848",
2942
+ "shipment_number" : "111"
2943
+ },
2944
+ "id" : "3898484884",
2945
+ "status_formatted" : "Shipped",
2946
+ "status" : "shipped"
2947
+ } ]
2948
+ }
2949
+ }
2950
+ }
2951
+ }
2952
+ },
2953
+ "x-custom-response-attributes" : {
2954
+ "disable-safe-headers" : "[]"
2955
+ }
2956
+ },
2957
+ "getInvoices" : {
2958
+ "description" : "getInvoices template definitions",
2959
+ "content" : {
2960
+ "application/json" : {
2961
+ "schema" : {
2962
+ "type" : [ "null", "object" ],
2963
+ "additionalProperties" : false,
2964
+ "properties" : {
2965
+ "deskEntityId" : {
2966
+ "type" : [ "string", "null", "integer" ],
2967
+ "format" : "int64",
2968
+ "pattern" : "([0-9]+)",
2969
+ "x-custom-parameters-attributes" : {
2970
+ "removeExif" : false,
2971
+ "replacementString" : "",
2972
+ "filterMatchedContent" : false,
2973
+ "antivirus" : false,
2974
+ "allowInvalid" : false,
2975
+ "descrption" : "To fetch invoice by desk contact or account or ticket id",
2976
+ "secret" : false,
2977
+ "preserveCharsLimit" : 10,
2978
+ "trim" : false,
2979
+ "internalParam" : false,
2980
+ "preserveChars" : "0,5",
2981
+ "importUrl" : false,
2982
+ "decrypt" : false
2983
+ }
2984
+ },
2985
+ "data" : {
2986
+ "$ref" : "./Finance.json#/components/schemas/dataArr4"
2987
+ },
2988
+ "deskModuleName" : {
2989
+ "type" : [ "string", "null" ],
2990
+ "enum" : [ "Cases", "Contacts", "Accounts" ],
2991
+ "maxLength" : 100,
2992
+ "minLength" : 0,
2993
+ "x-custom-parameters-attributes" : {
2994
+ "removeExif" : false,
2995
+ "replacementString" : "",
2996
+ "filterMatchedContent" : false,
2997
+ "antivirus" : false,
2998
+ "allowInvalid" : false,
2999
+ "descrption" : "Desk Module Name: Contacts or Cases or Accounts",
3000
+ "secret" : false,
3001
+ "preserveCharsLimit" : 10,
3002
+ "trim" : false,
3003
+ "internalParam" : false,
3004
+ "preserveChars" : "0,5",
3005
+ "importUrl" : false,
3006
+ "decrypt" : false
3007
+ }
3008
+ }
3009
+ },
3010
+ "required" : [ "data", "deskEntityId", "deskModuleName" ]
3011
+ },
3012
+ "examples" : {
3013
+ "Valid responses Definitions" : {
3014
+ "value" : {
3015
+ "deskEntityId" : "5000000014010",
3016
+ "data" : [ {
3017
+ "date" : "2018-09-23",
3018
+ "total" : 117,
3019
+ "isViewdByClient" : false,
3020
+ "totalFormatted" : "AED117.00",
3021
+ "invoiceNumber" : "INV-000025",
3022
+ "id" : "1332784000000108001",
3023
+ "dateFormatted" : "23 Sep 2018",
3024
+ "currencyCode" : "AED",
3025
+ "statusFormatted" : "Draft",
3026
+ "status" : "draft"
3027
+ } ],
3028
+ "deskModuleName" : "Contacts"
3029
+ }
3030
+ }
3031
+ }
3032
+ }
3033
+ },
3034
+ "x-custom-response-attributes" : {
3035
+ "disable-safe-headers" : "[]"
3036
+ }
3037
+ },
3038
+ "inventoryFieldJsonResponse" : {
3039
+ "description" : "inventoryFieldJsonResponse template definitions",
3040
+ "content" : {
3041
+ "application/json" : {
3042
+ "schema" : {
3043
+ "type" : [ "null", "object" ],
3044
+ "additionalProperties" : false,
3045
+ "properties" : {
3046
+ "data" : {
3047
+ "$ref" : "./Finance.json#/components/schemas/inventoryFieldJsonArray"
3048
+ }
3049
+ },
3050
+ "required" : [ "data" ]
3051
+ },
3052
+ "examples" : {
3053
+ "Valid responses Definitions" : {
3054
+ "value" : {
3055
+ "data" : [ {
3056
+ "fieldLabel" : "Item Name",
3057
+ "fieldType" : "TEXT"
3058
+ }, {
3059
+ "fieldLabel" : "SKU",
3060
+ "fieldType" : "TEXT"
3061
+ }, {
3062
+ "fieldLabel" : "Sales Description",
3063
+ "fieldType" : "TEXT"
3064
+ }, {
3065
+ "fieldLabel" : "Product Category",
3066
+ "fieldType" : "TEXT"
3067
+ }, {
3068
+ "fieldLabel" : "Sales Price",
3069
+ "fieldType" : "AMOUNT"
3070
+ }, {
3071
+ "fieldLabel" : "Status",
3072
+ "fieldType" : "TEXT"
3073
+ }, {
3074
+ "fieldLabel" : "Opening Stock",
3075
+ "fieldType" : "DECIMAL"
3076
+ }, {
3077
+ "fieldLabel" : "Tax Exemption ID",
3078
+ "fieldType" : "NUMBER"
3079
+ }, {
3080
+ "fieldLabel" : "Tax ID",
3081
+ "fieldType" : "NUMBER"
3082
+ }, {
3083
+ "fieldLabel" : "Type",
3084
+ "fieldType" : "TEXT"
3085
+ } ]
3086
+ }
3087
+ }
3088
+ }
3089
+ }
3090
+ },
3091
+ "x-custom-response-attributes" : {
3092
+ "disable-safe-headers" : "[]"
3093
+ }
3094
+ },
3095
+ "getConfiguration" : {
3096
+ "description" : "getConfiguration template definitions",
3097
+ "content" : {
3098
+ "application/json" : {
3099
+ "schema" : {
3100
+ "type" : [ "null", "object" ],
3101
+ "additionalProperties" : false,
3102
+ "properties" : {
3103
+ "organizationId" : {
3104
+ "type" : [ "string", "null", "integer" ],
3105
+ "format" : "int64",
3106
+ "pattern" : "([0-9]+)"
3107
+ },
3108
+ "organizationName" : {
3109
+ "type" : [ "string", "null" ],
3110
+ "maxLength" : 100,
3111
+ "minLength" : 0
3112
+ },
3113
+ "isUserInOrg" : {
3114
+ "type" : [ "boolean", "null" ]
3115
+ },
3116
+ "baseCurrency" : {
3117
+ "type" : [ "string", "null" ],
3118
+ "maxLength" : 100,
3119
+ "minLength" : 0
3120
+ },
3121
+ "status" : {
3122
+ "type" : [ "string", "null" ],
3123
+ "maxLength" : 100,
3124
+ "minLength" : 0
3125
+ }
3126
+ },
3127
+ "required" : [ "baseCurrency", "isUserInOrg", "organizationId", "organizationName", "status" ]
3128
+ },
3129
+ "examples" : {
3130
+ "Valid responses Definitions" : {
3131
+ "value" : {
3132
+ "organizationId" : "9238492829",
3133
+ "organizationName" : "Zylker",
3134
+ "isUserInOrg" : true,
3135
+ "baseCurrency" : "USD",
3136
+ "status" : "ENABLED"
3137
+ }
3138
+ }
3139
+ }
3140
+ }
3141
+ },
3142
+ "x-custom-response-attributes" : {
3143
+ "disable-safe-headers" : "[]"
3144
+ }
3145
+ },
3146
+ "getEstimates" : {
3147
+ "description" : "getEstimates template definitions",
3148
+ "content" : {
3149
+ "application/json" : {
3150
+ "schema" : {
3151
+ "type" : [ "null", "object" ],
3152
+ "additionalProperties" : false,
3153
+ "properties" : {
3154
+ "deskEntityId" : {
3155
+ "type" : [ "string", "null", "integer" ],
3156
+ "format" : "int64",
3157
+ "pattern" : "([0-9]+)",
3158
+ "x-custom-parameters-attributes" : {
3159
+ "removeExif" : false,
3160
+ "replacementString" : "",
3161
+ "filterMatchedContent" : false,
3162
+ "antivirus" : false,
3163
+ "allowInvalid" : false,
3164
+ "descrption" : "To fetch estimates by desk contact or account or ticket id",
3165
+ "secret" : false,
3166
+ "preserveCharsLimit" : 10,
3167
+ "trim" : false,
3168
+ "internalParam" : false,
3169
+ "preserveChars" : "0,5",
3170
+ "importUrl" : false,
3171
+ "decrypt" : false
3172
+ }
3173
+ },
3174
+ "data" : {
3175
+ "$ref" : "./Finance.json#/components/schemas/dataArr5"
3176
+ },
3177
+ "deskModuleName" : {
3178
+ "type" : [ "string", "null" ],
3179
+ "enum" : [ "Cases", "Contacts", "Accounts" ],
3180
+ "maxLength" : 100,
3181
+ "minLength" : 0,
3182
+ "x-custom-parameters-attributes" : {
3183
+ "removeExif" : false,
3184
+ "replacementString" : "",
3185
+ "filterMatchedContent" : false,
3186
+ "antivirus" : false,
3187
+ "allowInvalid" : false,
3188
+ "descrption" : "Desk Module Name. allowed modules are Contacts, Cases, Accounts",
3189
+ "secret" : false,
3190
+ "preserveCharsLimit" : 10,
3191
+ "trim" : false,
3192
+ "internalParam" : false,
3193
+ "preserveChars" : "0,5",
3194
+ "importUrl" : false,
3195
+ "decrypt" : false
3196
+ }
3197
+ }
3198
+ },
3199
+ "required" : [ "data", "deskEntityId", "deskModuleName" ]
3200
+ },
3201
+ "examples" : {
3202
+ "Valid responses Definitions" : {
3203
+ "value" : {
3204
+ "deskEntityId" : "5000000014010",
3205
+ "data" : [ {
3206
+ "date" : "2018-09-23",
3207
+ "total" : 117,
3208
+ "isViewdByClient" : false,
3209
+ "estimateNumber" : "INV-000025",
3210
+ "totalFormatted" : "AED117.00",
3211
+ "id" : "1332784000000108001",
3212
+ "dateFormatted" : "23 Sep 2018",
3213
+ "currencyCode" : "AED",
3214
+ "statusFormatted" : "Draft",
3215
+ "status" : "draft"
3216
+ } ],
3217
+ "deskModuleName" : "Contacts"
3218
+ }
3219
+ }
3220
+ }
3221
+ }
3222
+ },
3223
+ "x-custom-response-attributes" : {
3224
+ "disable-safe-headers" : "[]"
3225
+ }
3226
+ },
3227
+ "getSubscriptionsResponse" : {
3228
+ "description" : "getSubscriptionsResponse template definitions",
3229
+ "content" : {
3230
+ "application/json" : {
3231
+ "schema" : {
3232
+ "type" : [ "null", "object" ],
3233
+ "additionalProperties" : false,
3234
+ "properties" : {
3235
+ "deskEntityId" : {
3236
+ "type" : [ "string", "null", "integer" ],
3237
+ "format" : "int64",
3238
+ "pattern" : "([0-9]+)"
3239
+ },
3240
+ "data" : {
3241
+ "$ref" : "./Finance.json#/components/schemas/subscriptionsArray"
3242
+ },
3243
+ "deskModuleName" : {
3244
+ "type" : [ "string", "null" ],
3245
+ "enum" : [ "Cases", "Contacts", "Accounts" ],
3246
+ "maxLength" : 100,
3247
+ "minLength" : 0
3248
+ }
3249
+ },
3250
+ "required" : [ "data", "deskEntityId", "deskModuleName" ]
3251
+ },
3252
+ "examples" : {
3253
+ "Valid responses Definitions" : {
3254
+ "value" : {
3255
+ "data" : [ {
3256
+ "date" : "24-01-2019",
3257
+ "fromInventory" : {
3258
+ "items" : {
3259
+ "added" : 1,
3260
+ "updated" : 4,
3261
+ "skipped" : 0
3262
+ }
3263
+ }
3264
+ }, {
3265
+ "date" : "25-01-2019",
3266
+ "fromInventory" : {
3267
+ "items" : {
3268
+ "added" : 6,
3269
+ "updated" : 9,
3270
+ "skipped" : 0
3271
+ }
3272
+ }
3273
+ } ]
3274
+ }
3275
+ }
3276
+ }
3277
+ }
3278
+ },
3279
+ "x-custom-response-attributes" : {
3280
+ "disable-safe-headers" : "[]"
3281
+ }
3282
+ },
3283
+ "getSalesOrdersResponse" : {
3284
+ "description" : "getSalesOrdersResponse template definitions",
3285
+ "content" : {
3286
+ "application/json" : {
3287
+ "schema" : {
3288
+ "type" : [ "null", "object" ],
3289
+ "additionalProperties" : false,
3290
+ "properties" : {
3291
+ "deskEntityId" : {
3292
+ "type" : [ "string", "null", "integer" ],
3293
+ "format" : "int64",
3294
+ "pattern" : "([0-9]+)",
3295
+ "x-custom-parameters-attributes" : {
3296
+ "removeExif" : false,
3297
+ "replacementString" : "",
3298
+ "filterMatchedContent" : false,
3299
+ "antivirus" : false,
3300
+ "allowInvalid" : false,
3301
+ "descrption" : "To fetch salesorders by desk contact or account or ticket id",
3302
+ "secret" : false,
3303
+ "preserveCharsLimit" : 10,
3304
+ "trim" : false,
3305
+ "internalParam" : false,
3306
+ "preserveChars" : "0,5",
3307
+ "importUrl" : false,
3308
+ "decrypt" : false
3309
+ }
3310
+ },
3311
+ "data" : {
3312
+ "$ref" : "./Finance.json#/components/schemas/salesOrderArray"
3313
+ },
3314
+ "deskModuleName" : {
3315
+ "type" : [ "string", "null" ],
3316
+ "enum" : [ "Cases", "Contacts", "Accounts" ],
3317
+ "maxLength" : 100,
3318
+ "minLength" : 0,
3319
+ "x-custom-parameters-attributes" : {
3320
+ "removeExif" : false,
3321
+ "replacementString" : "",
3322
+ "filterMatchedContent" : false,
3323
+ "antivirus" : false,
3324
+ "allowInvalid" : false,
3325
+ "descrption" : "Desk Module Name. allowed modules are Contacts, Cases, Accounts",
3326
+ "secret" : false,
3327
+ "preserveCharsLimit" : 10,
3328
+ "trim" : false,
3329
+ "internalParam" : false,
3330
+ "preserveChars" : "0,5",
3331
+ "importUrl" : false,
3332
+ "decrypt" : false
3333
+ }
3334
+ }
3335
+ },
3336
+ "required" : [ "data", "deskEntityId", "deskModuleName" ]
3337
+ },
3338
+ "examples" : {
3339
+ "Valid responses Definitions" : {
3340
+ "value" : {
3341
+ "deskEntityId" : "5000000014010",
3342
+ "data" : [ {
3343
+ "date" : "2018-09-23",
3344
+ "total" : "117.00",
3345
+ "salesorder_number" : "SO-000025",
3346
+ "id" : "1332784000000108001",
3347
+ "status_formatted" : "Confirmed",
3348
+ "currency_code" : "AED",
3349
+ "status" : "confirmed"
3350
+ } ],
3351
+ "deskModuleName" : "Contacts"
3352
+ }
3353
+ }
3354
+ }
3355
+ }
3356
+ },
3357
+ "x-custom-response-attributes" : {
3358
+ "disable-safe-headers" : "[]"
3359
+ }
3360
+ },
3361
+ "getFinanceContact" : {
3362
+ "description" : "getFinanceContact template definitions",
3363
+ "content" : {
3364
+ "application/json" : {
3365
+ "schema" : {
3366
+ "type" : [ "null", "object" ],
3367
+ "additionalProperties" : false,
3368
+ "properties" : {
3369
+ "outstanding_receivable_amount" : {
3370
+ "type" : [ "string", "null" ],
3371
+ "maxLength" : 100,
3372
+ "minLength" : 0,
3373
+ "pattern" : "^[0-9]{0,19}$"
3374
+ },
3375
+ "deskEntityId" : {
3376
+ "type" : [ "string", "null", "integer" ],
3377
+ "format" : "int64",
3378
+ "pattern" : "([0-9]+)",
3379
+ "x-custom-parameters-attributes" : {
3380
+ "removeExif" : false,
3381
+ "replacementString" : "",
3382
+ "filterMatchedContent" : false,
3383
+ "antivirus" : false,
3384
+ "allowInvalid" : false,
3385
+ "descrption" : "EntityId in desk : desk contact or account id",
3386
+ "secret" : false,
3387
+ "preserveCharsLimit" : 10,
3388
+ "trim" : false,
3389
+ "internalParam" : false,
3390
+ "preserveChars" : "0,5",
3391
+ "importUrl" : false,
3392
+ "decrypt" : false
3393
+ }
3394
+ },
3395
+ "phone" : {
3396
+ "type" : [ "string", "null" ],
3397
+ "maxLength" : 100,
3398
+ "minLength" : 0
3399
+ },
3400
+ "contactName" : {
3401
+ "type" : [ "string", "null" ],
3402
+ "maxLength" : 100,
3403
+ "minLength" : 0
3404
+ },
3405
+ "currencySymbol" : {
3406
+ "type" : [ "string", "null" ],
3407
+ "maxLength" : 100,
3408
+ "minLength" : 0
3409
+ },
3410
+ "shippingAddress" : {
3411
+ "$ref" : "./Finance.json#/components/schemas/shippingAddress"
3412
+ },
3413
+ "deskModuleName" : {
3414
+ "type" : [ "string", "null" ],
3415
+ "enum" : [ "Cases", "Contacts", "Accounts" ],
3416
+ "maxLength" : 100,
3417
+ "minLength" : 0,
3418
+ "x-custom-parameters-attributes" : {
3419
+ "removeExif" : false,
3420
+ "replacementString" : "",
3421
+ "filterMatchedContent" : false,
3422
+ "antivirus" : false,
3423
+ "allowInvalid" : false,
3424
+ "descrption" : "Desk Module Name: Contacts or Cases or Accounts",
3425
+ "secret" : false,
3426
+ "preserveCharsLimit" : 10,
3427
+ "trim" : false,
3428
+ "internalParam" : false,
3429
+ "preserveChars" : "0,5",
3430
+ "importUrl" : false,
3431
+ "decrypt" : false
3432
+ }
3433
+ },
3434
+ "billingAddress" : {
3435
+ "$ref" : "./Finance.json#/components/schemas/billingAddress"
3436
+ },
3437
+ "unused_credits_receivable_amount" : {
3438
+ "type" : [ "string", "null" ],
3439
+ "maxLength" : 100,
3440
+ "minLength" : 0,
3441
+ "pattern" : "^[0-9]{0,19}$"
3442
+ },
3443
+ "currencyCode" : {
3444
+ "type" : [ "string", "null" ],
3445
+ "maxLength" : 100,
3446
+ "minLength" : 0
3447
+ },
3448
+ "email" : {
3449
+ "type" : [ "string", "null" ],
3450
+ "maxLength" : 100,
3451
+ "minLength" : 0,
3452
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
3453
+ }
3454
+ },
3455
+ "required" : [ "billingAddress", "contactName", "currencyCode", "currencySymbol", "deskEntityId", "deskModuleName", "email", "outstanding_receivable_amount", "phone", "shippingAddress", "unused_credits_receivable_amount" ]
3456
+ },
3457
+ "examples" : {
3458
+ "Valid responses Definitions" : {
3459
+ "value" : {
3460
+ "outstanding_receivable_amount" : 0,
3461
+ "deskEntityId" : "5000000014010",
3462
+ "phone" : "",
3463
+ "contactName" : "Smith",
3464
+ "currencySymbol" : "AED",
3465
+ "shippingAddress" : {
3466
+ "zip" : "",
3467
+ "country" : "",
3468
+ "address" : "",
3469
+ "city" : "",
3470
+ "phone" : "",
3471
+ "address_id" : "1332784000000112006",
3472
+ "attention" : "",
3473
+ "street2" : "",
3474
+ "state" : "",
3475
+ "state_code" : "",
3476
+ "fax" : ""
3477
+ },
3478
+ "deskModuleName" : "Contacts",
3479
+ "billingAddress" : {
3480
+ "zip" : "",
3481
+ "country" : "",
3482
+ "address" : "",
3483
+ "city" : "",
3484
+ "phone" : "",
3485
+ "address_id" : "1332784000000112004",
3486
+ "attention" : "",
3487
+ "street2" : "",
3488
+ "state" : "",
3489
+ "state_code" : "",
3490
+ "fax" : ""
3491
+ },
3492
+ "unused_credits_receivable_amount" : 0,
3493
+ "currencyCode" : "AED",
3494
+ "email" : "Smith@zylker.com"
3495
+ }
3496
+ }
3497
+ }
3498
+ }
3499
+ },
3500
+ "x-custom-response-attributes" : {
3501
+ "disable-safe-headers" : "[]"
3502
+ }
3503
+ },
3504
+ "getActivity" : {
3505
+ "description" : "getActivity template definitions",
3506
+ "content" : {
3507
+ "application/json" : {
3508
+ "schema" : {
3509
+ "type" : [ "null", "object" ],
3510
+ "additionalProperties" : false,
3511
+ "properties" : {
3512
+ "data" : {
3513
+ "$ref" : "./Finance.json#/components/schemas/dataArr6"
3514
+ }
3515
+ },
3516
+ "required" : [ "data" ]
3517
+ },
3518
+ "examples" : {
3519
+ "Valid responses Definitions" : {
3520
+ "value" : {
3521
+ "data" : [ {
3522
+ "description" : "Invoice INV-000026 of amount AED100.00 created by Jerome Eronimos in Zoho Desk",
3523
+ "operationType" : "added",
3524
+ "id" : "1332784000000113007",
3525
+ "time" : "9:54 PM",
3526
+ "dateDescription" : "few seconds ago"
3527
+ }, {
3528
+ "description" : "Contact created from Zoho Desk",
3529
+ "operationType" : "added",
3530
+ "id" : "1332784000000112013",
3531
+ "time" : "9:53 PM",
3532
+ "dateDescription" : "few seconds ago"
3533
+ } ]
3534
+ }
3535
+ }
3536
+ }
3537
+ }
3538
+ },
3539
+ "x-custom-response-attributes" : {
3540
+ "disable-safe-headers" : "[]"
3541
+ }
3542
+ },
3543
+ "listOrganizations" : {
3544
+ "description" : "listOrganizations template definitions",
3545
+ "content" : {
3546
+ "application/json" : {
3547
+ "schema" : {
3548
+ "type" : [ "null", "object" ],
3549
+ "additionalProperties" : false,
3550
+ "properties" : {
3551
+ "data" : {
3552
+ "$ref" : "./Finance.json#/components/schemas/dataArr3"
3553
+ }
3554
+ },
3555
+ "required" : [ "data" ]
3556
+ },
3557
+ "examples" : {
3558
+ "Valid responses Definitions" : {
3559
+ "value" : {
3560
+ "data" : [ {
3561
+ "organizationName" : "Zylker",
3562
+ "planName" : "free",
3563
+ "id" : "9787823873",
3564
+ "currency_code" : "USD"
3565
+ }, {
3566
+ "organizationName" : "Zylk",
3567
+ "planName" : "free",
3568
+ "id" : "378833883",
3569
+ "currency_code" : "INR"
3570
+ } ]
3571
+ }
3572
+ }
3573
+ }
3574
+ }
3575
+ },
3576
+ "x-custom-response-attributes" : {
3577
+ "disable-safe-headers" : "[]"
3578
+ }
3579
+ },
3580
+ "getFinanceApps" : {
3581
+ "description" : "getFinanceApps template definitions",
3582
+ "content" : {
3583
+ "application/json" : {
3584
+ "schema" : {
3585
+ "type" : [ "null", "object" ],
3586
+ "additionalProperties" : false,
3587
+ "properties" : {
3588
+ "data" : {
3589
+ "$ref" : "./Finance.json#/components/schemas/dataArr1"
3590
+ }
3591
+ },
3592
+ "required" : [ "data" ]
3593
+ },
3594
+ "examples" : {
3595
+ "Valid responses Definitions" : {
3596
+ "value" : {
3597
+ "data" : [ {
3598
+ "name" : "books",
3599
+ "label" : "New",
3600
+ "isActive" : true,
3601
+ "status" : "New"
3602
+ }, {
3603
+ "name" : "invoice",
3604
+ "label" : "Enabled",
3605
+ "isActive" : false,
3606
+ "status" : "New"
3607
+ } ]
3608
+ }
3609
+ }
3610
+ }
3611
+ }
3612
+ },
3613
+ "x-custom-response-attributes" : {
3614
+ "disable-safe-headers" : "[]"
3615
+ }
3616
+ },
3617
+ "searchContacts" : {
3618
+ "description" : "searchContacts template definitions",
3619
+ "content" : {
3620
+ "application/json" : {
3621
+ "schema" : {
3622
+ "type" : [ "null", "object" ],
3623
+ "additionalProperties" : false,
3624
+ "properties" : {
3625
+ "matchedBy" : {
3626
+ "type" : [ "string", "null" ],
3627
+ "maxLength" : 100,
3628
+ "minLength" : 0
3629
+ },
3630
+ "contacts" : {
3631
+ "$ref" : "./Finance.json#/components/schemas/contactsArr"
3632
+ }
3633
+ },
3634
+ "required" : [ "contacts", "matchedBy" ]
3635
+ },
3636
+ "examples" : {
3637
+ "Valid responses Definitions" : {
3638
+ "value" : null
3639
+ }
3640
+ }
3641
+ }
3642
+ },
3643
+ "x-custom-response-attributes" : {
3644
+ "disable-safe-headers" : "[]"
3645
+ }
3646
+ },
3647
+ "financeModulesArray" : {
3648
+ "description" : "financeModulesArray template definitions",
3649
+ "content" : {
3650
+ "application/json" : {
3651
+ "schema" : {
3652
+ "type" : [ "null", "array" ],
3653
+ "items" : {
3654
+ "$ref" : "./Finance.json#/components/schemas/financeModulesJson"
3655
+ }
3656
+ },
3657
+ "examples" : {
3658
+ "Valid responses Definitions" : {
3659
+ "value" : {
3660
+ "data" : [ {
3661
+ "singular_label" : "Quote",
3662
+ "plural_label" : "Quotes",
3663
+ "api_name" : "estimate"
3664
+ } ]
3665
+ }
3666
+ }
3667
+ }
3668
+ }
3669
+ },
3670
+ "x-custom-response-attributes" : {
3671
+ "disable-safe-headers" : "[]"
3672
+ }
3673
+ },
3674
+ "getSalesReturnsResponse" : {
3675
+ "description" : "getSalesReturnsResponse template definitions",
3676
+ "content" : {
3677
+ "application/json" : {
3678
+ "schema" : {
3679
+ "type" : [ "null", "object" ],
3680
+ "additionalProperties" : false,
3681
+ "properties" : {
3682
+ "data" : {
3683
+ "$ref" : "./Finance.json#/components/schemas/salesreturnsArray"
3684
+ }
3685
+ },
3686
+ "required" : [ "data" ]
3687
+ },
3688
+ "examples" : {
3689
+ "Valid responses Definitions" : {
3690
+ "value" : {
3691
+ "data" : [ {
3692
+ "date" : "2019-04-21",
3693
+ "total" : "2,888.89",
3694
+ "salesreturn_number" : "RMA-00001",
3695
+ "id" : "40563000000121003",
3696
+ "status_formatted" : "Approved",
3697
+ "status" : "approved"
3698
+ }, {
3699
+ "date" : "2019-04-21",
3700
+ "total" : "888.89",
3701
+ "salesreturn_number" : "RMA-00002",
3702
+ "id" : "405630000003710021",
3703
+ "status_formatted" : "Approved",
3704
+ "status" : "approved"
3705
+ } ]
3706
+ }
3707
+ }
3708
+ }
3709
+ }
3710
+ },
3711
+ "x-custom-response-attributes" : {
3712
+ "disable-safe-headers" : "[]"
3713
+ }
3714
+ },
3715
+ "getPreferences" : {
3716
+ "description" : "getPreferences template definitions",
3717
+ "content" : {
3718
+ "application/json" : {
3719
+ "schema" : {
3720
+ "type" : [ "null", "object" ],
3721
+ "additionalProperties" : false,
3722
+ "properties" : {
3723
+ "entryPreference" : {
3724
+ "type" : [ "string", "null" ],
3725
+ "maxLength" : 100,
3726
+ "minLength" : 0
3727
+ },
3728
+ "sortPreference" : {
3729
+ "type" : [ "string", "null" ],
3730
+ "maxLength" : 100,
3731
+ "minLength" : 0
3732
+ },
3733
+ "itemDescriptions" : {
3734
+ "type" : [ "null", "array" ],
3735
+ "items" : {
3736
+ "type" : [ "string", "null" ],
3737
+ "x-dynamic-enum" : true
3738
+ },
3739
+ "uniqueItems" : false
3740
+ },
3741
+ "itemNames" : {
3742
+ "type" : [ "null", "array" ],
3743
+ "items" : {
3744
+ "type" : [ "string", "null" ],
3745
+ "x-dynamic-enum" : true
3746
+ },
3747
+ "uniqueItems" : false
3748
+ }
3749
+ },
3750
+ "required" : [ "entryPreference", "itemDescriptions", "itemNames", "sortPreference" ]
3751
+ },
3752
+ "examples" : {
3753
+ "Valid responses Definitions" : {
3754
+ "value" : {
3755
+ "entryPreference" : "1",
3756
+ "sortPreference" : "2",
3757
+ "itemDescriptions" : [ "agentName", "executedTime", "duration", "additionalCost", "caseorTaskSubject", "description" ],
3758
+ "itemNames" : [ "caseNumber", "caseorTaskSubject" ]
3759
+ }
3760
+ }
3761
+ }
3762
+ }
3763
+ },
3764
+ "x-custom-response-attributes" : {
3765
+ "disable-safe-headers" : "[]"
3766
+ }
3767
+ },
3768
+ "getTicketsForInvoiceId" : {
3769
+ "description" : "getTicketsForInvoiceId template definitions",
3770
+ "content" : {
3771
+ "application/json" : {
3772
+ "schema" : {
3773
+ "type" : [ "null", "object" ],
3774
+ "additionalProperties" : false,
3775
+ "properties" : {
3776
+ "data" : {
3777
+ "$ref" : "./Finance.json#/components/schemas/dataArr"
3778
+ }
3779
+ },
3780
+ "required" : [ "data" ]
3781
+ },
3782
+ "examples" : {
3783
+ "Valid responses Definitions" : {
3784
+ "value" : {
3785
+ "data" : [ {
3786
+ "ticketNumber" : "123",
3787
+ "subject" : "Hi. There is a sudden delay in the processing of the orders. Check this with high priority",
3788
+ "dueDate" : "2018-06-21T16:16:16.000Z",
3789
+ "id" : "104202000003153007",
3790
+ "assignee" : {
3791
+ "firstName" : "Robert",
3792
+ "lastName" : "John"
3793
+ },
3794
+ "priority" : "High",
3795
+ "status" : "Open",
3796
+ "commentCount" : "5"
3797
+ }, {
3798
+ "ticketNumber" : "456",
3799
+ "subject" : "Problem while reset password.",
3800
+ "dueDate" : "2018-07-21T16:16:16.000Z",
3801
+ "id" : "104202000003153015",
3802
+ "assignee" : {
3803
+ "firstName" : "Steve",
3804
+ "lastName" : "Smith"
3805
+ },
3806
+ "priority" : "High",
3807
+ "status" : "Closed",
3808
+ "commentCount" : "3"
3809
+ } ]
3810
+ }
3811
+ }
3812
+ }
3813
+ }
3814
+ },
3815
+ "x-custom-response-attributes" : {
3816
+ "disable-safe-headers" : "[]"
3817
+ }
3818
+ },
3819
+ "productsSyncConfigResponse" : {
3820
+ "description" : "productsSyncConfigResponse template definitions",
3821
+ "content" : {
3822
+ "application/json" : {
3823
+ "schema" : {
3824
+ "type" : [ "null", "object" ],
3825
+ "additionalProperties" : false,
3826
+ "properties" : {
3827
+ "products" : {
3828
+ "$ref" : "./Finance.json#/components/schemas/syncConfigurationSingleEntityResponse"
3829
+ }
3830
+ },
3831
+ "required" : [ "products" ]
3832
+ },
3833
+ "examples" : {
3834
+ "Valid responses Definitions" : {
3835
+ "value" : {
3836
+ "products" : {
3837
+ "fieldMapping" : [ {
3838
+ "deskField" : "Product Name",
3839
+ "inventoryField" : "Item Name"
3840
+ } ],
3841
+ "syncState" : "on",
3842
+ "departmentIds" : [ "6000000007239", "6000000029263" ],
3843
+ "syncType" : "oneway"
3844
+ }
3845
+ }
3846
+ }
3847
+ }
3848
+ }
3849
+ },
3850
+ "x-custom-response-attributes" : {
3851
+ "disable-safe-headers" : "[]"
3852
+ }
3853
+ },
3854
+ "syncHistoryResponse" : {
3855
+ "description" : "syncHistoryResponse template definitions",
3856
+ "content" : {
3857
+ "application/json" : {
3858
+ "schema" : {
3859
+ "type" : [ "null", "object" ],
3860
+ "additionalProperties" : false,
3861
+ "properties" : {
3862
+ "data" : {
3863
+ "$ref" : "./Finance.json#/components/schemas/syncJSONArray"
3864
+ }
3865
+ },
3866
+ "required" : [ "data" ]
3867
+ },
3868
+ "examples" : {
3869
+ "Valid responses Definitions" : {
3870
+ "value" : {
3871
+ "data" : [ {
3872
+ "date" : "24-01-2019",
3873
+ "fromInventory" : {
3874
+ "items" : {
3875
+ "added" : 1,
3876
+ "updated" : 4,
3877
+ "skipped" : 0
3878
+ }
3879
+ }
3880
+ }, {
3881
+ "date" : "25-01-2019",
3882
+ "fromInventory" : {
3883
+ "items" : {
3884
+ "added" : 6,
3885
+ "updated" : 9,
3886
+ "skipped" : 0
3887
+ }
3888
+ }
3889
+ } ]
3890
+ }
3891
+ }
3892
+ }
3893
+ }
3894
+ },
3895
+ "x-custom-response-attributes" : {
3896
+ "disable-safe-headers" : "[]"
3897
+ }
3898
+ }
3899
+ },
3900
+ "parameters" : {
3901
+ "deskEntityId" : {
3902
+ "name" : "deskEntityId",
3903
+ "in" : "query",
3904
+ "description" : "To fetch invoice by desk contact or account or ticket id",
3905
+ "required" : true,
3906
+ "style" : "form",
3907
+ "explode" : true,
3908
+ "schema" : {
3909
+ "type" : [ "string", "null", "integer" ],
3910
+ "format" : "int64",
3911
+ "description" : "To fetch invoice by desk contact or account or ticket id",
3912
+ "pattern" : "([0-9]+)"
3913
+ }
3914
+ },
3915
+ "pageNumber" : {
3916
+ "name" : "pageNumber",
3917
+ "in" : "query",
3918
+ "description" : "page number",
3919
+ "required" : false,
3920
+ "style" : "form",
3921
+ "explode" : true,
3922
+ "schema" : {
3923
+ "type" : [ "string", "null", "integer" ],
3924
+ "format" : "int32",
3925
+ "description" : "page number",
3926
+ "pattern" : "([0-9]+)"
3927
+ }
3928
+ },
3929
+ "deskModuleName" : {
3930
+ "name" : "deskModuleName",
3931
+ "in" : "query",
3932
+ "description" : "Desk Module Name: Contacts or Cases or Accounts",
3933
+ "required" : true,
3934
+ "style" : "form",
3935
+ "explode" : true,
3936
+ "schema" : {
3937
+ "type" : [ "string", "null" ],
3938
+ "description" : "Desk Module Name: Contacts or Cases or Accounts",
3939
+ "enum" : [ "Cases", "Contacts", "Accounts" ],
3940
+ "maxLength" : 100,
3941
+ "minLength" : 0
3942
+ }
3943
+ },
3944
+ "financeService" : {
3945
+ "name" : "financeService",
3946
+ "in" : "path",
3947
+ "required" : true,
3948
+ "style" : "simple",
3949
+ "explode" : false,
3950
+ "schema" : {
3951
+ "type" : [ "string", "null" ],
3952
+ "enum" : [ "books", "inventory", "invoice" ],
3953
+ "maxLength" : 100,
3954
+ "minLength" : 0,
3955
+ "pattern" : "([a-z]+)"
3956
+ }
3957
+ },
3958
+ "id" : {
3959
+ "name" : "id",
3960
+ "in" : "path",
3961
+ "required" : true,
3962
+ "style" : "simple",
3963
+ "explode" : false,
3964
+ "schema" : {
3965
+ "type" : [ "string", "null", "integer" ],
3966
+ "format" : "int64",
3967
+ "pattern" : "([0-9]+)"
3968
+ }
3969
+ },
3970
+ "status" : {
3971
+ "name" : "status",
3972
+ "in" : "query",
3973
+ "description" : "To fetch invoice by status, Available status are sent, draft, overdue, paid, void, unpaid, partially_paid and viewed",
3974
+ "required" : false,
3975
+ "style" : "form",
3976
+ "explode" : true,
3977
+ "schema" : {
3978
+ "type" : [ "string", "null" ],
3979
+ "description" : "To fetch invoice by status, Available status are sent, draft, overdue, paid, void, unpaid, partially_paid and viewed",
3980
+ "enum" : [ "sent", "draft", "overdue", "paid", "void", "partially_paid" ],
3981
+ "maxLength" : 100,
3982
+ "minLength" : 0
3983
+ }
3984
+ }
3985
+ },
3986
+ "requestBodies" : {
3987
+ "financeUpdateStatus" : {
3988
+ "content" : {
3989
+ "application/json" : {
3990
+ "schema" : {
3991
+ "type" : [ "null", "object" ],
3992
+ "additionalProperties" : false,
3993
+ "properties" : {
3994
+ "status" : {
3995
+ "type" : [ "string", "null" ],
3996
+ "enum" : [ "sent" ],
3997
+ "maxLength" : 100,
3998
+ "minLength" : 0
3999
+ }
4000
+ },
4001
+ "required" : [ "status" ]
4002
+ },
4003
+ "examples" : {
4004
+ "Valid requestBody Definitions" : {
4005
+ "value" : {
4006
+ "status" : "draft"
4007
+ }
4008
+ }
4009
+ }
4010
+ }
4011
+ },
4012
+ "x-custom-request-body-attributes" : {
4013
+ "non-empty" : false,
4014
+ "allow-invalid" : false
4015
+ }
4016
+ },
4017
+ "linkFinanceEntity" : {
4018
+ "content" : {
4019
+ "application/json" : {
4020
+ "schema" : {
4021
+ "type" : [ "null", "object" ],
4022
+ "additionalProperties" : false,
4023
+ "properties" : {
4024
+ "deskEntityId" : {
4025
+ "type" : [ "string", "null", "integer" ],
4026
+ "format" : "int64",
4027
+ "pattern" : "([0-9]+)"
4028
+ },
4029
+ "deskModuleName" : {
4030
+ "type" : [ "string", "null" ],
4031
+ "enum" : [ "Cases", "Contacts", "Accounts" ],
4032
+ "maxLength" : 100,
4033
+ "minLength" : 0
4034
+ }
4035
+ },
4036
+ "required" : [ "deskEntityId", "deskModuleName" ]
4037
+ },
4038
+ "examples" : {
4039
+ "Valid requestBody Definitions" : {
4040
+ "value" : null
4041
+ }
4042
+ }
4043
+ }
4044
+ },
4045
+ "x-custom-request-body-attributes" : {
4046
+ "non-empty" : false,
4047
+ "allow-invalid" : false
4048
+ }
4049
+ },
4050
+ "updateInvoiceStatus_financeUpdateStatus" : {
4051
+ "content" : {
4052
+ "application/json" : {
4053
+ "schema" : {
4054
+ "type" : [ "null", "object" ],
4055
+ "additionalProperties" : false,
4056
+ "properties" : {
4057
+ "status" : {
4058
+ "type" : [ "string", "null" ],
4059
+ "enum" : [ "sent" ],
4060
+ "maxLength" : 100,
4061
+ "minLength" : 0
4062
+ }
4063
+ },
4064
+ "required" : [ "status" ]
4065
+ },
4066
+ "examples" : {
4067
+ "Valid requestBody Definitions" : {
4068
+ "value" : {
4069
+ "status" : "draft"
4070
+ }
4071
+ }
4072
+ }
4073
+ }
4074
+ },
4075
+ "x-custom-request-body-attributes" : {
4076
+ "non-empty" : false,
4077
+ "allow-invalid" : false
4078
+ }
4079
+ },
4080
+ "financeMarkAsSent" : {
4081
+ "content" : {
4082
+ "application/json" : {
4083
+ "schema" : {
4084
+ "type" : [ "null", "object" ],
4085
+ "additionalProperties" : false,
4086
+ "properties" : {
4087
+ "ids" : {
4088
+ "type" : [ "null", "array" ],
4089
+ "items" : {
4090
+ "type" : [ "string", "null", "integer" ],
4091
+ "format" : "int64",
4092
+ "pattern" : "([0-9]+)"
4093
+ },
4094
+ "uniqueItems" : false
4095
+ }
4096
+ }
4097
+ },
4098
+ "examples" : {
4099
+ "Valid requestBody Definitions" : {
4100
+ "value" : {
4101
+ "ids" : [ "1332784000000108020", "1332784000000108033", "1332784000000108044" ]
4102
+ }
4103
+ }
4104
+ }
4105
+ }
4106
+ },
4107
+ "x-custom-request-body-attributes" : {
4108
+ "non-empty" : false,
4109
+ "allow-invalid" : false
4110
+ }
4111
+ },
4112
+ "markInvoicesAsSent_financeMarkAsSent" : {
4113
+ "content" : {
4114
+ "application/json" : {
4115
+ "schema" : {
4116
+ "type" : [ "null", "object" ],
4117
+ "additionalProperties" : false,
4118
+ "properties" : {
4119
+ "ids" : {
4120
+ "type" : [ "null", "array" ],
4121
+ "items" : {
4122
+ "type" : [ "string", "null", "integer" ],
4123
+ "format" : "int64",
4124
+ "pattern" : "([0-9]+)"
4125
+ },
4126
+ "uniqueItems" : false
4127
+ }
4128
+ }
4129
+ },
4130
+ "examples" : {
4131
+ "Valid requestBody Definitions" : {
4132
+ "value" : {
4133
+ "ids" : [ "1332784000000108001", "1332784000000108004", "1332784000000108006" ]
4134
+ }
4135
+ }
4136
+ }
4137
+ }
4138
+ },
4139
+ "x-custom-request-body-attributes" : {
4140
+ "non-empty" : false,
4141
+ "allow-invalid" : false
4142
+ }
4143
+ },
4144
+ "createFinanceContact" : {
4145
+ "content" : {
4146
+ "application/json" : {
4147
+ "schema" : {
4148
+ "type" : [ "null", "object" ],
4149
+ "additionalProperties" : false,
4150
+ "properties" : {
4151
+ "deskEntityId" : {
4152
+ "type" : [ "string", "null", "integer" ],
4153
+ "format" : "int64",
4154
+ "pattern" : "([0-9]+)"
4155
+ },
4156
+ "phone" : {
4157
+ "type" : [ "string", "null" ],
4158
+ "maxLength" : 100,
4159
+ "minLength" : 0
4160
+ },
4161
+ "name" : {
4162
+ "type" : [ "string", "null" ],
4163
+ "maxLength" : 100,
4164
+ "minLength" : 0
4165
+ },
4166
+ "deskModuleName" : {
4167
+ "type" : [ "string", "null" ],
4168
+ "enum" : [ "Cases", "Contacts", "Accounts" ],
4169
+ "maxLength" : 100,
4170
+ "minLength" : 0
4171
+ },
4172
+ "contactPerson" : {
4173
+ "$ref" : "./Finance.json#/components/schemas/createFinanceContactPerson"
4174
+ },
4175
+ "currencyId" : {
4176
+ "type" : [ "string", "null" ],
4177
+ "maxLength" : 100,
4178
+ "minLength" : 0
4179
+ },
4180
+ "paymentTerm" : {
4181
+ "type" : [ "string", "null", "integer" ],
4182
+ "format" : "int64",
4183
+ "pattern" : "([0-9]+)"
4184
+ },
4185
+ "email" : {
4186
+ "type" : [ "string", "null" ],
4187
+ "maxLength" : 100,
4188
+ "minLength" : 0,
4189
+ "pattern" : "^[a-zA-Z0-9\\_]([a-zA-Z0-9\\_\\+\\-\\.\\'&]*)@(?=.{4,256}$)(([a-zA-Z0-9]+)(([\\-\\_]*[a-zA-Z0-9])*)[\\.])+[a-zA-Z]{2,22}$"
4190
+ },
4191
+ "financeContactId" : {
4192
+ "type" : [ "string", "null", "integer" ],
4193
+ "format" : "int64",
4194
+ "pattern" : "([0-9]+)"
4195
+ }
4196
+ },
4197
+ "required" : [ "currencyId", "deskEntityId", "deskModuleName", "email", "name", "paymentTerm" ]
4198
+ },
4199
+ "examples" : {
4200
+ "Valid requestBody Definitions" : {
4201
+ "value" : null
4202
+ }
4203
+ }
4204
+ }
4205
+ },
4206
+ "x-custom-request-body-attributes" : {
4207
+ "non-empty" : false,
4208
+ "allow-invalid" : false
4209
+ }
4210
+ },
4211
+ "addFinanceOrganization" : {
4212
+ "content" : {
4213
+ "application/json" : {
4214
+ "schema" : {
4215
+ "type" : [ "null", "object" ],
4216
+ "additionalProperties" : false,
4217
+ "properties" : {
4218
+ "organizationId" : {
4219
+ "type" : [ "string", "null", "integer" ],
4220
+ "format" : "int64",
4221
+ "pattern" : "([0-9]+)"
4222
+ },
4223
+ "baseCurrency" : {
4224
+ "type" : [ "string", "null" ],
4225
+ "maxLength" : 100,
4226
+ "minLength" : 0
4227
+ }
4228
+ },
4229
+ "required" : [ "baseCurrency", "organizationId" ]
4230
+ },
4231
+ "examples" : {
4232
+ "Valid requestBody Definitions" : {
4233
+ "value" : {
4234
+ "organizationId" : "9238492829",
4235
+ "baseCurrency" : "USD"
4236
+ }
4237
+ }
4238
+ }
4239
+ }
4240
+ },
4241
+ "x-custom-request-body-attributes" : {
4242
+ "non-empty" : false,
4243
+ "allow-invalid" : false
4244
+ }
4245
+ },
4246
+ "updateFinanceIntegration" : {
4247
+ "content" : {
4248
+ "application/json" : {
4249
+ "schema" : {
4250
+ "type" : [ "null", "object" ],
4251
+ "additionalProperties" : false,
4252
+ "properties" : {
4253
+ "isActive" : {
4254
+ "type" : [ "boolean", "null" ]
4255
+ }
4256
+ },
4257
+ "required" : [ "isActive" ]
4258
+ },
4259
+ "examples" : {
4260
+ "Valid requestBody Definitions" : {
4261
+ "value" : {
4262
+ "isActive" : true
4263
+ }
4264
+ }
4265
+ }
4266
+ }
4267
+ },
4268
+ "x-custom-request-body-attributes" : {
4269
+ "non-empty" : false,
4270
+ "allow-invalid" : false
4271
+ }
4272
+ }
4273
+ },
4274
+ "securitySchemes" : {
4275
+ "cookie-auth" : {
4276
+ "$ref" : "../common/Common.json#/components/securitySchemes/cookie-auth"
4277
+ },
4278
+ "org-oauth" : {
4279
+ "$ref" : "../common/Common.json#/components/securitySchemes/org-oauth"
4280
+ },
4281
+ "jwt-oauth" : {
4282
+ "$ref" : "../common/Common.json#/components/securitySchemes/jwt-oauth"
4283
+ },
4284
+ "iam-oauth2-schema" : {
4285
+ "$ref" : "../common/Common.json#/components/securitySchemes/iam-oauth2-schema"
4286
+ }
4287
+ }
4288
+ },
4289
+ "x-entity" : "Finance"
4290
+ }