qubesync 0.1.0 → 0.2.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 (258) hide show
  1. package/CHANGELOG.md +38 -2
  2. package/README.md +188 -5
  3. package/client.js +660 -0
  4. package/index.d.ts +211 -1
  5. package/index.js +5 -1
  6. package/index.mjs +2 -0
  7. package/operations/account.d.ts +263 -0
  8. package/operations/account.js +50 -0
  9. package/operations/account_tax_line_info.d.ts +31 -0
  10. package/operations/account_tax_line_info.js +26 -0
  11. package/operations/aging_report.d.ts +100 -0
  12. package/operations/aging_report.js +26 -0
  13. package/operations/alert.d.ts +118 -0
  14. package/operations/alert.js +50 -0
  15. package/operations/ar_refund_credit_card.d.ts +201 -0
  16. package/operations/ar_refund_credit_card.js +38 -0
  17. package/operations/bar_code.d.ts +40 -0
  18. package/operations/bar_code.js +26 -0
  19. package/operations/bill.d.ts +612 -0
  20. package/operations/bill.js +50 -0
  21. package/operations/bill_payment_check.d.ts +276 -0
  22. package/operations/bill_payment_check.js +50 -0
  23. package/operations/bill_payment_credit_card.d.ts +178 -0
  24. package/operations/bill_payment_credit_card.js +38 -0
  25. package/operations/bill_to_pay.d.ts +54 -0
  26. package/operations/bill_to_pay.js +26 -0
  27. package/operations/billing_rate.d.ts +159 -0
  28. package/operations/billing_rate.js +38 -0
  29. package/operations/budget_summary_report.d.ts +71 -0
  30. package/operations/budget_summary_report.js +26 -0
  31. package/operations/build_assembly.d.ts +264 -0
  32. package/operations/build_assembly.js +50 -0
  33. package/operations/charge.d.ts +330 -0
  34. package/operations/charge.js +50 -0
  35. package/operations/check.d.ts +394 -0
  36. package/operations/check.js +50 -0
  37. package/operations/class.d.ts +170 -0
  38. package/operations/class.js +50 -0
  39. package/operations/cleared_status.d.ts +43 -0
  40. package/operations/cleared_status.js +26 -0
  41. package/operations/client.d.ts +254 -0
  42. package/operations/company.d.ts +36 -0
  43. package/operations/company.js +26 -0
  44. package/operations/company_activity.d.ts +32 -0
  45. package/operations/company_activity.js +26 -0
  46. package/operations/credit_card_charge.d.ts +280 -0
  47. package/operations/credit_card_charge.js +50 -0
  48. package/operations/credit_card_credit.d.ts +280 -0
  49. package/operations/credit_card_credit.js +50 -0
  50. package/operations/credit_memo.d.ts +642 -0
  51. package/operations/credit_memo.js +50 -0
  52. package/operations/currency.d.ts +195 -0
  53. package/operations/currency.js +50 -0
  54. package/operations/custom_detail_report.d.ts +108 -0
  55. package/operations/custom_detail_report.js +26 -0
  56. package/operations/custom_summary_report.d.ts +119 -0
  57. package/operations/custom_summary_report.js +26 -0
  58. package/operations/customer.d.ts +639 -0
  59. package/operations/customer.js +50 -0
  60. package/operations/customer_msg.d.ts +121 -0
  61. package/operations/customer_msg.js +38 -0
  62. package/operations/customer_type.d.ts +127 -0
  63. package/operations/customer_type.js +38 -0
  64. package/operations/data_event_recovery_info.d.ts +61 -0
  65. package/operations/data_event_recovery_info.js +38 -0
  66. package/operations/data_ext.d.ts +197 -0
  67. package/operations/data_ext.js +50 -0
  68. package/operations/data_ext_def.d.ts +173 -0
  69. package/operations/data_ext_def.js +62 -0
  70. package/operations/date_driven_terms.d.ts +141 -0
  71. package/operations/date_driven_terms.js +38 -0
  72. package/operations/deposit.d.ts +402 -0
  73. package/operations/deposit.js +50 -0
  74. package/operations/employee.d.ts +683 -0
  75. package/operations/employee.js +50 -0
  76. package/operations/employee_default.d.ts +133 -0
  77. package/operations/employee_default.js +38 -0
  78. package/operations/entity.d.ts +96 -0
  79. package/operations/entity.js +26 -0
  80. package/operations/estimate.d.ts +590 -0
  81. package/operations/estimate.js +50 -0
  82. package/operations/form1099_category_account_mapping.d.ts +89 -0
  83. package/operations/form1099_category_account_mapping.js +38 -0
  84. package/operations/general_detail_report.d.ts +108 -0
  85. package/operations/general_detail_report.js +26 -0
  86. package/operations/general_summary_report.d.ts +115 -0
  87. package/operations/general_summary_report.js +26 -0
  88. package/operations/host.d.ts +43 -0
  89. package/operations/host.js +26 -0
  90. package/operations/index.js +397 -0
  91. package/operations/inventory_adjustment.d.ts +389 -0
  92. package/operations/inventory_adjustment.js +50 -0
  93. package/operations/inventory_site.d.ts +247 -0
  94. package/operations/inventory_site.js +50 -0
  95. package/operations/invoice.d.ts +682 -0
  96. package/operations/invoice.js +50 -0
  97. package/operations/item.d.ts +100 -0
  98. package/operations/item.js +26 -0
  99. package/operations/item_assemblies_can_build.d.ts +41 -0
  100. package/operations/item_assemblies_can_build.js +26 -0
  101. package/operations/item_discount.d.ts +256 -0
  102. package/operations/item_discount.js +50 -0
  103. package/operations/item_fixed_asset.d.ts +382 -0
  104. package/operations/item_fixed_asset.js +50 -0
  105. package/operations/item_group.d.ts +236 -0
  106. package/operations/item_group.js +50 -0
  107. package/operations/item_inventory.d.ts +350 -0
  108. package/operations/item_inventory.js +50 -0
  109. package/operations/item_inventory_assembly.d.ts +368 -0
  110. package/operations/item_inventory_assembly.js +50 -0
  111. package/operations/item_non_inventory.d.ts +264 -0
  112. package/operations/item_non_inventory.js +50 -0
  113. package/operations/item_other_charge.d.ts +244 -0
  114. package/operations/item_other_charge.js +50 -0
  115. package/operations/item_payment.d.ts +220 -0
  116. package/operations/item_payment.js +50 -0
  117. package/operations/item_receipt.d.ts +362 -0
  118. package/operations/item_receipt.js +50 -0
  119. package/operations/item_sales_tax.d.ts +228 -0
  120. package/operations/item_sales_tax.js +50 -0
  121. package/operations/item_sales_tax_group.d.ts +192 -0
  122. package/operations/item_sales_tax_group.js +50 -0
  123. package/operations/item_service.d.ts +256 -0
  124. package/operations/item_service.js +50 -0
  125. package/operations/item_sites.d.ts +81 -0
  126. package/operations/item_sites.js +26 -0
  127. package/operations/item_subtotal.d.ts +188 -0
  128. package/operations/item_subtotal.js +50 -0
  129. package/operations/job_report.d.ts +99 -0
  130. package/operations/job_report.js +26 -0
  131. package/operations/job_type.d.ts +127 -0
  132. package/operations/job_type.js +38 -0
  133. package/operations/journal_entry.d.ts +339 -0
  134. package/operations/journal_entry.js +50 -0
  135. package/operations/lead.d.ts +291 -0
  136. package/operations/lead.js +50 -0
  137. package/operations/list.d.ts +39 -0
  138. package/operations/list.js +26 -0
  139. package/operations/list_deleted.d.ts +44 -0
  140. package/operations/list_deleted.js +26 -0
  141. package/operations/list_display.d.ts +65 -0
  142. package/operations/list_display.js +38 -0
  143. package/operations/list_merge.d.ts +58 -0
  144. package/operations/list_merge.js +26 -0
  145. package/operations/other_name.d.ts +280 -0
  146. package/operations/other_name.js +50 -0
  147. package/operations/paycheck.d.ts +82 -0
  148. package/operations/paycheck.js +26 -0
  149. package/operations/payment_method.d.ts +131 -0
  150. package/operations/payment_method.js +38 -0
  151. package/operations/payroll_detail_report.d.ts +97 -0
  152. package/operations/payroll_detail_report.js +26 -0
  153. package/operations/payroll_item.d.ts +83 -0
  154. package/operations/payroll_item.js +26 -0
  155. package/operations/payroll_item_addition.d.ts +95 -0
  156. package/operations/payroll_item_addition.js +38 -0
  157. package/operations/payroll_item_company_contribution.d.ts +105 -0
  158. package/operations/payroll_item_company_contribution.js +38 -0
  159. package/operations/payroll_item_deduction.d.ts +101 -0
  160. package/operations/payroll_item_deduction.js +38 -0
  161. package/operations/payroll_item_direct_deposit.d.ts +65 -0
  162. package/operations/payroll_item_direct_deposit.js +38 -0
  163. package/operations/payroll_item_non_wage.d.ts +92 -0
  164. package/operations/payroll_item_non_wage.js +26 -0
  165. package/operations/payroll_item_tax.d.ts +108 -0
  166. package/operations/payroll_item_tax.js +38 -0
  167. package/operations/payroll_item_wage.d.ts +169 -0
  168. package/operations/payroll_item_wage.js +50 -0
  169. package/operations/payroll_item_workers_compensation.d.ts +77 -0
  170. package/operations/payroll_item_workers_compensation.js +38 -0
  171. package/operations/payroll_last_period.d.ts +31 -0
  172. package/operations/payroll_last_period.js +26 -0
  173. package/operations/payroll_liability_adjustment.d.ts +137 -0
  174. package/operations/payroll_liability_adjustment.js +38 -0
  175. package/operations/payroll_liability_check.d.ts +82 -0
  176. package/operations/payroll_liability_check.js +26 -0
  177. package/operations/payroll_prior_payment.d.ts +126 -0
  178. package/operations/payroll_prior_payment.js +38 -0
  179. package/operations/payroll_summary_report.d.ts +107 -0
  180. package/operations/payroll_summary_report.js +26 -0
  181. package/operations/payroll_year_to_date_adjustment.d.ts +156 -0
  182. package/operations/payroll_year_to_date_adjustment.js +38 -0
  183. package/operations/preferences.d.ts +64 -0
  184. package/operations/preferences.js +38 -0
  185. package/operations/price_level.d.ts +234 -0
  186. package/operations/price_level.js +50 -0
  187. package/operations/purchase_order.d.ts +620 -0
  188. package/operations/purchase_order.js +50 -0
  189. package/operations/qb_command_exec.d.ts +49 -0
  190. package/operations/qb_command_exec.js +26 -0
  191. package/operations/receive_payment.d.ts +450 -0
  192. package/operations/receive_payment.js +50 -0
  193. package/operations/receive_payment_to_deposit.d.ts +36 -0
  194. package/operations/receive_payment_to_deposit.js +26 -0
  195. package/operations/sales_order.d.ts +612 -0
  196. package/operations/sales_order.js +50 -0
  197. package/operations/sales_receipt.d.ts +650 -0
  198. package/operations/sales_receipt.js +50 -0
  199. package/operations/sales_rep.d.ts +170 -0
  200. package/operations/sales_rep.js +50 -0
  201. package/operations/sales_tax_code.d.ts +194 -0
  202. package/operations/sales_tax_code.js +50 -0
  203. package/operations/sales_tax_payable.d.ts +42 -0
  204. package/operations/sales_tax_payable.js +26 -0
  205. package/operations/sales_tax_payment_check.d.ts +254 -0
  206. package/operations/sales_tax_payment_check.js +50 -0
  207. package/operations/sales_tax_return.d.ts +35 -0
  208. package/operations/sales_tax_return.js +26 -0
  209. package/operations/sales_tax_return_line.d.ts +36 -0
  210. package/operations/sales_tax_return_line.js +26 -0
  211. package/operations/ship_method.d.ts +121 -0
  212. package/operations/ship_method.js +38 -0
  213. package/operations/special_account.d.ts +40 -0
  214. package/operations/special_account.js +26 -0
  215. package/operations/special_item.d.ts +44 -0
  216. package/operations/special_item.js +26 -0
  217. package/operations/standard_terms.d.ts +133 -0
  218. package/operations/standard_terms.js +38 -0
  219. package/operations/template.d.ts +36 -0
  220. package/operations/template.js +26 -0
  221. package/operations/terms.d.ts +90 -0
  222. package/operations/terms.js +26 -0
  223. package/operations/time_report.d.ts +84 -0
  224. package/operations/time_report.js +26 -0
  225. package/operations/time_tracking.d.ts +214 -0
  226. package/operations/time_tracking.js +50 -0
  227. package/operations/to_do.d.ts +254 -0
  228. package/operations/to_do.js +50 -0
  229. package/operations/transaction.d.ts +244 -0
  230. package/operations/transaction.js +26 -0
  231. package/operations/transfer.d.ts +178 -0
  232. package/operations/transfer.js +50 -0
  233. package/operations/transfer_inventory.d.ts +290 -0
  234. package/operations/transfer_inventory.js +50 -0
  235. package/operations/txn.d.ts +39 -0
  236. package/operations/txn.js +26 -0
  237. package/operations/txn_deleted.d.ts +44 -0
  238. package/operations/txn_deleted.js +26 -0
  239. package/operations/txn_display.d.ts +69 -0
  240. package/operations/txn_display.js +38 -0
  241. package/operations/txn_void.d.ts +39 -0
  242. package/operations/txn_void.js +26 -0
  243. package/operations/types.d.ts +1259 -0
  244. package/operations/unit_of_measure_set.d.ts +168 -0
  245. package/operations/unit_of_measure_set.js +38 -0
  246. package/operations/vehicle.d.ts +168 -0
  247. package/operations/vehicle.js +50 -0
  248. package/operations/vehicle_mileage.d.ts +147 -0
  249. package/operations/vehicle_mileage.js +38 -0
  250. package/operations/vendor.d.ts +541 -0
  251. package/operations/vendor.js +50 -0
  252. package/operations/vendor_credit.d.ts +365 -0
  253. package/operations/vendor_credit.js +50 -0
  254. package/operations/vendor_type.d.ts +127 -0
  255. package/operations/vendor_type.js +38 -0
  256. package/operations/workers_comp_code.d.ts +199 -0
  257. package/operations/workers_comp_code.js +50 -0
  258. package/package.json +14 -4
@@ -0,0 +1,1259 @@
1
+ // Generated from operations.json by scripts/generate-operations.js: don't edit.
2
+
3
+ /** A queued request, as the API answers it (snake_case keys). */
4
+ export type QueuedRequest = { [key: string]: any };
5
+
6
+ /** The options every operation method takes. */
7
+ export interface OperationOptions {
8
+ /** Where QuBe Sync POSTs the answered request. Required. */
9
+ webhookUrl: string;
10
+ /** Default: a fresh UUID per call, reused on that call's retries. */
11
+ idempotencyKey?: string;
12
+ }
13
+
14
+ /**
15
+ * Give exactly one of: `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
16
+ */
17
+ export interface AccountFilter {
18
+ /**
19
+ * `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
20
+ */
21
+ full_name?: string[];
22
+ /**
23
+ * Allows you to filter for data that relates to the specified object and its descendants. For names that don’t have children, `full_name_with_children` is exactly the same as `full_name`.
24
+ */
25
+ full_name_with_children?: string;
26
+ /**
27
+ * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
28
+ */
29
+ list_id?: string[];
30
+ /**
31
+ * Allows you to filter for data that relates to the specified object and its descendants.
32
+ */
33
+ list_id_with_children?: string;
34
+ }
35
+
36
+ /**
37
+ * Give exactly one of: `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
38
+ */
39
+ export interface AccountFilterPaycheck {
40
+ full_name?: string[];
41
+ full_name_with_children?: string;
42
+ list_id?: string[];
43
+ list_id_with_children?: string;
44
+ }
45
+
46
+ export interface AdditionalContactRef {
47
+ /**
48
+ * The name of the contact.
49
+ */
50
+ contact_name: string;
51
+ /**
52
+ * The value of the contact field.
53
+ */
54
+ contact_value: string;
55
+ }
56
+
57
+ export interface Address {
58
+ /**
59
+ * The first line of an address.
60
+ */
61
+ addr1?: string;
62
+ /**
63
+ * The second line of an address (if a second line is needed).
64
+ */
65
+ addr2?: string;
66
+ /**
67
+ * The third line of an address (if a third line is needed).
68
+ */
69
+ addr3?: string;
70
+ /**
71
+ * The fourth line of an address (if a fourth line is needed).
72
+ */
73
+ addr4?: string;
74
+ /**
75
+ * The fifth line of an address (if a fifth line is needed).
76
+ */
77
+ addr5?: string;
78
+ /**
79
+ * The city name in an address.
80
+ */
81
+ city?: string;
82
+ /**
83
+ * The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.)
84
+ */
85
+ country?: string;
86
+ /**
87
+ * In a BillAddress or ShipAddress aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form.
88
+ */
89
+ note?: string;
90
+ /**
91
+ * The postal code in an address.
92
+ */
93
+ postal_code?: string;
94
+ /**
95
+ * The state name in an address.
96
+ */
97
+ state?: string;
98
+ }
99
+
100
+ export interface AppliedToTxnAdd {
101
+ /**
102
+ * Refers to the account where this discount is tracked. In a request, if a `discount_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
103
+ */
104
+ discount_account_ref?: CurrencyRef;
105
+ /**
106
+ * Reduces the receivable amount.
107
+ */
108
+ discount_amount?: number;
109
+ /**
110
+ * Class reference used in the Discount object
111
+ */
112
+ discount_class_ref?: CurrencyRef;
113
+ /**
114
+ * Represents the amount assigned to a particular receivable. The sum of all `payment_amount` elements in any given receive payment transaction must not be greater than TotalAmount.
115
+ */
116
+ payment_amount?: number;
117
+ set_credit?: SetCredit[];
118
+ /**
119
+ * `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
120
+ */
121
+ txn_id: string;
122
+ txn_line_detail?: TxnLineDetail[];
123
+ }
124
+
125
+ export interface BarCodeItemDiscount {
126
+ /**
127
+ * Allows for barcode to be overridden for an item.
128
+ */
129
+ allow_override?: boolean;
130
+ /**
131
+ * Allow barcode to be assigned to item, even if already in use.
132
+ */
133
+ assign_even_if_used?: boolean;
134
+ /**
135
+ * Value of the barcode in the item.
136
+ */
137
+ bar_code_value?: string;
138
+ }
139
+
140
+ export interface BillAddress {
141
+ /**
142
+ * The first line of an address.
143
+ */
144
+ addr1?: string;
145
+ /**
146
+ * The second line of an address (if a second line is needed).
147
+ */
148
+ addr2?: string;
149
+ /**
150
+ * The third line of an address (if a third line is needed).
151
+ */
152
+ addr3?: string;
153
+ /**
154
+ * The fourth line of an address (if a fourth line is needed).
155
+ */
156
+ addr4?: string;
157
+ /**
158
+ * The fifth line of an address (if a fifth line is needed).
159
+ */
160
+ addr5?: string;
161
+ /**
162
+ * The city name in an address.
163
+ */
164
+ city?: string;
165
+ /**
166
+ * The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.)
167
+ */
168
+ country?: string;
169
+ /**
170
+ * In a `bill_address` or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form.
171
+ */
172
+ note?: string;
173
+ /**
174
+ * The postal code in an address.
175
+ */
176
+ postal_code?: string;
177
+ /**
178
+ * The state name in an address.
179
+ */
180
+ state?: string;
181
+ }
182
+
183
+ export interface ClassRef {
184
+ full_name?: string;
185
+ list_id?: string;
186
+ }
187
+
188
+ export interface Contacts {
189
+ additional_contact_ref?: AdditionalContactRef[];
190
+ /**
191
+ * The first name of a customer, vendor, employee, or person on the “other names” list.
192
+ */
193
+ first_name: string;
194
+ /**
195
+ * The job title of a customer, vendor, employee, or person on the “other names” list.
196
+ */
197
+ job_title?: string;
198
+ /**
199
+ * The last name of a customer, vendor, employee, or person on the “other names” list.
200
+ */
201
+ last_name?: string;
202
+ /**
203
+ * The middle name of a customer, vendor, employee, or person on the “other names” list.
204
+ */
205
+ middle_name?: string;
206
+ /**
207
+ * A formal reference, such as Mr. or Dr., that precedes a name.
208
+ */
209
+ salutation?: string;
210
+ }
211
+
212
+ export interface ContactsMod {
213
+ additional_contact_ref?: AdditionalContactRef[];
214
+ /**
215
+ * `edit_sequence` is a server-generated revision token. It changes each time the object is updated. To modify an existing object, you must send the current `edit_sequence`. If your value is stale, the update is rejected to prevent overwriting newer changes.
216
+ */
217
+ edit_sequence?: string;
218
+ /**
219
+ * The first name of a customer, vendor, employee, or person on the “other names” list.
220
+ */
221
+ first_name: string;
222
+ /**
223
+ * The job title of a customer, vendor, employee, or person on the “other names” list.
224
+ */
225
+ job_title?: string;
226
+ /**
227
+ * The last name of a customer, vendor, employee, or person on the “other names” list.
228
+ */
229
+ last_name?: string;
230
+ /**
231
+ * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
232
+ */
233
+ list_id?: string;
234
+ /**
235
+ * The middle name of a customer, vendor, employee, or person on the “other names” list.
236
+ */
237
+ middle_name?: string;
238
+ /**
239
+ * A formal reference, such as Mr. or Dr., that precedes a name.
240
+ */
241
+ salutation?: string;
242
+ }
243
+
244
+ export interface CreditCardTxnInfo {
245
+ /**
246
+ * This contains data originally supplied in the QBMS transaction request. This information block shouldn’t be used in CreditMemo requests for QuickBooks 2007 and new versions. Instead, use the ARRefundCreditCard request.
247
+ */
248
+ credit_card_txn_input_info: CreditCardTxnInputInfo;
249
+ /**
250
+ * This contains data returned in the QBMS transaction response. This information block shouldn’t be used in CreditMemo requests for QuickBooks 2007 and new versions. Instead, use the ARRefundCreditCard request.
251
+ */
252
+ credit_card_txn_result_info: CreditCardTxnResultInfo;
253
+ }
254
+
255
+ export interface CreditCardTxnInputInfo {
256
+ /**
257
+ * This optional field is used only for Visa and Master Card commercial cards. There are three types of these cards: purchase, corporate, and business. Normally, special lower transaction fee rates apply when these cards are used and this field is filled out. If this field is left blank, then the usual (and higher) discount rate applies.
258
+ */
259
+ commercial_card_code?: string;
260
+ /**
261
+ * The address associated with this credit card.
262
+ */
263
+ credit_card_address?: string;
264
+ /**
265
+ * Credit-card number for this customer or this payment. Beginning with qbXML spec 6.0 and QuickBooks 2007, you must mask the credit card number with lower case “x” and no dashes. For example, xxxxxxxxxxxx1234.
266
+ */
267
+ credit_card_number: string;
268
+ /**
269
+ * The postal code associated with the address for this credit card.
270
+ */
271
+ credit_card_postal_code?: string;
272
+ /**
273
+ * Indicates the QBMS transaction from which the current transaction data originated, for example, Charge, Authorization, Capture, Refund, VoiceAuthorization, or Void.
274
+ */
275
+ credit_card_txn_type?: "Authorization" | "Capture" | "Charge" | "Refund" | "VoiceAuthorization";
276
+ /**
277
+ * The month when the credit card expires.
278
+ *
279
+ * Minimum 1. Maximum 12.
280
+ */
281
+ expiration_month: number;
282
+ /**
283
+ * The year when the credit card expires.
284
+ */
285
+ expiration_year: number;
286
+ /**
287
+ * The name on the customer’s credit card.
288
+ */
289
+ name_on_card: string;
290
+ /**
291
+ * Indicates whether this transaction came from a card swipe (tmCardPresent) or not (tmCardNotPresent).
292
+ */
293
+ transaction_mode?: "CardNotPresent" | "CardPresent";
294
+ }
295
+
296
+ export interface CreditCardTxnResultInfo {
297
+ /**
298
+ * The authorization code is returned from the credit card processor to indicate that the charge will be paid by the card issuer. In a voice authorization request (CustomerCreditCardVoiceAuthRq), the authorization code is supplied by the card issuer over the telephone.
299
+ */
300
+ authorization_code?: string;
301
+ /**
302
+ * This field contains the value avssPass if the street address supplied in the transaction request matches the customer’s address on file at the card issuer. It contains the value avssFail if there isn’t a match, or avssNotAvailable if the card issuer doesn’t support AVS. Note: This field was required in qbXML 4.1, but is optional in qbXML 5.0 and later.
303
+ */
304
+ avs_street?: "Fail" | "NotAvailable" | "Pass";
305
+ /**
306
+ * This field contains the value avszPass if the customer postal ZIP code supplied in the transaction request matches the customer’s postal code recognized at the card issuer. It contains the value avszFail if there isn’t a match, or avszNotAvailable if the card issuer doesn’t support AVS. Note: This field was required in qbXML 4.1, but is optional in qbXML 5.0 and later.
307
+ */
308
+ avs_zip?: "Fail" | "NotAvailable" | "Pass";
309
+ /**
310
+ * This field contains the value Pass if the card security code supplied in the transaction request matches the card security code recognized for that credit card number at the card issuer. It contains the value Fail if there isn’t a match.
311
+ */
312
+ card_security_code_match?: "Fail" | "NotAvailable" | "Pass";
313
+ /**
314
+ * This value is returned from QBMS transactions for future use by the QuickBooks Reconciliation feature.
315
+ */
316
+ client_trans_id?: string;
317
+ /**
318
+ * This transaction ID is returned from the credit card processor. You should save this value for any possible QBMS SDK transaction requests that need it, for example, CustomerCreditCardTxnVoidRq, or CustomerCreditCardCaptureRq.
319
+ */
320
+ credit_card_trans_id: string;
321
+ /**
322
+ * This is the QBMS account number of the merchant who is running the transaction using the customer’s credit card. It is returned from the transaction request and should be stored for subsequent transactions, such as using it in the QB SDK SalesReceiptAdd, ReceivePaymentAdd, ARRefundCreditCard requests to save the transaction data in QuickBooks.
323
+ */
324
+ merchant_account_number: string;
325
+ /**
326
+ * Internal code needed for the QuickBooks reconciliation feature, if integrating with QuickBooks. This value is returned in the QBMS response to a QBMS transaction request, and must be subsequently supplied by your application in the QB SDK ReceivePaymentAdd or SalesReceiptAdd request.
327
+ */
328
+ payment_grouping_code?: number;
329
+ /**
330
+ * Indicates payment processing status as known by QuickBooks/QBMS integration state. `psCompleted` indicates confirmed success; `psUnknown` indicates status could not be definitively confirmed.
331
+ */
332
+ payment_status: "Completed" | "Unknown";
333
+ /**
334
+ * This value is returned by QBMS from the transaction request, and is used internally by the QuickBooks/QBMS Recon (reconcile) feature. You should save this value without modification and include it in the QB SDK SalesReceiptAdd or ReceivePaymentAdd requests if you want to save the transaction data in QuickBooks.
335
+ */
336
+ recon_batch_id?: string;
337
+ /**
338
+ * This contains the status code returned in the original QBMS transaction response.
339
+ */
340
+ result_code: number;
341
+ /**
342
+ * This contains the status message returned in the original QBMS transaction response.
343
+ */
344
+ result_message: string;
345
+ /**
346
+ * This value is used to support the credit card transaction Reconcile feature within QuickBooks.
347
+ */
348
+ txn_authorization_stamp?: number;
349
+ /**
350
+ * Timestamp indicating the time in which the card processor authorized the transaction.
351
+ *
352
+ * Format: date-time.
353
+ */
354
+ txn_authorization_time: string;
355
+ }
356
+
357
+ export interface CreditMemoLineGroupAdd {
358
+ data_ext?: DataExtBill[];
359
+ /**
360
+ * A descriptive text field.
361
+ */
362
+ desc?: string;
363
+ /**
364
+ * Location within the Inventory Site.
365
+ */
366
+ inventory_site_location_ref?: CurrencyRef;
367
+ /**
368
+ * Site where inventory is located.
369
+ */
370
+ inventory_site_ref?: CurrencyRef;
371
+ /**
372
+ * ItemGroup objects represent items that are grouped together for fast entry, and an `item_group_ref` aggregate refers to one of these item groups. In a request, if an `item_group_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. You can use an ItemGroupQuery request to get information about all the item groups that are set up in the QuickBooks file.
373
+ */
374
+ item_group_ref: CurrencyRef;
375
+ /**
376
+ * On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
377
+ */
378
+ quantity?: number;
379
+ /**
380
+ * Indicates the date on which the QuickBooks user performs the service for the customer.
381
+ *
382
+ * Format: date.
383
+ */
384
+ service_date?: string;
385
+ /**
386
+ * In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
387
+ */
388
+ unit_of_measure?: string;
389
+ }
390
+
391
+ /**
392
+ * Give exactly one of: `list_id`, or `full_name`.
393
+ */
394
+ export interface CurrencyFilter {
395
+ /**
396
+ * `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
397
+ */
398
+ full_name?: string[];
399
+ /**
400
+ * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
401
+ */
402
+ list_id?: string[];
403
+ }
404
+
405
+ export interface CurrencyRef {
406
+ /**
407
+ * `full_name` (along with `list_id`) is a way to identify a list object. The `full_name` is the name prefixed by the names of each ancestor, for example Jones:Kitchen:Cabinets. `full_name` values aren’t case-sensitive.
408
+ */
409
+ full_name?: string;
410
+ /**
411
+ * `list_id` and `full_name` both identify a list object. QuickBooks assigns `list_id` when the object is created. `list_id` values are unique within a list type, not globally across all lists. If both `full_name` and `list_id` are supplied in a request, QuickBooks uses `list_id` and ignores `full_name`.
412
+ */
413
+ list_id?: string;
414
+ }
415
+
416
+ export interface DataExtBill {
417
+ /**
418
+ * The name of the data extension. If this is a custom field, `data_ext_name` will be visible as a label in the QuickBooks user interface. Also because `owner_id` and `data_ext_name` together make the data extension unique, and because custom fields all have the same `owner_id` of zero, the `data_ext_name` must be a unique value among existing custom fields.
419
+ */
420
+ data_ext_name: string;
421
+ /**
422
+ * The data in this field. The maximum length of `data_ext_value` will depend on the `data_ext_type` of this data extension. For example, if `data_ext_type` is STR255TYPE, the maximum length of `data_ext_value` is 255 characters. If `data_ext_type` is STR1024TYPE, the maximum size of `data_ext_value` is 1KB.
423
+ */
424
+ data_ext_value: string;
425
+ /**
426
+ * `owner_id` identifies who owns the data extension. Use 0 for QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned by an app. Keep private GUIDs confidential unless you intentionally share extensions across apps. If you do share them, both apps must use the same `owner_id` and `data_ext_name`, because that pair uniquely identifies the extension.
427
+ */
428
+ owner_id: string;
429
+ }
430
+
431
+ export interface DeletedDateRangeFilter {
432
+ /**
433
+ * Selects objects deleted on or after this date. Both `from_deleted_date` and `to_deleted_date` must be between 1970-01-01 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). (But note that ListDeletedQuery requests will only return records deleted within the last 90 days, even if the specified `from_deleted_date` is earlier.)
434
+ *
435
+ * Format: date-time.
436
+ */
437
+ from_deleted_date?: string;
438
+ /**
439
+ * Selects objects deleted on or before this date. Both `to_deleted_date` and `from_deleted_date` must be between 1970-01-01 and 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST). If `to_deleted_date` includes a date but not a time (for example, if you set it to 2002-02-14), the time is assumed to be the end of the day (2003-02-14T23:59:59).
440
+ *
441
+ * Format: date-time.
442
+ */
443
+ to_deleted_date?: string;
444
+ }
445
+
446
+ export interface DiscountLineAdd {
447
+ account_ref?: CurrencyRef;
448
+ /**
449
+ * A monetary amount.
450
+ *
451
+ * Choose at most one of: `amount`, or `rate_percent`.
452
+ */
453
+ amount?: number;
454
+ is_taxable?: boolean;
455
+ /**
456
+ * Indicates the price of something as a percent.
457
+ *
458
+ * Choose at most one of: `amount`, or `rate_percent`.
459
+ */
460
+ rate_percent?: number;
461
+ }
462
+
463
+ export interface ExpenseLineAdd {
464
+ /**
465
+ * `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for `expense_line_add` it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
466
+ */
467
+ account_ref?: CurrencyRef;
468
+ /**
469
+ * A monetary amount.
470
+ */
471
+ amount?: number;
472
+ /**
473
+ * The billing status of this item line or expense line.
474
+ */
475
+ billable_status?: "Billable" | "HasBeenBilled" | "NotBillable";
476
+ /**
477
+ * Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
478
+ */
479
+ class_ref?: CurrencyRef;
480
+ /**
481
+ * `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
482
+ */
483
+ customer_ref?: CurrencyRef;
484
+ data_ext?: DataExtBill[];
485
+ /**
486
+ * `def_macro` lets you assign a reusable name to a returned `txn_id` or `txn_line_id` so later requests can reference it with `useMacro`. This feature requires SDK 2.0+.
487
+ */
488
+ def_macro?: string;
489
+ /**
490
+ * Additional information.
491
+ */
492
+ memo?: string;
493
+ /**
494
+ * A sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A `sales_rep_ref` refers to a person on the SalesRep list. In a request, if a `sales_rep_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
495
+ */
496
+ sales_rep_ref?: CurrencyRef;
497
+ /**
498
+ * `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored.
499
+ */
500
+ sales_tax_code_ref?: CurrencyRef;
501
+ tax_amount?: number;
502
+ }
503
+
504
+ export interface ExpenseLineMod {
505
+ /**
506
+ * `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
507
+ */
508
+ account_ref?: CurrencyRef;
509
+ /**
510
+ * A monetary amount.
511
+ */
512
+ amount?: number;
513
+ /**
514
+ * The billing status of this item line or expense line.
515
+ */
516
+ billable_status?: "Billable" | "HasBeenBilled" | "NotBillable";
517
+ /**
518
+ * Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
519
+ */
520
+ class_ref?: CurrencyRef;
521
+ /**
522
+ * `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
523
+ */
524
+ customer_ref?: CurrencyRef;
525
+ /**
526
+ * Additional information.
527
+ */
528
+ memo?: string;
529
+ /**
530
+ * A sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A `sales_rep_ref` refers to a person on the SalesRep list. In a request, if a `sales_rep_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
531
+ */
532
+ sales_rep_ref?: CurrencyRef;
533
+ /**
534
+ * `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored.
535
+ */
536
+ sales_tax_code_ref?: CurrencyRef;
537
+ tax_amount?: number;
538
+ /**
539
+ * Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
540
+ */
541
+ txn_line_id: string;
542
+ }
543
+
544
+ export interface ItemGroupLineAdd {
545
+ data_ext?: DataExtBill[];
546
+ /**
547
+ * A descriptive text field.
548
+ */
549
+ desc?: string;
550
+ /**
551
+ * Location within the Inventory Site.
552
+ */
553
+ inventory_site_location_ref?: CurrencyRef;
554
+ /**
555
+ * Site where inventory is located.
556
+ */
557
+ inventory_site_ref?: CurrencyRef;
558
+ /**
559
+ * ItemGroup objects represent items that are grouped together for fast entry, and an `item_group_ref` aggregate refers to one of these item groups. In a request, if an `item_group_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. You can use an ItemGroupQuery request to get information about all the item groups that are set up in the QuickBooks file.
560
+ */
561
+ item_group_ref: CurrencyRef;
562
+ /**
563
+ * On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
564
+ */
565
+ quantity?: number;
566
+ /**
567
+ * In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
568
+ */
569
+ unit_of_measure?: string;
570
+ }
571
+
572
+ export interface ItemGroupLineMod {
573
+ /**
574
+ * ItemGroup objects represent items that are grouped together for fast entry, and an `item_group_ref` aggregate refers to one of these item groups. In a request, if an `item_group_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored. You can use an ItemGroupQuery request to get information about all the item groups that are set up in the QuickBooks file.
575
+ */
576
+ item_group_ref?: CurrencyRef;
577
+ /**
578
+ * An ItemLine is used to track any portion of a transaction that represents the purchase of an “item.” If ItemLineAdd doesn’t specify an Amount, Cost, or Quantity, then QuickBooks will calculate Amount based on a Quantity of 1 and the suggested Cost.
579
+ */
580
+ item_line_mod?: ItemLineMod[];
581
+ /**
582
+ * When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you can’t change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request.
583
+ */
584
+ override_uom_set_ref?: CurrencyRef;
585
+ /**
586
+ * On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
587
+ */
588
+ quantity?: number;
589
+ /**
590
+ * Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
591
+ */
592
+ txn_line_id: string;
593
+ /**
594
+ * In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
595
+ */
596
+ unit_of_measure?: string;
597
+ }
598
+
599
+ export interface ItemLineAdd {
600
+ /**
601
+ * A monetary amount.
602
+ */
603
+ amount?: number;
604
+ /**
605
+ * The billing status of this item line or expense line.
606
+ */
607
+ billable_status?: "Billable" | "HasBeenBilled" | "NotBillable";
608
+ /**
609
+ * Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
610
+ */
611
+ class_ref?: CurrencyRef;
612
+ /**
613
+ * If both Quantity and Amount are specified, QuickBooks will use them to calculate Cost. Likewise, if both Quantity and Cost are specified, QuickBooks will use them to calculate the total Amount.
614
+ */
615
+ cost?: number;
616
+ /**
617
+ * `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
618
+ */
619
+ customer_ref?: CurrencyRef;
620
+ data_ext?: DataExtBill[];
621
+ /**
622
+ * A descriptive text field.
623
+ */
624
+ desc?: string;
625
+ /**
626
+ * Location within the Inventory Site.
627
+ */
628
+ inventory_site_location_ref?: CurrencyRef;
629
+ /**
630
+ * Site where inventory is located.
631
+ */
632
+ inventory_site_ref?: CurrencyRef;
633
+ /**
634
+ * `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
635
+ */
636
+ item_ref?: CurrencyRef;
637
+ link_to_txn?: LinkToTxn;
638
+ /**
639
+ * The lot number of the asset.
640
+ *
641
+ * Choose at most one of: `serial_number`, or `lot_number`.
642
+ */
643
+ lot_number?: string;
644
+ /**
645
+ * Refers to a QuickBooks account. If an `override_item_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
646
+ */
647
+ override_item_account_ref?: CurrencyRef;
648
+ /**
649
+ * On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
650
+ */
651
+ quantity?: number;
652
+ /**
653
+ * A sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A `sales_rep_ref` refers to a person on the SalesRep list. In a request, if a `sales_rep_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
654
+ */
655
+ sales_rep_ref?: CurrencyRef;
656
+ /**
657
+ * `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored.
658
+ */
659
+ sales_tax_code_ref?: CurrencyRef;
660
+ /**
661
+ * The serial number of the asset.
662
+ *
663
+ * Choose at most one of: `serial_number`, or `lot_number`.
664
+ */
665
+ serial_number?: string;
666
+ tax_amount?: number;
667
+ /**
668
+ * In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
669
+ */
670
+ unit_of_measure?: string;
671
+ }
672
+
673
+ export interface ItemLineMod {
674
+ /**
675
+ * A monetary amount.
676
+ */
677
+ amount?: number;
678
+ /**
679
+ * The billing status of this item line or expense line.
680
+ */
681
+ billable_status?: "Billable" | "HasBeenBilled" | "NotBillable";
682
+ /**
683
+ * Use classes to categorize transactions (for example, by department, location, or work type). Class tracking is off by default in QuickBooks. A `class_ref` points to one class; if both `full_name` and `list_id` are provided, `full_name` is ignored. In InvoiceAdd, a header-level `class_ref` is applied to line items unless you override or clear it on individual lines.
684
+ */
685
+ class_ref?: CurrencyRef;
686
+ /**
687
+ * If both Quantity and Amount are specified, QuickBooks will use them to calculate Cost. Likewise, if both Quantity and Cost are specified, QuickBooks will use them to calculate the total Amount.
688
+ */
689
+ cost?: number;
690
+ /**
691
+ * `customer_ref` identifies a customer or customer job. If both `full_name` and `list_id` are provided, `full_name` is ignored. In SalesReceipt and ReceivePayment, it identifies who receives credit. In TimeTracking, it identifies who the time can be billed to and is required in TimeTrackingAdd when IsBillable is true.
692
+ */
693
+ customer_ref?: CurrencyRef;
694
+ /**
695
+ * A descriptive text field.
696
+ */
697
+ desc?: string;
698
+ /**
699
+ * Location within the Inventory Site.
700
+ */
701
+ inventory_site_location_ref?: CurrencyRef;
702
+ /**
703
+ * Site where inventory is located.
704
+ */
705
+ inventory_site_ref?: CurrencyRef;
706
+ /**
707
+ * `item_ref` may accept all item types or a restricted subset, depending on the request. Examples: PurchaseOrder and Bill do not allow discount or sales-tax items; VehicleMileageAdd requires a service or other-charge item; BillingRateAdd requires a service item. If both `full_name` and `list_id` are provided, `full_name` is ignored.
708
+ */
709
+ item_ref?: CurrencyRef;
710
+ /**
711
+ * The lot number of the asset.
712
+ *
713
+ * Choose at most one of: `serial_number`, or `lot_number`.
714
+ */
715
+ lot_number?: string;
716
+ /**
717
+ * Refers to a QuickBooks account. If an `override_item_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
718
+ */
719
+ override_item_account_ref?: CurrencyRef;
720
+ /**
721
+ * When you modify a transaction line to change the unit of measure used in that line, you use this aggregate to specify the UOM set within which you are choosing an available unit of measure. The “override” here refers to the unit within the set, not the UOM Set itself, which you can’t change or override–the UOM set that can be set or changed only in the item itself via an Item Mod request.
722
+ */
723
+ override_uom_set_ref?: CurrencyRef;
724
+ /**
725
+ * On transaction lines, QuickBooks can derive one value from the other two among Quantity, Rate, and Amount. If you supply Quantity and Amount, QuickBooks calculates Rate. If you supply Quantity and Rate, QuickBooks calculates Amount.
726
+ */
727
+ quantity?: number;
728
+ /**
729
+ * A sales representative must be on the Employee, Vendor, or Other Names list within QuickBooks. Sales representative’s names and initials appear on the Rep drop-down list on QuickBooks sales forms. A `sales_rep_ref` refers to a person on the SalesRep list. In a request, if a `sales_rep_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
730
+ */
731
+ sales_rep_ref?: CurrencyRef;
732
+ /**
733
+ * `sales_tax_code_ref` points to the sales-tax code used for an item or customer context. QuickBooks includes default TAX and NON codes, and a code can be deleted only when nothing references it. If sales tax is disabled, QuickBooks assigns the default non-taxable code. If both `full_name` and `list_id` are provided in `sales_tax_code_ref`, `full_name` is ignored.
734
+ */
735
+ sales_tax_code_ref?: CurrencyRef;
736
+ /**
737
+ * The serial number of the asset.
738
+ *
739
+ * Choose at most one of: `serial_number`, or `lot_number`.
740
+ */
741
+ serial_number?: string;
742
+ tax_amount?: number;
743
+ /**
744
+ * Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
745
+ */
746
+ txn_line_id: string;
747
+ /**
748
+ * In a transaction line item, the name of the unit of measure selected from within the item’s available units. If the company file is enabled only for single unit of measure per item, this must be the base unit!
749
+ */
750
+ unit_of_measure?: string;
751
+ }
752
+
753
+ export interface LiabilityPaymentSchedule {
754
+ /**
755
+ * Format: date.
756
+ */
757
+ payment_due_date?: string;
758
+ payment_due_num_days_after?: number;
759
+ payment_schedule_type: "Empty" | "FederalMonthly" | "FederalNextDay" | "FederalQuarterly" | "FederalSemiweekly" | "Monthly" | "Quarterly" | "Semiweekly" | "Weekly" | "Yearly";
760
+ }
761
+
762
+ export interface LinkToTxn {
763
+ /**
764
+ * `txn_id` is the unique QuickBooks identifier for a transaction. Use it to reference that transaction in later requests. `txn_id` values are transaction-specific and should not be reused across unrelated transaction types.
765
+ */
766
+ txn_id: string;
767
+ /**
768
+ * Identification number of the transaction line. (`txn_line_id` is supported as of v2.0 of the SDK. With qbXML v1.0 and v1.1, `txn_line_id` is always returned as zero.) If you need to add a new transaction line in a transaction Mod request, you can do so by setting the `txn_line_id` to -1.
769
+ */
770
+ txn_line_id: string;
771
+ }
772
+
773
+ export interface ModifiedDateRangeFilter {
774
+ /**
775
+ * Filters results to objects modified on or after this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to 00:00:00.
776
+ *
777
+ * Format: date-time.
778
+ */
779
+ from_modified_date?: string;
780
+ /**
781
+ * Filters results to objects modified on or before this timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a date is provided, time defaults to end-of-day (23:59:59).
782
+ *
783
+ * Format: date-time.
784
+ */
785
+ to_modified_date?: string;
786
+ }
787
+
788
+ export interface ModifiedDateRangeFilterPaycheck {
789
+ /**
790
+ * Format: date-time.
791
+ */
792
+ from_modified_date?: string;
793
+ /**
794
+ * Format: date-time.
795
+ */
796
+ to_modified_date?: string;
797
+ }
798
+
799
+ export interface NameFilter {
800
+ /**
801
+ * The criterion to match.
802
+ */
803
+ match_criterion: "Contains" | "EndsWith" | "StartsWith";
804
+ /**
805
+ * The string to match.
806
+ */
807
+ name: string;
808
+ }
809
+
810
+ export interface NameRangeFilter {
811
+ /**
812
+ * The first name or item in the search range. If `from_name` is omitted, the range will begin with first name on the list.
813
+ */
814
+ from_name?: string;
815
+ /**
816
+ * The final name or item in the search range. If `to_name` is omitted, the range will end with last name on the list.
817
+ */
818
+ to_name?: string;
819
+ }
820
+
821
+ /**
822
+ * Give exactly one of: (`from_payroll_date`, `to_payroll_date`), or `date_macro`.
823
+ */
824
+ export interface PayrollDateRangeFilter {
825
+ date_macro?: "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDate" | "LastCalendarYear" | "LastCalendarYearToDate" | "LastFiscalQuarter" | "LastFiscalQuarterToDate" | "LastFiscalYear" | "LastFiscalYearToDate" | "LastMonth" | "LastMonthToDate" | "LastWeek" | "LastWeekToDate" | "NextCalendarQuarter" | "NextCalendarYear" | "NextFiscalQuarter" | "NextFiscalYear" | "NextFourWeeks" | "NextMonth" | "NextWeek" | "ThisCalendarQuarter" | "ThisCalendarQuarterToDate" | "ThisCalendarYear" | "ThisCalendarYearToDate" | "ThisFiscalQuarter" | "ThisFiscalQuarterToDate" | "ThisFiscalYear" | "ThisFiscalYearToDate" | "ThisMonth" | "ThisMonthToDate" | "ThisWeek" | "ThisWeekToDate" | "Today" | "Yesterday";
826
+ /**
827
+ * Format: date.
828
+ */
829
+ from_payroll_date?: string;
830
+ /**
831
+ * Format: date.
832
+ */
833
+ to_payroll_date?: string;
834
+ }
835
+
836
+ export interface RefNumberFilter {
837
+ /**
838
+ * The criterion to match.
839
+ */
840
+ match_criterion: "Contains" | "EndsWith" | "StartsWith";
841
+ /**
842
+ * `ref_number` is a user-managed transaction reference (for example, a check number). It can be edited and is not guaranteed to be globally unique. Some transaction types auto-populate `ref_number` when omitted, based on QuickBooks preferences and numbering state.
843
+ */
844
+ ref_number: string;
845
+ }
846
+
847
+ export interface RefNumberFilterPaycheck {
848
+ match_criterion: "Contains" | "EndsWith" | "StartsWith";
849
+ ref_number: string;
850
+ }
851
+
852
+ export interface RefNumberRangeFilter {
853
+ /**
854
+ * The first `ref_number` in the search range. If `from_ref_number` is omitted, the range will begin with first number on the list.
855
+ */
856
+ from_ref_number?: string;
857
+ /**
858
+ * The final `ref_number` in the search range. If `to_ref_number` is omitted, the range will end with last number on the list.
859
+ */
860
+ to_ref_number?: string;
861
+ }
862
+
863
+ export interface RefNumberRangeFilterPaycheck {
864
+ from_ref_number?: string;
865
+ to_ref_number?: string;
866
+ }
867
+
868
+ /**
869
+ * Give exactly one of: `account_type_filter`, or `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
870
+ */
871
+ export interface ReportAccountFilter {
872
+ /**
873
+ * Allows you to report on a specific account type.
874
+ */
875
+ account_type_filter?: "APAndSalesTax" | "APOrCreditCard" | "ARAndAP" | "AccountsPayable" | "AccountsReceivable" | "AllowedFor1099" | "Asset" | "BalanceSheet" | "Bank" | "BankAndARAndAPAndUF" | "BankAndUF" | "CostOfSales" | "CreditCard" | "CurrentAsset" | "CurrentAssetAndExpense" | "CurrentLiability" | "Equity" | "EquityAndIncomeAndExpense" | "ExpenseAndOtherExpense" | "FixedAsset" | "IncomeAndExpense" | "IncomeAndOtherIncome" | "Liability" | "LiabilityAndEquity" | "LongTermLiability" | "NonPosting" | "OrdinaryExpense" | "OrdinaryIncome" | "OrdinaryIncomeAndCOGS" | "OrdinaryIncomeAndExpense" | "OtherAsset" | "OtherCurrentAsset" | "OtherCurrentLiability" | "OtherExpense" | "OtherIncome" | "OtherIncomeOrExpense";
876
+ full_name?: string[];
877
+ /**
878
+ * Allows you to filter for data that relates to the specified object and its descendants. For names that don’t have children, `full_name_with_children` is exactly the same as `full_name`.
879
+ */
880
+ full_name_with_children?: string;
881
+ list_id?: string[];
882
+ /**
883
+ * Allows you to filter for data that relates to the specified object and its descendants.
884
+ */
885
+ list_id_with_children?: string;
886
+ }
887
+
888
+ /**
889
+ * Give exactly one of: `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
890
+ */
891
+ export interface ReportClassFilter {
892
+ full_name?: string[];
893
+ /**
894
+ * Allows you to filter for data that relates to the specified object and its descendants. For names that don’t have children, `full_name_with_children` is exactly the same as `full_name`.
895
+ */
896
+ full_name_with_children?: string;
897
+ list_id?: string[];
898
+ /**
899
+ * Allows you to filter for data that relates to the specified object and its descendants.
900
+ */
901
+ list_id_with_children?: string;
902
+ }
903
+
904
+ /**
905
+ * Give exactly one of: `entity_type_filter`, or `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
906
+ */
907
+ export interface ReportEntityFilter {
908
+ /**
909
+ * Allows you to report on a specific name type.
910
+ */
911
+ entity_type_filter?: "Customer" | "Employee" | "OtherName" | "Vendor";
912
+ full_name?: string[];
913
+ /**
914
+ * Allows you to filter for data that relates to the specified object and its descendants. For names that don’t have children, `full_name_with_children` is exactly the same as `full_name`.
915
+ */
916
+ full_name_with_children?: string;
917
+ list_id?: string[];
918
+ /**
919
+ * Allows you to filter for data that relates to the specified object and its descendants.
920
+ */
921
+ list_id_with_children?: string;
922
+ }
923
+
924
+ /**
925
+ * Give exactly one of: `item_type_filter`, or `list_id`, or `full_name`, or `list_id_with_children`, or `full_name_with_children`.
926
+ */
927
+ export interface ReportItemFilter {
928
+ full_name?: string[];
929
+ /**
930
+ * Allows you to filter for data that relates to the specified object and its descendants. For names that don’t have children, `full_name_with_children` is exactly the same as `full_name`.
931
+ */
932
+ full_name_with_children?: string;
933
+ /**
934
+ * Allows you to report on a specific item type.
935
+ */
936
+ item_type_filter?: "AllExceptFixedAsset" | "Assembly" | "Discount" | "FixedAsset" | "Inventory" | "InventoryAndAssembly" | "NonInventory" | "OtherCharge" | "Payment" | "Sales" | "SalesTax" | "Service";
937
+ list_id?: string[];
938
+ /**
939
+ * Allows you to filter for data that relates to the specified object and its descendants.
940
+ */
941
+ list_id_with_children?: string;
942
+ }
943
+
944
+ export interface ReportModifiedDateRangeFilter {
945
+ /**
946
+ * Selects information from this date and later. The range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
947
+ *
948
+ * Format: date.
949
+ */
950
+ from_report_modified_date?: string;
951
+ /**
952
+ * Selects information created on this date or earlier. The range of acceptable dates is 1970-01-01 to 2038-01-19T03:14:07 (2038-01-18T19:14:07-08:00 PST).
953
+ *
954
+ * Format: date.
955
+ */
956
+ to_report_modified_date?: string;
957
+ }
958
+
959
+ export interface ReportPeriod {
960
+ /**
961
+ * Selects information from this date and later. The range of acceptable `from_report_date` and `to_report_date` values depends on how the report dates are determined. If the report dates are based on the dates of transactions, the range is 01/01/1901 to 12/31/9999.
962
+ *
963
+ * Format: date.
964
+ */
965
+ from_report_date?: string;
966
+ /**
967
+ * Selects information created on this date or earlier. The range of acceptable `to_report_date` and `from_report_date` values depends on how the report dates are determined. If the report dates are based on the dates of transactions, the range is 01/01/1901 to 12/31/9999.
968
+ *
969
+ * Format: date.
970
+ */
971
+ to_report_date?: string;
972
+ }
973
+
974
+ export interface ReportTxnTypeFilter {
975
+ txn_type_filter: Array<"ARRefundCreditCard" | "All" | "Bill" | "BillPaymentCheck" | "BillPaymentCreditCard" | "BuildAssembly" | "Charge" | "Check" | "CreditCardCharge" | "CreditCardCredit" | "CreditMemo" | "Deposit" | "Estimate" | "InventoryAdjustment" | "Invoice" | "ItemReceipt" | "JournalEntry" | "LiabilityAdjustment" | "Paycheck" | "PayrollLiabilityCheck" | "PurchaseOrder" | "ReceivePayment" | "SalesOrder" | "SalesReceipt" | "SalesTaxPaymentCheck" | "Transfer" | "VendorCredit" | "YTDAdjustment">;
976
+ }
977
+
978
+ export interface SalesAndPurchase {
979
+ /**
980
+ * Refers to an expense account. If an `expense_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
981
+ */
982
+ expense_account_ref?: CurrencyRef;
983
+ /**
984
+ * Refers to an income account. If an `income_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
985
+ */
986
+ income_account_ref?: CurrencyRef;
987
+ /**
988
+ * The preferred vendor for this item. If a `pref_vendor_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
989
+ */
990
+ pref_vendor_ref?: CurrencyRef;
991
+ /**
992
+ * Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item.
993
+ */
994
+ purchase_cost?: number;
995
+ /**
996
+ * Description that appears in the Description column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased.
997
+ */
998
+ purchase_desc?: string;
999
+ /**
1000
+ * Account used for taxes on purchases in CA or UK.
1001
+ */
1002
+ purchase_tax_code_ref?: CurrencyRef;
1003
+ /**
1004
+ * Appears in the Description column of a sales form when the QuickBooks user sells this item. For a fixed asset, describes the sale of the asset (for accounting purposes).
1005
+ */
1006
+ sales_desc?: string;
1007
+ /**
1008
+ * Price charged for this item.
1009
+ */
1010
+ sales_price?: number;
1011
+ }
1012
+
1013
+ export interface SalesAndPurchaseMod {
1014
+ /**
1015
+ * Used to support changing the `account_ref` in the Mod request. When you do this, the QuickBooks UI normally displays a prompt asking whether the change should apply to existing transactions or not. Specifying False basically dismisses this with a “No” answer; specifying True dismisses it with a “Yes” answer and then changes the existing transactions that use the item with that `account_ref`.
1016
+ */
1017
+ apply_expense_account_ref_to_existing_txns?: boolean;
1018
+ /**
1019
+ * Used to support changing the `account_ref` in the Mod request. When you do this, the QuickBooks UI normally displays a prompt asking whether the change should apply to existing transactions or not. Specifying False basically dismisses this with a “No” answer; specifying True dismisses it with a “Yes” answer and then changes the existing transactions that use the item with that `account_ref`.
1020
+ */
1021
+ apply_income_account_ref_to_existing_txns?: boolean;
1022
+ /**
1023
+ * Refers to an expense account. If an `expense_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
1024
+ */
1025
+ expense_account_ref?: CurrencyRef;
1026
+ /**
1027
+ * Refers to an income account. If an `income_account_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
1028
+ */
1029
+ income_account_ref?: CurrencyRef;
1030
+ /**
1031
+ * The preferred vendor for this item. If a `pref_vendor_ref` aggregate includes both `full_name` and `list_id`, `full_name` will be ignored.
1032
+ */
1033
+ pref_vendor_ref?: CurrencyRef;
1034
+ /**
1035
+ * Amount that the QuickBooks user expects to pay when ordering or buying this item, or the amount that was actually paid for this item.
1036
+ */
1037
+ purchase_cost?: number;
1038
+ /**
1039
+ * Description that appears in the Description column of checks, bills, credit card charges, and item receipts (when an item is reordered). For a fixed asset, a description of the item as it was when it was purchased.
1040
+ */
1041
+ purchase_desc?: string;
1042
+ /**
1043
+ * Account used for taxes on purchases in CA or UK.
1044
+ */
1045
+ purchase_tax_code_ref?: CurrencyRef;
1046
+ /**
1047
+ * Appears in the Description column of a sales form when the QuickBooks user sells this item. For a fixed asset, describes the sale of the asset (for accounting purposes).
1048
+ */
1049
+ sales_desc?: string;
1050
+ /**
1051
+ * Price charged for this item.
1052
+ */
1053
+ sales_price?: number;
1054
+ }
1055
+
1056
+ export interface SalesOrPurchase {
1057
+ /**
1058
+ * `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
1059
+ */
1060
+ account_ref?: CurrencyRef;
1061
+ /**
1062
+ * A descriptive text field.
1063
+ */
1064
+ desc?: string;
1065
+ /**
1066
+ * The purchase price or sales price of this item.
1067
+ *
1068
+ * Choose at most one of: `price`, or `price_percent`.
1069
+ */
1070
+ price?: number;
1071
+ /**
1072
+ * The price expressed as a percent. (For example, an auto shop that calculates the cost of labor as a percentage of the cost of parts might have a service item called “Labor” that uses `price_percent` instead of Price.)
1073
+ *
1074
+ * Choose at most one of: `price`, or `price_percent`.
1075
+ */
1076
+ price_percent?: number;
1077
+ }
1078
+
1079
+ export interface SalesOrPurchaseMod {
1080
+ /**
1081
+ * `account_ref` points to an account in the company file. If both `full_name` and `list_id` are provided, `full_name` is ignored. Meaning depends on context: for checks it is the funding account; for ExpenseLineAdd it may be required by accounting preferences; for credit-card transactions it identifies the bank or card account involved.
1082
+ */
1083
+ account_ref?: CurrencyRef;
1084
+ /**
1085
+ * Used to support changing the `account_ref` in the Mod request. When you do this, the QuickBooks UI normally displays a prompt asking whether the change should apply to existing transactions or not. Specifying False basically dismisses this with a “No” answer; specifying True dismisses it with a “Yes” answer and then changes the existing transactions that use the item with that `account_ref`.
1086
+ */
1087
+ apply_account_ref_to_existing_txns?: boolean;
1088
+ /**
1089
+ * A descriptive text field.
1090
+ */
1091
+ desc?: string;
1092
+ /**
1093
+ * The purchase price or sales price of this item.
1094
+ *
1095
+ * Choose at most one of: `price`, or `price_percent`.
1096
+ */
1097
+ price?: number;
1098
+ /**
1099
+ * The price expressed as a percent. (For example, an auto shop that calculates the cost of labor as a percentage of the cost of parts might have a service item called “Labor” that uses `price_percent` instead of Price.)
1100
+ *
1101
+ * Choose at most one of: `price`, or `price_percent`.
1102
+ */
1103
+ price_percent?: number;
1104
+ }
1105
+
1106
+ export interface SalesTaxLineAdd {
1107
+ account_ref?: CurrencyRef;
1108
+ /**
1109
+ * A monetary amount.
1110
+ *
1111
+ * Choose at most one of: `amount`, or `rate_percent`.
1112
+ */
1113
+ amount?: number;
1114
+ /**
1115
+ * Indicates the price of something as a percent.
1116
+ *
1117
+ * Choose at most one of: `amount`, or `rate_percent`.
1118
+ */
1119
+ rate_percent?: number;
1120
+ }
1121
+
1122
+ export interface SetCredit {
1123
+ /**
1124
+ * Amount of a credit that is applied to a customer’s invoice, or amount of a payment that is applied to a particular bill or vendor credit.
1125
+ */
1126
+ applied_amount: number;
1127
+ /**
1128
+ * The ID of the credit memo that you are applying to this invoice or bill.
1129
+ */
1130
+ credit_txn_id: string;
1131
+ /**
1132
+ * Option to override credit
1133
+ */
1134
+ override?: boolean;
1135
+ txn_line_id?: string;
1136
+ }
1137
+
1138
+ export interface ShipAddress {
1139
+ /**
1140
+ * The first line of an address.
1141
+ */
1142
+ addr1?: string;
1143
+ /**
1144
+ * The second line of an address (if a second line is needed).
1145
+ */
1146
+ addr2?: string;
1147
+ /**
1148
+ * The third line of an address (if a third line is needed).
1149
+ */
1150
+ addr3?: string;
1151
+ /**
1152
+ * The fourth line of an address (if a fourth line is needed).
1153
+ */
1154
+ addr4?: string;
1155
+ /**
1156
+ * The fifth line of an address (if a fifth line is needed).
1157
+ */
1158
+ addr5?: string;
1159
+ /**
1160
+ * The city name in an address.
1161
+ */
1162
+ city?: string;
1163
+ /**
1164
+ * The country name in an address, or, in returned Host information (HostRet or HostInfo), the country for which this edition of QuickBooks was designed. (Possible values are US, CA, UK, and AU.)
1165
+ */
1166
+ country?: string;
1167
+ /**
1168
+ * In a BillAddress or `ship_address` aggregate, the Note field value is written at the bottom of the address in the form in which it appears, such as the invoice form.
1169
+ */
1170
+ note?: string;
1171
+ /**
1172
+ * The postal code in an address.
1173
+ */
1174
+ postal_code?: string;
1175
+ /**
1176
+ * The state name in an address.
1177
+ */
1178
+ state?: string;
1179
+ }
1180
+
1181
+ export interface ShippingLineAdd {
1182
+ account_ref?: CurrencyRef;
1183
+ /**
1184
+ * A monetary amount.
1185
+ */
1186
+ amount: number;
1187
+ }
1188
+
1189
+ export interface Taxability {
1190
+ is_tax_applied: boolean;
1191
+ payroll_item_tax_ref: ClassRef;
1192
+ }
1193
+
1194
+ /**
1195
+ * Give exactly one of: (`from_txn_date`, `to_txn_date`), or `date_macro`.
1196
+ */
1197
+ export interface TxnDateRangeFilter {
1198
+ /**
1199
+ * `date_macro` filters by transaction date (not last-modified date). Do not combine `date_macro` with `from_modified_date`/`to_modified_date` in the same query filter set.
1200
+ */
1201
+ date_macro?: "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDate" | "LastCalendarYear" | "LastCalendarYearToDate" | "LastFiscalQuarter" | "LastFiscalQuarterToDate" | "LastFiscalYear" | "LastFiscalYearToDate" | "LastMonth" | "LastMonthToDate" | "LastWeek" | "LastWeekToDate" | "NextCalendarQuarter" | "NextCalendarYear" | "NextFiscalQuarter" | "NextFiscalYear" | "NextFourWeeks" | "NextMonth" | "NextWeek" | "ThisCalendarQuarter" | "ThisCalendarQuarterToDate" | "ThisCalendarYear" | "ThisCalendarYearToDate" | "ThisFiscalQuarter" | "ThisFiscalQuarterToDate" | "ThisFiscalYear" | "ThisFiscalYearToDate" | "ThisMonth" | "ThisMonthToDate" | "ThisWeek" | "ThisWeekToDate" | "Today" | "Yesterday";
1202
+ /**
1203
+ * Selects transactions created on or after this date. Both `from_txn_date` and `to_txn_date` must be between 01/01/1901 and 12/31/9999.If you omit `from_txn_date`, it will be set to 1970-01-01 (1969-12-31 PST).
1204
+ *
1205
+ * Format: date.
1206
+ */
1207
+ from_txn_date?: string;
1208
+ /**
1209
+ * Selects transactions created on or before this date. Both `to_txn_date` and `from_txn_date` must be between 01/01/1901 and 12/31/9999. If you omit `to_txn_date`, it will be set to 2038-01-19 (2038-01-18 PST).
1210
+ *
1211
+ * Format: date.
1212
+ */
1213
+ to_txn_date?: string;
1214
+ }
1215
+
1216
+ /**
1217
+ * Give exactly one of: (`from_txn_date`, `to_txn_date`), or `date_macro`.
1218
+ */
1219
+ export interface TxnDateRangeFilterBill {
1220
+ /**
1221
+ * `date_macro` filters by transaction date (not last-modified date). Do not combine `date_macro` with `from_modified_date`/`to_modified_date` in the same query filter set.
1222
+ */
1223
+ date_macro?: "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDate" | "LastCalendarYear" | "LastCalendarYearToDate" | "LastFiscalQuarter" | "LastFiscalQuarterToDate" | "LastFiscalYear" | "LastFiscalYearToDate" | "LastMonth" | "LastMonthToDate" | "LastWeek" | "LastWeekToDate" | "NextCalendarQuarter" | "NextCalendarYear" | "NextFiscalQuarter" | "NextFiscalYear" | "NextFourWeeks" | "NextMonth" | "NextWeek" | "ThisCalendarQuarter" | "ThisCalendarQuarterToDate" | "ThisCalendarYear" | "ThisCalendarYearToDate" | "ThisFiscalQuarter" | "ThisFiscalQuarterToDate" | "ThisFiscalYear" | "ThisFiscalYearToDate" | "ThisMonth" | "ThisMonthToDate" | "ThisWeek" | "ThisWeekToDate" | "Today" | "Yesterday";
1224
+ /**
1225
+ * Selects transactions created on or after this date. Both `from_txn_date` and `to_txn_date` must be between 01/01/1901 and 12/31/9999. If you omit `from_txn_date`, it will be set to 1970-01-01 (1969-12-31 PST).
1226
+ *
1227
+ * Format: date.
1228
+ */
1229
+ from_txn_date?: string;
1230
+ /**
1231
+ * Selects transactions created on or before this date. Both `to_txn_date` and `from_txn_date` must be between 01/01/1901 and 12/31/9999. If you omit `to_txn_date`, it will be set to 2038-01-19 (2038-01-18 PST).
1232
+ *
1233
+ * Format: date.
1234
+ */
1235
+ to_txn_date?: string;
1236
+ }
1237
+
1238
+ /**
1239
+ * Give exactly one of: (`from_txn_date`, `to_txn_date`), or `date_macro`.
1240
+ */
1241
+ export interface TxnDateRangeFilterPaycheck {
1242
+ date_macro?: "All" | "LastCalendarQuarter" | "LastCalendarQuarterToDate" | "LastCalendarYear" | "LastCalendarYearToDate" | "LastFiscalQuarter" | "LastFiscalQuarterToDate" | "LastFiscalYear" | "LastFiscalYearToDate" | "LastMonth" | "LastMonthToDate" | "LastWeek" | "LastWeekToDate" | "NextCalendarQuarter" | "NextCalendarYear" | "NextFiscalQuarter" | "NextFiscalYear" | "NextFourWeeks" | "NextMonth" | "NextWeek" | "ThisCalendarQuarter" | "ThisCalendarQuarterToDate" | "ThisCalendarYear" | "ThisCalendarYearToDate" | "ThisFiscalQuarter" | "ThisFiscalQuarterToDate" | "ThisFiscalYear" | "ThisFiscalYearToDate" | "ThisMonth" | "ThisMonthToDate" | "ThisWeek" | "ThisWeekToDate" | "Today" | "Yesterday";
1243
+ /**
1244
+ * Format: date.
1245
+ */
1246
+ from_txn_date?: string;
1247
+ /**
1248
+ * Format: date.
1249
+ */
1250
+ to_txn_date?: string;
1251
+ }
1252
+
1253
+ export interface TxnLineDetail {
1254
+ /**
1255
+ * A monetary amount.
1256
+ */
1257
+ amount: number;
1258
+ txn_line_id: string;
1259
+ }