bukku-client 0.1.0-test.0

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 (231) hide show
  1. package/LICENSE +674 -0
  2. package/README.md +85 -0
  3. package/dist/accounting/accounts/index.d.ts +52 -0
  4. package/dist/accounting/accounts/index.d.ts.map +1 -0
  5. package/dist/accounting/accounts/index.js +72 -0
  6. package/dist/accounting/accounts/index.js.map +1 -0
  7. package/dist/accounting/accounts/type.d.ts +125 -0
  8. package/dist/accounting/accounts/type.d.ts.map +1 -0
  9. package/dist/accounting/accounts/type.js +4 -0
  10. package/dist/accounting/accounts/type.js.map +1 -0
  11. package/dist/accounting/index.d.ts +10 -0
  12. package/dist/accounting/index.d.ts.map +1 -0
  13. package/dist/accounting/index.js +16 -0
  14. package/dist/accounting/index.js.map +1 -0
  15. package/dist/accounting/journal-entries/index.d.ts +52 -0
  16. package/dist/accounting/journal-entries/index.d.ts.map +1 -0
  17. package/dist/accounting/journal-entries/index.js +72 -0
  18. package/dist/accounting/journal-entries/index.js.map +1 -0
  19. package/dist/accounting/journal-entries/type.d.ts +151 -0
  20. package/dist/accounting/journal-entries/type.d.ts.map +1 -0
  21. package/dist/accounting/journal-entries/type.js +4 -0
  22. package/dist/accounting/journal-entries/type.js.map +1 -0
  23. package/dist/common/type.d.ts +105 -0
  24. package/dist/common/type.d.ts.map +1 -0
  25. package/dist/common/type.js +3 -0
  26. package/dist/common/type.js.map +1 -0
  27. package/dist/contacts/contacts/index.d.ts +57 -0
  28. package/dist/contacts/contacts/index.d.ts.map +1 -0
  29. package/dist/contacts/contacts/index.js +82 -0
  30. package/dist/contacts/contacts/index.js.map +1 -0
  31. package/dist/contacts/contacts/type.d.ts +286 -0
  32. package/dist/contacts/contacts/type.d.ts.map +1 -0
  33. package/dist/contacts/contacts/type.js +4 -0
  34. package/dist/contacts/contacts/type.js.map +1 -0
  35. package/dist/contacts/groups/index.d.ts +42 -0
  36. package/dist/contacts/groups/index.d.ts.map +1 -0
  37. package/dist/contacts/groups/index.js +59 -0
  38. package/dist/contacts/groups/index.js.map +1 -0
  39. package/dist/contacts/groups/type.d.ts +34 -0
  40. package/dist/contacts/groups/type.d.ts.map +1 -0
  41. package/dist/contacts/groups/type.js +4 -0
  42. package/dist/contacts/groups/type.js.map +1 -0
  43. package/dist/contacts/index.d.ts +10 -0
  44. package/dist/contacts/index.d.ts.map +1 -0
  45. package/dist/contacts/index.js +15 -0
  46. package/dist/contacts/index.js.map +1 -0
  47. package/dist/control-panel/index.d.ts +15 -0
  48. package/dist/control-panel/index.d.ts.map +1 -0
  49. package/dist/control-panel/index.js +35 -0
  50. package/dist/control-panel/index.js.map +1 -0
  51. package/dist/control-panel/locations/index.d.ts +51 -0
  52. package/dist/control-panel/locations/index.d.ts.map +1 -0
  53. package/dist/control-panel/locations/index.js +70 -0
  54. package/dist/control-panel/locations/index.js.map +1 -0
  55. package/dist/control-panel/locations/type.d.ts +91 -0
  56. package/dist/control-panel/locations/type.d.ts.map +1 -0
  57. package/dist/control-panel/locations/type.js +4 -0
  58. package/dist/control-panel/locations/type.js.map +1 -0
  59. package/dist/control-panel/tag-groups/index.d.ts +44 -0
  60. package/dist/control-panel/tag-groups/index.d.ts.map +1 -0
  61. package/dist/control-panel/tag-groups/index.js +63 -0
  62. package/dist/control-panel/tag-groups/index.js.map +1 -0
  63. package/dist/control-panel/tag-groups/type.d.ts +64 -0
  64. package/dist/control-panel/tag-groups/type.d.ts.map +1 -0
  65. package/dist/control-panel/tag-groups/type.js +4 -0
  66. package/dist/control-panel/tag-groups/type.js.map +1 -0
  67. package/dist/control-panel/tags/index.d.ts +43 -0
  68. package/dist/control-panel/tags/index.d.ts.map +1 -0
  69. package/dist/control-panel/tags/index.js +60 -0
  70. package/dist/control-panel/tags/index.js.map +1 -0
  71. package/dist/control-panel/tags/type.d.ts +60 -0
  72. package/dist/control-panel/tags/type.d.ts.map +1 -0
  73. package/dist/control-panel/tags/type.js +4 -0
  74. package/dist/control-panel/tags/type.js.map +1 -0
  75. package/dist/files/index.d.ts +29 -0
  76. package/dist/files/index.d.ts.map +1 -0
  77. package/dist/files/index.js +42 -0
  78. package/dist/files/index.js.map +1 -0
  79. package/dist/files/type.d.ts +50 -0
  80. package/dist/files/type.d.ts.map +1 -0
  81. package/dist/files/type.js +4 -0
  82. package/dist/files/type.js.map +1 -0
  83. package/dist/index.d.ts +73 -0
  84. package/dist/index.d.ts.map +1 -0
  85. package/dist/index.js +130 -0
  86. package/dist/index.js.map +1 -0
  87. package/dist/lists/index.d.ts +24 -0
  88. package/dist/lists/index.d.ts.map +1 -0
  89. package/dist/lists/index.js +33 -0
  90. package/dist/lists/index.js.map +1 -0
  91. package/dist/lists/type.d.ts +781 -0
  92. package/dist/lists/type.d.ts.map +1 -0
  93. package/dist/lists/type.js +3 -0
  94. package/dist/lists/type.js.map +1 -0
  95. package/dist/products/groups/index.d.ts +42 -0
  96. package/dist/products/groups/index.d.ts.map +1 -0
  97. package/dist/products/groups/index.js +59 -0
  98. package/dist/products/groups/index.js.map +1 -0
  99. package/dist/products/groups/type.d.ts +53 -0
  100. package/dist/products/groups/type.d.ts.map +1 -0
  101. package/dist/products/groups/type.js +5 -0
  102. package/dist/products/groups/type.js.map +1 -0
  103. package/dist/products/index.d.ts +10 -0
  104. package/dist/products/index.d.ts.map +1 -0
  105. package/dist/products/index.js +15 -0
  106. package/dist/products/index.js.map +1 -0
  107. package/dist/products/products/index.d.ts +51 -0
  108. package/dist/products/products/index.d.ts.map +1 -0
  109. package/dist/products/products/index.js +70 -0
  110. package/dist/products/products/index.js.map +1 -0
  111. package/dist/products/products/type.d.ts +270 -0
  112. package/dist/products/products/type.d.ts.map +1 -0
  113. package/dist/products/products/type.js +4 -0
  114. package/dist/products/products/type.js.map +1 -0
  115. package/dist/purchases/bills/index.d.ts +51 -0
  116. package/dist/purchases/bills/index.d.ts.map +1 -0
  117. package/dist/purchases/bills/index.js +75 -0
  118. package/dist/purchases/bills/index.js.map +1 -0
  119. package/dist/purchases/bills/type.d.ts +254 -0
  120. package/dist/purchases/bills/type.d.ts.map +1 -0
  121. package/dist/purchases/bills/type.js +4 -0
  122. package/dist/purchases/bills/type.js.map +1 -0
  123. package/dist/purchases/credit-notes/index.d.ts +51 -0
  124. package/dist/purchases/credit-notes/index.d.ts.map +1 -0
  125. package/dist/purchases/credit-notes/index.js +71 -0
  126. package/dist/purchases/credit-notes/index.js.map +1 -0
  127. package/dist/purchases/credit-notes/type.d.ts +204 -0
  128. package/dist/purchases/credit-notes/type.d.ts.map +1 -0
  129. package/dist/purchases/credit-notes/type.js +4 -0
  130. package/dist/purchases/credit-notes/type.js.map +1 -0
  131. package/dist/purchases/goods-received-notes/index.d.ts +51 -0
  132. package/dist/purchases/goods-received-notes/index.d.ts.map +1 -0
  133. package/dist/purchases/goods-received-notes/index.js +71 -0
  134. package/dist/purchases/goods-received-notes/index.js.map +1 -0
  135. package/dist/purchases/goods-received-notes/type.d.ts +184 -0
  136. package/dist/purchases/goods-received-notes/type.d.ts.map +1 -0
  137. package/dist/purchases/goods-received-notes/type.js +4 -0
  138. package/dist/purchases/goods-received-notes/type.js.map +1 -0
  139. package/dist/purchases/index.d.ts +18 -0
  140. package/dist/purchases/index.d.ts.map +1 -0
  141. package/dist/purchases/index.js +23 -0
  142. package/dist/purchases/index.js.map +1 -0
  143. package/dist/purchases/payments/index.d.ts +51 -0
  144. package/dist/purchases/payments/index.d.ts.map +1 -0
  145. package/dist/purchases/payments/index.js +71 -0
  146. package/dist/purchases/payments/index.js.map +1 -0
  147. package/dist/purchases/payments/type.d.ts +183 -0
  148. package/dist/purchases/payments/type.d.ts.map +1 -0
  149. package/dist/purchases/payments/type.js +4 -0
  150. package/dist/purchases/payments/type.js.map +1 -0
  151. package/dist/purchases/purchase-orders/index.d.ts +51 -0
  152. package/dist/purchases/purchase-orders/index.d.ts.map +1 -0
  153. package/dist/purchases/purchase-orders/index.js +71 -0
  154. package/dist/purchases/purchase-orders/index.js.map +1 -0
  155. package/dist/purchases/purchase-orders/type.d.ts +182 -0
  156. package/dist/purchases/purchase-orders/type.d.ts.map +1 -0
  157. package/dist/purchases/purchase-orders/type.js +4 -0
  158. package/dist/purchases/purchase-orders/type.js.map +1 -0
  159. package/dist/purchases/refunds/index.d.ts +51 -0
  160. package/dist/purchases/refunds/index.d.ts.map +1 -0
  161. package/dist/purchases/refunds/index.js +71 -0
  162. package/dist/purchases/refunds/index.js.map +1 -0
  163. package/dist/purchases/refunds/type.d.ts +181 -0
  164. package/dist/purchases/refunds/type.d.ts.map +1 -0
  165. package/dist/purchases/refunds/type.js +4 -0
  166. package/dist/purchases/refunds/type.js.map +1 -0
  167. package/dist/sales/credit-notes/index.d.ts +52 -0
  168. package/dist/sales/credit-notes/index.d.ts.map +1 -0
  169. package/dist/sales/credit-notes/index.js +72 -0
  170. package/dist/sales/credit-notes/index.js.map +1 -0
  171. package/dist/sales/credit-notes/type.d.ts +304 -0
  172. package/dist/sales/credit-notes/type.d.ts.map +1 -0
  173. package/dist/sales/credit-notes/type.js +4 -0
  174. package/dist/sales/credit-notes/type.js.map +1 -0
  175. package/dist/sales/delivery-orders/index.d.ts +51 -0
  176. package/dist/sales/delivery-orders/index.d.ts.map +1 -0
  177. package/dist/sales/delivery-orders/index.js +72 -0
  178. package/dist/sales/delivery-orders/index.js.map +1 -0
  179. package/dist/sales/delivery-orders/type.d.ts +212 -0
  180. package/dist/sales/delivery-orders/type.d.ts.map +1 -0
  181. package/dist/sales/delivery-orders/type.js +4 -0
  182. package/dist/sales/delivery-orders/type.js.map +1 -0
  183. package/dist/sales/index.d.ts +20 -0
  184. package/dist/sales/index.d.ts.map +1 -0
  185. package/dist/sales/index.js +24 -0
  186. package/dist/sales/index.js.map +1 -0
  187. package/dist/sales/invoices/index.d.ts +52 -0
  188. package/dist/sales/invoices/index.d.ts.map +1 -0
  189. package/dist/sales/invoices/index.js +73 -0
  190. package/dist/sales/invoices/index.js.map +1 -0
  191. package/dist/sales/invoices/type.d.ts +335 -0
  192. package/dist/sales/invoices/type.d.ts.map +1 -0
  193. package/dist/sales/invoices/type.js +4 -0
  194. package/dist/sales/invoices/type.js.map +1 -0
  195. package/dist/sales/payments/index.d.ts +52 -0
  196. package/dist/sales/payments/index.d.ts.map +1 -0
  197. package/dist/sales/payments/index.js +72 -0
  198. package/dist/sales/payments/index.js.map +1 -0
  199. package/dist/sales/payments/type.d.ts +242 -0
  200. package/dist/sales/payments/type.d.ts.map +1 -0
  201. package/dist/sales/payments/type.js +4 -0
  202. package/dist/sales/payments/type.js.map +1 -0
  203. package/dist/sales/quotations/index.d.ts +51 -0
  204. package/dist/sales/quotations/index.d.ts.map +1 -0
  205. package/dist/sales/quotations/index.js +71 -0
  206. package/dist/sales/quotations/index.js.map +1 -0
  207. package/dist/sales/quotations/type.d.ts +202 -0
  208. package/dist/sales/quotations/type.d.ts.map +1 -0
  209. package/dist/sales/quotations/type.js +3 -0
  210. package/dist/sales/quotations/type.js.map +1 -0
  211. package/dist/sales/refunds/index.d.ts +52 -0
  212. package/dist/sales/refunds/index.d.ts.map +1 -0
  213. package/dist/sales/refunds/index.js +72 -0
  214. package/dist/sales/refunds/index.js.map +1 -0
  215. package/dist/sales/refunds/type.d.ts +225 -0
  216. package/dist/sales/refunds/type.d.ts.map +1 -0
  217. package/dist/sales/refunds/type.js +4 -0
  218. package/dist/sales/refunds/type.js.map +1 -0
  219. package/dist/sales/sales-orders/index.d.ts +52 -0
  220. package/dist/sales/sales-orders/index.d.ts.map +1 -0
  221. package/dist/sales/sales-orders/index.js +72 -0
  222. package/dist/sales/sales-orders/index.js.map +1 -0
  223. package/dist/sales/sales-orders/type.d.ts +202 -0
  224. package/dist/sales/sales-orders/type.d.ts.map +1 -0
  225. package/dist/sales/sales-orders/type.js +4 -0
  226. package/dist/sales/sales-orders/type.js.map +1 -0
  227. package/dist/types.d.ts +17 -0
  228. package/dist/types.d.ts.map +1 -0
  229. package/dist/types.js +4 -0
  230. package/dist/types.js.map +1 -0
  231. package/package.json +44 -0
@@ -0,0 +1,781 @@
1
+ /**
2
+ * Represents a contact address item as returned by the API.
3
+ */
4
+ export interface ContactAddressItem {
5
+ id: number;
6
+ name: string;
7
+ address: string;
8
+ }
9
+ /**
10
+ * Represents a company address item as returned by the API.
11
+ */
12
+ export interface CompanyAddressItem {
13
+ id: number;
14
+ name: string;
15
+ address: string;
16
+ is_default_billing: boolean;
17
+ is_default_shipping: boolean;
18
+ }
19
+ /**
20
+ * Represents a contact group item as returned by the API.
21
+ */
22
+ export interface ContactGroupItem {
23
+ id: number;
24
+ name: string;
25
+ customers: number;
26
+ suppliers: number;
27
+ employees: number;
28
+ }
29
+ /**
30
+ * Represents a classification code item as returned by the API.
31
+ */
32
+ export interface ClassificationCodeItem {
33
+ code: string;
34
+ description: string;
35
+ }
36
+ /**
37
+ * Represents a unit item within a product as returned by the API.
38
+ */
39
+ export interface ProductUnitItem {
40
+ id: number;
41
+ label: string;
42
+ rate: number;
43
+ sale_price: number;
44
+ purchase_price: number;
45
+ is_base: boolean;
46
+ is_sale_default: boolean;
47
+ is_purchase_default: boolean;
48
+ }
49
+ /**
50
+ * Represents a product item as returned by the API.
51
+ */
52
+ export interface ProductItem {
53
+ id: number;
54
+ thumbnail_url: string | null;
55
+ sku: string | null;
56
+ name: string;
57
+ track_inventory: boolean;
58
+ inventory_account_id: number | null;
59
+ quantity: number | null;
60
+ is_selling: boolean;
61
+ sale_description: string | null;
62
+ sale_account_id: number | null;
63
+ sale_tax_code_id: number | null;
64
+ is_buying: boolean;
65
+ purchase_description: string | null;
66
+ purchase_account_id: number | null;
67
+ purchase_tax_code_id: number | null;
68
+ units: ProductUnitItem[];
69
+ type: "product" | "bundle" | string;
70
+ is_archived: boolean;
71
+ }
72
+ /**
73
+ * Represents a unit item within a product_list item as returned by the API.
74
+ */
75
+ export interface ProductListUnitItem {
76
+ id: number;
77
+ label: string;
78
+ rate: number;
79
+ is_base: boolean;
80
+ }
81
+ /**
82
+ * Represents a product_list item as returned by the API.
83
+ */
84
+ export interface ProductListItem {
85
+ id: number;
86
+ thumbnail_url: string | null;
87
+ sku: string | null;
88
+ name: string;
89
+ track_inventory: boolean;
90
+ inventory_account_id: number | null;
91
+ quantity: number | null;
92
+ is_selling: boolean;
93
+ is_buying: boolean;
94
+ units: ProductListUnitItem[];
95
+ type: "product" | "bundle" | "service" | string;
96
+ group_names: string[];
97
+ is_archived: boolean;
98
+ }
99
+ /**
100
+ * Represents a child item within a product (bundle) as returned by the API.
101
+ */
102
+ export interface ProductChildItem {
103
+ id: number;
104
+ name: string;
105
+ description: string | null;
106
+ unit_id: number;
107
+ quantity: number;
108
+ unit_price: number;
109
+ prices: any[];
110
+ account_id: number;
111
+ track_inventory: boolean;
112
+ inventory_account_id: number;
113
+ tax_code_id: number;
114
+ }
115
+ /**
116
+ * Represents a detailed product item (often a bundle with children)
117
+ * as returned by the API under the 'product.item' path.
118
+ */
119
+ export interface ProductDetailItem {
120
+ id: number;
121
+ type: "bundle" | string;
122
+ name: string;
123
+ description: string | null;
124
+ children: ProductChildItem[];
125
+ }
126
+ /**
127
+ * Specific structure for the "product" (singular) list response.
128
+ */
129
+ export interface ProductDetailResponseData {
130
+ item: ProductDetailItem[];
131
+ }
132
+ /**
133
+ * Represents a product group item as returned by the API.
134
+ */
135
+ export interface ProductGroupItem {
136
+ id: number;
137
+ name: string;
138
+ }
139
+ /**
140
+ * Represents the currency details within an account item.
141
+ */
142
+ export interface AccountCurrency {
143
+ code: string;
144
+ symbol: string;
145
+ }
146
+ /**
147
+ * Represents an account item as returned by the API.
148
+ * This interface is recursive to handle nested child accounts.
149
+ */
150
+ export interface AccountItem {
151
+ id: number;
152
+ code: string;
153
+ name: string;
154
+ currency_code: string;
155
+ currency: AccountCurrency;
156
+ balance: number;
157
+ type: string;
158
+ parent_id: number | null;
159
+ system_type: string | null;
160
+ is_locked: boolean;
161
+ is_archived: boolean;
162
+ children: AccountItem[] | null;
163
+ }
164
+ /**
165
+ * Represents a payment method item as returned by the API.
166
+ */
167
+ export interface PaymentMethodItem {
168
+ id: number;
169
+ name: string;
170
+ slug: string;
171
+ is_archived: boolean;
172
+ account_id: number | null;
173
+ }
174
+ /**
175
+ * Represents a price level item as returned by the API.
176
+ */
177
+ export interface PriceLevelItem {
178
+ id: number;
179
+ name: string;
180
+ is_archived: boolean;
181
+ }
182
+ /**
183
+ * Represents an individual tag within a tag group.
184
+ */
185
+ export interface TagItem {
186
+ id: number;
187
+ name: string;
188
+ is_archived: boolean;
189
+ }
190
+ /**
191
+ * Represents a tag group item with its nested tags,
192
+ * as returned by the API under the 'tag_groups.item' path.
193
+ */
194
+ export interface TagGroupDetailItem {
195
+ id: number;
196
+ name: string;
197
+ tags: TagItem[];
198
+ is_archived: boolean;
199
+ }
200
+ /**
201
+ * Specific structure for the "tag_groups" list response.
202
+ */
203
+ export interface TagGroupsResponseData {
204
+ item: TagGroupDetailItem[];
205
+ }
206
+ /**
207
+ * Represents an asset type item as returned by the API.
208
+ */
209
+ export interface AssetTypeItem {
210
+ id: number;
211
+ name: string;
212
+ asset_account_id: number;
213
+ depreciation_account_id: number;
214
+ expense_account_id: number;
215
+ default_depreciation_method: string;
216
+ default_depreciation_convention: string;
217
+ default_depreciate_mode: string;
218
+ default_depreciation_rate: number;
219
+ default_useful_years: number;
220
+ default_useful_months: number;
221
+ assets_count: number;
222
+ created_at: string;
223
+ updated_at: string;
224
+ }
225
+ /**
226
+ * Represents an individual field item (for contact or transaction).
227
+ */
228
+ export interface FieldItem {
229
+ id: number;
230
+ name: string;
231
+ type: "CONTACT" | "TRANSACTION" | string;
232
+ data_type: "TEXT" | string;
233
+ data_options: any | null;
234
+ is_required: boolean;
235
+ sale_quote_show: boolean;
236
+ sale_order_show: boolean;
237
+ sale_delivery_order_show: boolean;
238
+ sale_invoice_show: boolean;
239
+ sale_credit_note_show: boolean;
240
+ sale_payment_show: boolean;
241
+ sale_refund_show: boolean;
242
+ purchase_order_show: boolean;
243
+ purchase_goods_received_note_show: boolean;
244
+ purchase_bill_show: boolean;
245
+ purchase_credit_note_show: boolean;
246
+ purchase_payment_show: boolean;
247
+ purchase_refund_show: boolean;
248
+ created_at: string;
249
+ updated_at: string;
250
+ }
251
+ /**
252
+ * Specific structure for the "fields" list response.
253
+ * The items are grouped by field type (e.g., "contact", "transaction").
254
+ */
255
+ export interface FieldsResponseData {
256
+ version: string;
257
+ items: {
258
+ contact?: FieldItem[];
259
+ transaction?: FieldItem[];
260
+ [key: string]: FieldItem[] | undefined;
261
+ };
262
+ }
263
+ /**
264
+ * Represents a numbering item as returned by the API.
265
+ */
266
+ export interface NumberingItem {
267
+ id: number;
268
+ type: string;
269
+ format: string;
270
+ is_default: boolean;
271
+ created_at: string;
272
+ updated_at: string;
273
+ }
274
+ /**
275
+ * Represents a form design item as returned by the API.
276
+ */
277
+ export interface FormDesignItem {
278
+ id: number;
279
+ name: string;
280
+ template: string;
281
+ }
282
+ /**
283
+ * Represents a location item as returned by the API.
284
+ */
285
+ export interface LocationItem {
286
+ id: number;
287
+ code?: string;
288
+ name?: string;
289
+ type?: string;
290
+ format?: string;
291
+ is_archived?: boolean;
292
+ is_default?: boolean;
293
+ created_at: string;
294
+ updated_at: string;
295
+ }
296
+ /**
297
+ * Represents a location item within the stock_balances list.
298
+ */
299
+ export interface StockBalanceLocationItem {
300
+ id: number;
301
+ code?: string;
302
+ name?: string;
303
+ type?: string;
304
+ format?: string;
305
+ balance: number;
306
+ }
307
+ /**
308
+ * Specific structure for the "stock_balances" list response.
309
+ */
310
+ export interface StockBalancesResponseData {
311
+ product_id: number;
312
+ items: StockBalanceLocationItem[];
313
+ }
314
+ /**
315
+ * Represents a tax code item as returned by the API.
316
+ */
317
+ export interface TaxCodeItem {
318
+ id: number;
319
+ code: string;
320
+ rate: number;
321
+ tax_system: string;
322
+ type: "purchase" | "sale" | string;
323
+ is_archived: boolean;
324
+ is_exempted: boolean;
325
+ }
326
+ /**
327
+ * Specific structure for the "tax_codes" list response.
328
+ */
329
+ export interface TaxCodesResponseData {
330
+ items: TaxCodeItem[];
331
+ }
332
+ /**
333
+ * Represents the various settings items within the "settings" list response.
334
+ * This is a large object with many optional fields of varying types.
335
+ */
336
+ export interface SettingsItems {
337
+ account_list_version?: string;
338
+ api_access_on?: boolean;
339
+ api_access_token?: string;
340
+ asset_list_version?: string;
341
+ asset_number_format_id?: number;
342
+ bank_expense_email_message?: string | null;
343
+ bank_expense_form_design_id?: number;
344
+ bank_expense_number_format_id?: number;
345
+ bank_income_email_message?: string | null;
346
+ bank_income_form_design_id?: number;
347
+ bank_income_number_format_id?: number;
348
+ bank_transfer_form_design_id?: number;
349
+ bank_transfer_number_format_id?: number;
350
+ business_digest_frequency?: string;
351
+ business_digest_on?: boolean;
352
+ coming_due_email_message?: string | null;
353
+ coming_due_email_on?: boolean;
354
+ coming_due_email_schedule?: string;
355
+ company_addresses_list_version?: string;
356
+ contact_group_list_version?: string;
357
+ contact_list_version?: string;
358
+ contra_form_design_id?: number;
359
+ contra_number_format_id?: number;
360
+ contra_remarks?: string | null;
361
+ contra_signatures?: any | null;
362
+ credit_limit_passcode?: string | null;
363
+ credit_note_email_message?: string | null;
364
+ currency_list_version?: string;
365
+ custom_transaction_number_on?: boolean;
366
+ dashboard_bank_account_ids?: number[];
367
+ dashboard_cashflow_forecast_preset?: string;
368
+ dashboard_cashflow_trend_preset?: string;
369
+ dashboard_expense_breakdown_preset?: string;
370
+ dashboard_expense_hide_sub_accounts?: boolean;
371
+ dashboard_income_breakdown_preset?: string;
372
+ dashboard_income_hide_sub_accounts?: boolean;
373
+ dashboard_profit_loss_trend_preset?: string;
374
+ dashboard_sales_trend_preset?: string;
375
+ default_asset_capital_gain_account_id?: number | null;
376
+ default_asset_gain_account_id?: number | null;
377
+ default_asset_loss_account_id?: number | null;
378
+ default_bank_adjustment_account_id?: number;
379
+ default_bank_cash_account_id?: number;
380
+ default_cos_account_id?: number;
381
+ default_email_subject?: string;
382
+ default_expense_account_id?: number;
383
+ default_income_account_id?: number;
384
+ default_inventory_account_id?: number;
385
+ default_inventory_adjustment_account_id?: number;
386
+ default_location_id?: number;
387
+ default_payable_account_id?: number;
388
+ default_payment_method_id?: number | null;
389
+ default_product_unit_label?: string;
390
+ default_purchase_tax_code_id?: number;
391
+ default_receivable_account_id?: number;
392
+ default_rounding_on?: boolean;
393
+ default_sales_tax_code_id?: number;
394
+ default_tax_mode?: string;
395
+ default_term_id?: number;
396
+ default_transaction_fee_account_id?: number;
397
+ description_contra?: string | null;
398
+ description_expense?: string | null;
399
+ description_income?: string | null;
400
+ description_journal_entry?: string | null;
401
+ description_purchase_bill?: string | null;
402
+ description_purchase_credit_note?: string | null;
403
+ description_purchase_goods_received?: string | null;
404
+ description_purchase_order?: string | null;
405
+ description_purchase_payment?: string | null;
406
+ description_purchase_refund?: string | null;
407
+ description_sale_credit_note?: string | null;
408
+ description_sale_delivery_order?: string | null;
409
+ description_sale_invoice?: string | null;
410
+ description_sale_order?: string | null;
411
+ description_sale_payment?: string | null;
412
+ description_sale_quote?: string | null;
413
+ description_sale_refund?: string | null;
414
+ description_stock_adjustment?: string | null;
415
+ description_stock_transfer?: string | null;
416
+ description_tax_deemed_payment?: string | null;
417
+ description_transfer?: string | null;
418
+ e_invoice_attachment_on?: boolean;
419
+ e_invoice_cc_email_addresses?: string | null;
420
+ email_footer?: string | null;
421
+ field_list_version?: string;
422
+ financial_year_end_month?: number;
423
+ form_design_list_version?: string;
424
+ fs_facility_code?: string | null;
425
+ inventory_grni_date?: string | null;
426
+ inventory_grni_on?: boolean;
427
+ invoice_email_message?: string | null;
428
+ journal_entry_form_design_id?: number;
429
+ journal_entry_number_format_id?: number;
430
+ journal_entry_remarks?: string | null;
431
+ location_list_version?: string;
432
+ mysst_exempted_tax_code_show?: boolean;
433
+ mysst_sales_tax_id?: string;
434
+ mysst_sales_tax_on?: boolean;
435
+ mysst_service_tax_id?: string;
436
+ mysst_service_tax_on?: boolean;
437
+ numbering_list_version?: string;
438
+ official_receipt_remarks?: string | null;
439
+ order_email_message?: string | null;
440
+ overdue_email_message?: string | null;
441
+ overdue_email_on?: boolean;
442
+ overdue_email_schedule?: string;
443
+ payment_email_message?: string | null;
444
+ payment_gateway_deposit_account_id?: number;
445
+ payment_gateway_fee_account_id?: number | null;
446
+ payment_gateway_payment_method_id?: number;
447
+ payment_gateway_provider?: string;
448
+ payment_gateway_secret?: string;
449
+ payment_gateway_settlement_account_id?: number | null;
450
+ payment_gateway_switch?: boolean;
451
+ payment_gateway_track_fee?: boolean;
452
+ payment_gateway_track_settlement?: boolean;
453
+ payment_gateway_username?: string | null;
454
+ payment_method_list_version?: string;
455
+ payment_voucher_remarks?: string | null;
456
+ period_lock_date?: string | null;
457
+ period_lock_passcode?: string | null;
458
+ price_level_list_version?: string;
459
+ product_group_list_version?: string;
460
+ product_list_version?: string;
461
+ purchase_bill_form_design_id?: number;
462
+ purchase_bill_number_format_id?: number;
463
+ purchase_credit_note_form_design_id?: number;
464
+ purchase_credit_note_number_format_id?: number;
465
+ purchase_goods_received_note_email_message?: string | null;
466
+ purchase_goods_received_note_form_design_id?: number;
467
+ purchase_goods_received_note_number_format_id?: number;
468
+ purchase_goods_received_note_remarks?: string | null;
469
+ purchase_order_form_design_id?: number;
470
+ purchase_order_number_format_id?: number;
471
+ purchase_order_remarks?: string | null;
472
+ purchase_payment_email_message?: string | null;
473
+ purchase_payment_form_design_id?: number;
474
+ purchase_payment_number_format_id?: number;
475
+ purchase_refund_email_message?: string | null;
476
+ purchase_refund_form_design_id?: number;
477
+ purchase_refund_number_format_id?: number;
478
+ quote_email_message?: string | null;
479
+ refund_email_message?: string | null;
480
+ sale_credit_note_form_design_id?: number;
481
+ sale_credit_note_number_format_id?: number;
482
+ sale_credit_note_remarks?: string | null;
483
+ sale_delivery_note_remarks?: string | null;
484
+ sale_delivery_order_email_message?: string | null;
485
+ sale_delivery_order_form_design_id?: number;
486
+ sale_delivery_order_number_format_id?: number;
487
+ sale_delivery_order_remarks?: string;
488
+ sale_invoice_form_design_id?: number;
489
+ sale_invoice_number_format_id?: number;
490
+ sale_invoice_remarks?: string | null;
491
+ sale_order_email_message?: string | null;
492
+ sale_order_form_design_id?: number;
493
+ sale_order_number_format_id?: number;
494
+ sale_order_remarks?: string;
495
+ sale_payment_form_design_id?: number;
496
+ sale_payment_number_format_id?: number;
497
+ sale_quote_form_design_id?: number;
498
+ sale_quote_number_format_id?: number;
499
+ sale_quote_remarks?: string;
500
+ sale_refund_form_design_id?: number;
501
+ sale_refund_number_format_id?: number;
502
+ service_date_on?: boolean;
503
+ setting_list_version?: string;
504
+ signature_bank_transfer?: any | null;
505
+ signature_journal_entry?: number[];
506
+ signature_official_receipt?: number[];
507
+ signature_payment_voucher?: number[];
508
+ signature_purchase_bill?: number[];
509
+ signature_purchase_credit_note?: number[];
510
+ signature_purchase_goods_received_note?: number[];
511
+ signature_purchase_order?: number[];
512
+ signature_sale_credit_note?: number[];
513
+ signature_sale_delivery_note?: number[];
514
+ signature_sale_delivery_order?: number[];
515
+ signature_sale_invoice?: number[];
516
+ signature_sale_order?: number[];
517
+ signature_sale_quote?: number[];
518
+ signature1_bottom_label?: string;
519
+ signature1_file_id?: number;
520
+ signature1_file_url?: string;
521
+ signature1_is_override?: boolean;
522
+ signature1_top_label?: string | null;
523
+ signature2_bottom_label?: string;
524
+ signature2_file_id?: number;
525
+ signature2_file_url?: string;
526
+ signature2_is_override?: boolean;
527
+ signature2_top_label?: string | null;
528
+ signature3_bottom_label?: string;
529
+ signature3_file_id?: number;
530
+ signature3_file_url?: string;
531
+ signature3_is_override?: boolean;
532
+ signature3_top_label?: string | null;
533
+ signature4_bottom_label?: string;
534
+ signature4_file_id?: number;
535
+ signature4_file_url?: string;
536
+ signature4_is_override?: boolean;
537
+ signature4_top_label?: string | null;
538
+ signature5_bottom_label?: string;
539
+ signature5_file_id?: number;
540
+ signature5_file_url?: string;
541
+ signature5_is_override?: boolean;
542
+ signature5_top_label?: string | null;
543
+ signature6_bottom_label?: string;
544
+ signature6_file_id?: number;
545
+ signature6_file_url?: string;
546
+ signature6_is_override?: boolean;
547
+ signature6_top_label?: string | null;
548
+ statement_email_message?: string | null;
549
+ statement_email_reply_to?: string | null;
550
+ statement_email_subject?: string;
551
+ statement_form_design_id?: number;
552
+ statement_interest_show?: boolean;
553
+ statement_remarks?: string | null;
554
+ statement_send_day?: number;
555
+ statement_send_on?: boolean;
556
+ statement_send_outstanding_only?: boolean;
557
+ statement_send_period_from?: string;
558
+ statement_send_period_to?: string;
559
+ stock_adjustment_form_design_id?: number;
560
+ stock_adjustment_number_format_id?: number;
561
+ stock_transfer_form_design_id?: number;
562
+ stock_transfer_number_format_id?: number;
563
+ store_allow_negative_inventory?: boolean;
564
+ store_banner_file_id?: number | null;
565
+ store_contact_id?: number;
566
+ store_hide_out_of_stock_items?: boolean;
567
+ store_on?: boolean;
568
+ store_online_payment?: boolean;
569
+ store_order_number_format_id?: number;
570
+ store_order_received_notification_recipients?: string[];
571
+ store_payment_instructions?: string;
572
+ support_access?: boolean;
573
+ tag_list_version?: string;
574
+ tax_deemed_payment_number_format_id?: number;
575
+ term_list_version?: string;
576
+ transaction_email_master_on?: boolean;
577
+ transaction_email_reply_to?: string | null;
578
+ transaction_email_reply_to_user?: boolean;
579
+ [key: string]: any;
580
+ }
581
+ /**
582
+ * Represents the usage and limit for a specific feature (e.g., transaction, email).
583
+ */
584
+ export interface LimitDetail {
585
+ usage: number;
586
+ limit: number | boolean;
587
+ }
588
+ /**
589
+ * Represents a user item as returned by the API.
590
+ */
591
+ export interface UserItem {
592
+ id: number;
593
+ first_name: string;
594
+ last_name: string;
595
+ }
596
+ /**
597
+ * Specific structure for the "users" list response.
598
+ */
599
+ export interface UsersResponseData {
600
+ items: UserItem[];
601
+ }
602
+ /**
603
+ * Represents an advisor item as returned by the API.
604
+ */
605
+ export interface AdvisorItem {
606
+ id: number;
607
+ first_name: string;
608
+ email: string;
609
+ }
610
+ /**
611
+ * Specific structure for the "advisors" list response.
612
+ */
613
+ export interface AdvisorsResponseData {
614
+ items: AdvisorItem[];
615
+ }
616
+ /**
617
+ * Represents a state item as returned by the API for the "state_list".
618
+ */
619
+ export interface StateListItem {
620
+ state_code: string;
621
+ name: string;
622
+ }
623
+ /**
624
+ * Specific structure for the "state_list" response.
625
+ */
626
+ export interface StateListResponseData {
627
+ items: StateListItem[];
628
+ }
629
+ /**
630
+ * Represents a limit item as returned by the API for the "limits" list.
631
+ */
632
+ export interface LimitItem {
633
+ plan_type: string;
634
+ limit_period_type: string;
635
+ transaction: LimitDetail;
636
+ shoebox: LimitDetail;
637
+ email: LimitDetail;
638
+ storage: LimitDetail;
639
+ [key: string]: any;
640
+ }
641
+ /**
642
+ * Specific structure for the "limits" list response.
643
+ * It's a direct array of LimitItem.
644
+ */
645
+ export type LimitsResponseData = LimitItem[];
646
+ /**
647
+ * Specific structure for the "settings" list response.
648
+ */
649
+ export interface SettingsResponseData {
650
+ version: string;
651
+ items: SettingsItems;
652
+ }
653
+ /**
654
+ * Represents the types of lists that can be fetched.
655
+ * These correspond to the valid string values for the 'lists' array in the request body.
656
+ */
657
+ export type ListType = "countries" | "currencies" | "contacts" | "contact_addresses" | "company_addresses" | "contact_groups" | "classification_code_list" | "products" | "product_list" | "product" | "product_groups" | "accounts" | "terms" | "payment_methods" | "price_levels" | "tag_groups" | "asset_types" | "fields" | "numberings" | "form_designs" | "locations" | "stock_balances" | "tax_codes" | "settings" | "limits" | "users" | "advisors" | "state_list";
658
+ /**
659
+ * Request body for the Get Lists API (POST /v2/lists).
660
+ */
661
+ export interface GetListsRequestBody {
662
+ /** An array of specific list types to fetch. */
663
+ lists: ListType[];
664
+ /**
665
+ * Optional array of parameter objects.
666
+ * Contains data needed for specific sub-endpoints if required by any of the requested list types.
667
+ * The structure of objects within this array can vary.
668
+ */
669
+ params?: Record<string, any>[];
670
+ }
671
+ /**
672
+ * Represents a contact item as returned by the API.
673
+ */
674
+ export interface ContactItem {
675
+ id: number;
676
+ legal_name: string;
677
+ other_name: string | null;
678
+ reg_no: string | null;
679
+ billing_first_name: string | null;
680
+ billing_last_name: string | null;
681
+ shipping_first_name: string | null;
682
+ shipping_last_name: string | null;
683
+ types: string[];
684
+ email: string | null;
685
+ phone_no: string | null;
686
+ receivable_account_id: number | null;
687
+ payable_account_id: number | null;
688
+ billing_party: string | null;
689
+ shipping_party: string | null;
690
+ default_currency_code: string | null;
691
+ default_term_id: number | null;
692
+ default_income_account_id: number | null;
693
+ default_expense_account_id: number | null;
694
+ tag_ids: number[];
695
+ key: string | null;
696
+ is_archived: boolean;
697
+ field_1?: string;
698
+ field_8?: string;
699
+ }
700
+ /**
701
+ * Represents a country item as returned by the API.
702
+ */
703
+ export interface CountryItem {
704
+ code: string;
705
+ name: string;
706
+ }
707
+ /**
708
+ * Represents a term item as returned by the API.
709
+ */
710
+ export interface TermItem {
711
+ id: number;
712
+ name: string;
713
+ type: "in_days" | "day_of_month" | string;
714
+ value: number;
715
+ interest_on: boolean;
716
+ interest_rate: number | null;
717
+ is_archived: boolean;
718
+ }
719
+ /**
720
+ * Represents a currency item as returned by the API.
721
+ */
722
+ export interface CurrencyItem {
723
+ code: string;
724
+ symbol: string;
725
+ name: string;
726
+ }
727
+ /**
728
+ * Specific structure for the "currencies" list response.
729
+ */
730
+ export interface CurrenciesList {
731
+ version: string;
732
+ favourite_items: CurrencyItem[];
733
+ popular_items: CurrencyItem[];
734
+ other_items: CurrencyItem[];
735
+ }
736
+ /**
737
+ * Generic structure for the data associated with a list type in the response
738
+ * for lists that follow the simple "items" array pattern.
739
+ * @template T The type of items contained in the list.
740
+ */
741
+ export interface StandardListData<T> {
742
+ items: T[];
743
+ version?: string;
744
+ }
745
+ /**
746
+ * Represents the overall response structure for the Get Lists API.
747
+ * It's a dynamic object where keys are the requested list types.
748
+ */
749
+ export type GetListsResponse = {
750
+ countries?: StandardListData<CountryItem>;
751
+ terms?: StandardListData<TermItem>;
752
+ currencies?: CurrenciesList;
753
+ contacts?: StandardListData<ContactItem>;
754
+ contact_addresses?: StandardListData<ContactAddressItem>;
755
+ company_addresses?: StandardListData<CompanyAddressItem>;
756
+ contact_groups?: StandardListData<ContactGroupItem>;
757
+ classification_code_list?: StandardListData<ClassificationCodeItem>;
758
+ products?: StandardListData<ProductItem>;
759
+ product_list?: StandardListData<ProductListItem>;
760
+ product?: ProductDetailResponseData;
761
+ product_groups?: StandardListData<ProductGroupItem>;
762
+ accounts?: StandardListData<AccountItem>;
763
+ payment_methods?: StandardListData<PaymentMethodItem>;
764
+ price_levels?: StandardListData<PriceLevelItem>;
765
+ tag_groups?: TagGroupsResponseData;
766
+ asset_types?: StandardListData<AssetTypeItem>;
767
+ fields?: FieldsResponseData;
768
+ numberings?: StandardListData<NumberingItem>;
769
+ form_designs?: StandardListData<FormDesignItem>;
770
+ locations?: StandardListData<LocationItem>;
771
+ stock_balances?: StockBalancesResponseData;
772
+ tax_codes?: TaxCodesResponseData;
773
+ settings?: SettingsResponseData;
774
+ limits?: LimitsResponseData;
775
+ users?: UsersResponseData;
776
+ advisors?: AdvisorsResponseData;
777
+ state_list?: StateListResponseData;
778
+ } & {
779
+ [K in Exclude<ListType, "countries" | "terms" | "currencies" | "contacts" | "contact_addresses" | "company_addresses" | "contact_groups" | "classification_code_list" | "products" | "product_list" | "product" | "product_groups" | "accounts" | "payment_methods" | "price_levels" | "tag_groups" | "asset_types" | "fields" | "numberings" | "form_designs" | "locations" | "stock_balances" | "tax_codes" | "settings" | "limits" | "users" | "advisors" | "state_list">]?: StandardListData<Record<string, any>>;
780
+ };
781
+ //# sourceMappingURL=type.d.ts.map