conductor-node 14.11.0 → 14.13.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 (203) hide show
  1. package/CHANGELOG.md +31 -0
  2. package/internal/utils/log.d.mts.map +1 -1
  3. package/internal/utils/log.d.ts.map +1 -1
  4. package/internal/utils/log.js +2 -0
  5. package/internal/utils/log.js.map +1 -1
  6. package/internal/utils/log.mjs +2 -0
  7. package/internal/utils/log.mjs.map +1 -1
  8. package/package.json +1 -1
  9. package/resources/qbd/bill-check-payments.d.mts +33 -8
  10. package/resources/qbd/bill-check-payments.d.mts.map +1 -1
  11. package/resources/qbd/bill-check-payments.d.ts +33 -8
  12. package/resources/qbd/bill-check-payments.d.ts.map +1 -1
  13. package/resources/qbd/bill-credit-card-payments.d.mts +15 -4
  14. package/resources/qbd/bill-credit-card-payments.d.mts.map +1 -1
  15. package/resources/qbd/bill-credit-card-payments.d.ts +15 -4
  16. package/resources/qbd/bill-credit-card-payments.d.ts.map +1 -1
  17. package/resources/qbd/bills.d.mts +28 -0
  18. package/resources/qbd/bills.d.mts.map +1 -1
  19. package/resources/qbd/bills.d.ts +28 -0
  20. package/resources/qbd/bills.d.ts.map +1 -1
  21. package/resources/qbd/build-assemblies.d.mts +4 -0
  22. package/resources/qbd/build-assemblies.d.mts.map +1 -1
  23. package/resources/qbd/build-assemblies.d.ts +4 -0
  24. package/resources/qbd/build-assemblies.d.ts.map +1 -1
  25. package/resources/qbd/checks.d.mts +34 -0
  26. package/resources/qbd/checks.d.mts.map +1 -1
  27. package/resources/qbd/checks.d.ts +34 -0
  28. package/resources/qbd/checks.d.ts.map +1 -1
  29. package/resources/qbd/credit-card-charges.d.mts +28 -0
  30. package/resources/qbd/credit-card-charges.d.mts.map +1 -1
  31. package/resources/qbd/credit-card-charges.d.ts +28 -0
  32. package/resources/qbd/credit-card-charges.d.ts.map +1 -1
  33. package/resources/qbd/credit-card-credits.d.mts +28 -0
  34. package/resources/qbd/credit-card-credits.d.mts.map +1 -1
  35. package/resources/qbd/credit-card-credits.d.ts +28 -0
  36. package/resources/qbd/credit-card-credits.d.ts.map +1 -1
  37. package/resources/qbd/credit-card-refunds.d.mts +5 -0
  38. package/resources/qbd/credit-card-refunds.d.mts.map +1 -1
  39. package/resources/qbd/credit-card-refunds.d.ts +5 -0
  40. package/resources/qbd/credit-card-refunds.d.ts.map +1 -1
  41. package/resources/qbd/credit-memos.d.mts +26 -0
  42. package/resources/qbd/credit-memos.d.mts.map +1 -1
  43. package/resources/qbd/credit-memos.d.ts +26 -0
  44. package/resources/qbd/credit-memos.d.ts.map +1 -1
  45. package/resources/qbd/customers.d.mts +12 -0
  46. package/resources/qbd/customers.d.mts.map +1 -1
  47. package/resources/qbd/customers.d.ts +12 -0
  48. package/resources/qbd/customers.d.ts.map +1 -1
  49. package/resources/qbd/deposits.d.mts +12 -0
  50. package/resources/qbd/deposits.d.mts.map +1 -1
  51. package/resources/qbd/deposits.d.ts +12 -0
  52. package/resources/qbd/deposits.d.ts.map +1 -1
  53. package/resources/qbd/discount-items.d.mts +9 -3
  54. package/resources/qbd/discount-items.d.mts.map +1 -1
  55. package/resources/qbd/discount-items.d.ts +9 -3
  56. package/resources/qbd/discount-items.d.ts.map +1 -1
  57. package/resources/qbd/employees.d.mts +26 -0
  58. package/resources/qbd/employees.d.mts.map +1 -1
  59. package/resources/qbd/employees.d.ts +26 -0
  60. package/resources/qbd/employees.d.ts.map +1 -1
  61. package/resources/qbd/estimates.d.mts +26 -0
  62. package/resources/qbd/estimates.d.mts.map +1 -1
  63. package/resources/qbd/estimates.d.ts +26 -0
  64. package/resources/qbd/estimates.d.ts.map +1 -1
  65. package/resources/qbd/index.d.mts +1 -0
  66. package/resources/qbd/index.d.mts.map +1 -1
  67. package/resources/qbd/index.d.ts +1 -0
  68. package/resources/qbd/index.d.ts.map +1 -1
  69. package/resources/qbd/index.js +4 -2
  70. package/resources/qbd/index.js.map +1 -1
  71. package/resources/qbd/index.mjs +1 -0
  72. package/resources/qbd/index.mjs.map +1 -1
  73. package/resources/qbd/inventory-adjustments.d.mts +4 -0
  74. package/resources/qbd/inventory-adjustments.d.mts.map +1 -1
  75. package/resources/qbd/inventory-adjustments.d.ts +4 -0
  76. package/resources/qbd/inventory-adjustments.d.ts.map +1 -1
  77. package/resources/qbd/inventory-assembly-items.d.mts +8 -5
  78. package/resources/qbd/inventory-assembly-items.d.mts.map +1 -1
  79. package/resources/qbd/inventory-assembly-items.d.ts +8 -5
  80. package/resources/qbd/inventory-assembly-items.d.ts.map +1 -1
  81. package/resources/qbd/inventory-items.d.mts +8 -5
  82. package/resources/qbd/inventory-items.d.mts.map +1 -1
  83. package/resources/qbd/inventory-items.d.ts +8 -5
  84. package/resources/qbd/inventory-items.d.ts.map +1 -1
  85. package/resources/qbd/inventory-sites.d.mts +4 -0
  86. package/resources/qbd/inventory-sites.d.mts.map +1 -1
  87. package/resources/qbd/inventory-sites.d.ts +4 -0
  88. package/resources/qbd/inventory-sites.d.ts.map +1 -1
  89. package/resources/qbd/invoices.d.mts +42 -8
  90. package/resources/qbd/invoices.d.mts.map +1 -1
  91. package/resources/qbd/invoices.d.ts +42 -8
  92. package/resources/qbd/invoices.d.ts.map +1 -1
  93. package/resources/qbd/item-receipts.d.mts +28 -0
  94. package/resources/qbd/item-receipts.d.mts.map +1 -1
  95. package/resources/qbd/item-receipts.d.ts +28 -0
  96. package/resources/qbd/item-receipts.d.ts.map +1 -1
  97. package/resources/qbd/journal-entries.d.mts +13 -0
  98. package/resources/qbd/journal-entries.d.mts.map +1 -1
  99. package/resources/qbd/journal-entries.d.ts +13 -0
  100. package/resources/qbd/journal-entries.d.ts.map +1 -1
  101. package/resources/qbd/other-names.d.mts +12 -0
  102. package/resources/qbd/other-names.d.mts.map +1 -1
  103. package/resources/qbd/other-names.d.ts +12 -0
  104. package/resources/qbd/other-names.d.ts.map +1 -1
  105. package/resources/qbd/payroll-wage-items.d.mts +3 -0
  106. package/resources/qbd/payroll-wage-items.d.mts.map +1 -1
  107. package/resources/qbd/payroll-wage-items.d.ts +3 -0
  108. package/resources/qbd/payroll-wage-items.d.ts.map +1 -1
  109. package/resources/qbd/price-levels.d.mts +18 -18
  110. package/resources/qbd/price-levels.d.mts.map +1 -1
  111. package/resources/qbd/price-levels.d.ts +18 -18
  112. package/resources/qbd/price-levels.d.ts.map +1 -1
  113. package/resources/qbd/purchase-orders.d.mts +26 -0
  114. package/resources/qbd/purchase-orders.d.mts.map +1 -1
  115. package/resources/qbd/purchase-orders.d.ts +26 -0
  116. package/resources/qbd/purchase-orders.d.ts.map +1 -1
  117. package/resources/qbd/qbd.d.mts +4 -0
  118. package/resources/qbd/qbd.d.mts.map +1 -1
  119. package/resources/qbd/qbd.d.ts +4 -0
  120. package/resources/qbd/qbd.d.ts.map +1 -1
  121. package/resources/qbd/qbd.js +4 -0
  122. package/resources/qbd/qbd.js.map +1 -1
  123. package/resources/qbd/qbd.mjs +4 -0
  124. package/resources/qbd/qbd.mjs.map +1 -1
  125. package/resources/qbd/receive-payments.d.mts +40 -12
  126. package/resources/qbd/receive-payments.d.mts.map +1 -1
  127. package/resources/qbd/receive-payments.d.ts +40 -12
  128. package/resources/qbd/receive-payments.d.ts.map +1 -1
  129. package/resources/qbd/receive-payments.js +4 -4
  130. package/resources/qbd/receive-payments.mjs +4 -4
  131. package/resources/qbd/reports.d.mts +1800 -0
  132. package/resources/qbd/reports.d.mts.map +1 -0
  133. package/resources/qbd/reports.d.ts +1800 -0
  134. package/resources/qbd/reports.d.ts.map +1 -0
  135. package/resources/qbd/reports.js +203 -0
  136. package/resources/qbd/reports.js.map +1 -0
  137. package/resources/qbd/reports.mjs +199 -0
  138. package/resources/qbd/reports.mjs.map +1 -0
  139. package/resources/qbd/sales-orders.d.mts +26 -0
  140. package/resources/qbd/sales-orders.d.mts.map +1 -1
  141. package/resources/qbd/sales-orders.d.ts +26 -0
  142. package/resources/qbd/sales-orders.d.ts.map +1 -1
  143. package/resources/qbd/sales-receipts.d.mts +26 -0
  144. package/resources/qbd/sales-receipts.d.mts.map +1 -1
  145. package/resources/qbd/sales-receipts.d.ts +26 -0
  146. package/resources/qbd/sales-receipts.d.ts.map +1 -1
  147. package/resources/qbd/time-tracking-activities.d.mts +6 -0
  148. package/resources/qbd/time-tracking-activities.d.mts.map +1 -1
  149. package/resources/qbd/time-tracking-activities.d.ts +6 -0
  150. package/resources/qbd/time-tracking-activities.d.ts.map +1 -1
  151. package/resources/qbd/transfers.d.mts +6 -0
  152. package/resources/qbd/transfers.d.mts.map +1 -1
  153. package/resources/qbd/transfers.d.ts +6 -0
  154. package/resources/qbd/transfers.d.ts.map +1 -1
  155. package/resources/qbd/vendor-credits.d.mts +28 -0
  156. package/resources/qbd/vendor-credits.d.mts.map +1 -1
  157. package/resources/qbd/vendor-credits.d.ts +28 -0
  158. package/resources/qbd/vendor-credits.d.ts.map +1 -1
  159. package/resources/qbd/vendors.d.mts +16 -0
  160. package/resources/qbd/vendors.d.mts.map +1 -1
  161. package/resources/qbd/vendors.d.ts +16 -0
  162. package/resources/qbd/vendors.d.ts.map +1 -1
  163. package/src/internal/utils/log.ts +2 -0
  164. package/src/resources/qbd/bill-check-payments.ts +33 -8
  165. package/src/resources/qbd/bill-credit-card-payments.ts +15 -4
  166. package/src/resources/qbd/bills.ts +28 -0
  167. package/src/resources/qbd/build-assemblies.ts +4 -0
  168. package/src/resources/qbd/checks.ts +34 -0
  169. package/src/resources/qbd/credit-card-charges.ts +28 -0
  170. package/src/resources/qbd/credit-card-credits.ts +28 -0
  171. package/src/resources/qbd/credit-card-refunds.ts +5 -0
  172. package/src/resources/qbd/credit-memos.ts +26 -0
  173. package/src/resources/qbd/customers.ts +12 -0
  174. package/src/resources/qbd/deposits.ts +12 -0
  175. package/src/resources/qbd/discount-items.ts +9 -3
  176. package/src/resources/qbd/employees.ts +26 -0
  177. package/src/resources/qbd/estimates.ts +26 -0
  178. package/src/resources/qbd/index.ts +14 -0
  179. package/src/resources/qbd/inventory-adjustments.ts +4 -0
  180. package/src/resources/qbd/inventory-assembly-items.ts +8 -5
  181. package/src/resources/qbd/inventory-items.ts +8 -5
  182. package/src/resources/qbd/inventory-sites.ts +4 -0
  183. package/src/resources/qbd/invoices.ts +42 -8
  184. package/src/resources/qbd/item-receipts.ts +28 -0
  185. package/src/resources/qbd/journal-entries.ts +13 -0
  186. package/src/resources/qbd/other-names.ts +12 -0
  187. package/src/resources/qbd/payroll-wage-items.ts +3 -0
  188. package/src/resources/qbd/price-levels.ts +20 -20
  189. package/src/resources/qbd/purchase-orders.ts +26 -0
  190. package/src/resources/qbd/qbd.ts +32 -0
  191. package/src/resources/qbd/receive-payments.ts +40 -12
  192. package/src/resources/qbd/reports.ts +3933 -0
  193. package/src/resources/qbd/sales-orders.ts +26 -0
  194. package/src/resources/qbd/sales-receipts.ts +26 -0
  195. package/src/resources/qbd/time-tracking-activities.ts +6 -0
  196. package/src/resources/qbd/transfers.ts +6 -0
  197. package/src/resources/qbd/vendor-credits.ts +28 -0
  198. package/src/resources/qbd/vendors.ts +16 -0
  199. package/src/version.ts +1 -1
  200. package/version.d.mts +1 -1
  201. package/version.d.ts +1 -1
  202. package/version.js +1 -1
  203. package/version.mjs +1 -1
@@ -752,6 +752,8 @@ export interface BillCreditCardPaymentCreateParams {
752
752
  * QuickBooks. This value is not required to be unique and can be arbitrarily
753
753
  * changed by the QuickBooks user. When left blank in this create request, this
754
754
  * field will be left blank in QuickBooks (i.e., it does _not_ auto-increment).
755
+ *
756
+ * Maximum length: 11 characters.
755
757
  */
756
758
  refNumber?: string;
757
759
  }
@@ -764,9 +766,9 @@ export namespace BillCreditCardPaymentCreateParams {
764
766
  transactionId: string;
765
767
 
766
768
  /**
767
- * Credit memos to apply to this receivable transaction, reducing its balance. This
769
+ * Credits to apply to this receivable transaction, reducing its balance. This
768
770
  * creates a link between this receivable transaction and the specified credit
769
- * memos.
771
+ * transactions.
770
772
  *
771
773
  * **IMPORTANT**: By default, QuickBooks will not return any information about the
772
774
  * linked transactions in this endpoint's response even when this request is
@@ -785,6 +787,9 @@ export namespace BillCreditCardPaymentCreateParams {
785
787
  /**
786
788
  * The monetary amount by which to reduce the receivable transaction's receivable
787
789
  * amount, represented as a decimal string.
790
+ *
791
+ * Decimal string format: exactly 2 decimal places when cents are included and up
792
+ * to 13 digits before the decimal point (for example, "123.45").
788
793
  */
789
794
  discountAmount?: string;
790
795
 
@@ -796,6 +801,9 @@ export namespace BillCreditCardPaymentCreateParams {
796
801
  /**
797
802
  * The monetary amount to apply to the receivable transaction, represented as a
798
803
  * decimal string.
804
+ *
805
+ * Decimal string format: exactly 2 decimal places when cents are included and up
806
+ * to 13 digits before the decimal point (for example, "123.45").
799
807
  */
800
808
  paymentAmount?: string;
801
809
  }
@@ -805,12 +813,15 @@ export namespace BillCreditCardPaymentCreateParams {
805
813
  /**
806
814
  * The amount of credit applied to this transaction. This could include customer
807
815
  * deposits, payments, or credits. Represented as a decimal string.
816
+ *
817
+ * Decimal string format: exactly 2 decimal places when cents are included and up
818
+ * to 13 digits before the decimal point (for example, "123.45").
808
819
  */
809
820
  appliedAmount: string;
810
821
 
811
822
  /**
812
- * The unique identifier of the credit transaction (credit memo or vendor credit)
813
- * to apply to this transaction.
823
+ * The unique identifier of the credit transaction to apply to this transaction,
824
+ * such as a credit memo, vendor credit, or journal-entry credit.
814
825
  */
815
826
  creditTransactionId: string;
816
827
 
@@ -1874,6 +1874,8 @@ export interface BillCreateParams {
1874
1874
  * required to be unique and can be arbitrarily changed by the QuickBooks user.
1875
1875
  * When left blank in this create request, this field will be left blank in
1876
1876
  * QuickBooks (i.e., it does _not_ auto-increment).
1877
+ *
1878
+ * Maximum length: 20 characters.
1877
1879
  */
1878
1880
  refNumber?: string;
1879
1881
 
@@ -1913,6 +1915,9 @@ export namespace BillCreateParams {
1913
1915
 
1914
1916
  /**
1915
1917
  * The monetary amount of this expense line, represented as a decimal string.
1918
+ *
1919
+ * Decimal string format: exactly 2 decimal places when cents are included and up
1920
+ * to 13 digits before the decimal point (for example, "123.45").
1916
1921
  */
1917
1922
  amount?: string;
1918
1923
 
@@ -2069,6 +2074,9 @@ export namespace BillCreateParams {
2069
2074
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2070
2075
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2071
2076
  * suggested `cost`. This field cannot be cleared.
2077
+ *
2078
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2079
+ * to 13 digits before the decimal point (for example, "123.45").
2072
2080
  */
2073
2081
  amount?: string;
2074
2082
 
@@ -2090,6 +2098,9 @@ export namespace BillCreateParams {
2090
2098
  * The cost of this item line, represented as a decimal string. If both `quantity`
2091
2099
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2092
2100
  * `cost`.
2101
+ *
2102
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2103
+ * decimal point (for example, "123.45").
2093
2104
  */
2094
2105
  cost?: string;
2095
2106
 
@@ -2490,6 +2501,8 @@ export interface BillUpdateParams {
2490
2501
  * Body param: The case-sensitive user-defined reference number for this bill,
2491
2502
  * which can be used to identify the transaction in QuickBooks. This value is not
2492
2503
  * required to be unique and can be arbitrarily changed by the QuickBooks user.
2504
+ *
2505
+ * Maximum length: 20 characters.
2493
2506
  */
2494
2507
  refNumber?: string;
2495
2508
 
@@ -2547,6 +2560,9 @@ export namespace BillUpdateParams {
2547
2560
 
2548
2561
  /**
2549
2562
  * The monetary amount of this expense line, represented as a decimal string.
2563
+ *
2564
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2565
+ * to 13 digits before the decimal point (for example, "123.45").
2550
2566
  */
2551
2567
  amount?: string;
2552
2568
 
@@ -2671,6 +2687,9 @@ export namespace BillUpdateParams {
2671
2687
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2672
2688
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2673
2689
  * suggested `cost`. This field cannot be cleared.
2690
+ *
2691
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2692
+ * to 13 digits before the decimal point (for example, "123.45").
2674
2693
  */
2675
2694
  amount?: string;
2676
2695
 
@@ -2692,6 +2711,9 @@ export namespace BillUpdateParams {
2692
2711
  * The cost of this item line, represented as a decimal string. If both `quantity`
2693
2712
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2694
2713
  * `cost`.
2714
+ *
2715
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2716
+ * decimal point (for example, "123.45").
2695
2717
  */
2696
2718
  cost?: string;
2697
2719
 
@@ -2811,6 +2833,9 @@ export namespace BillUpdateParams {
2811
2833
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2812
2834
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2813
2835
  * suggested `cost`. This field cannot be cleared.
2836
+ *
2837
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2838
+ * to 13 digits before the decimal point (for example, "123.45").
2814
2839
  */
2815
2840
  amount?: string;
2816
2841
 
@@ -2832,6 +2857,9 @@ export namespace BillUpdateParams {
2832
2857
  * The cost of this item line, represented as a decimal string. If both `quantity`
2833
2858
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2834
2859
  * `cost`.
2860
+ *
2861
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2862
+ * decimal point (for example, "123.45").
2835
2863
  */
2836
2864
  cost?: string;
2837
2865
 
@@ -600,6 +600,8 @@ export interface BuildAssemblyCreateParams {
600
600
  * value is not required to be unique and can be arbitrarily changed by the
601
601
  * QuickBooks user. When left blank in this create request, this field will be left
602
602
  * blank in QuickBooks (i.e., it does _not_ auto-increment).
603
+ *
604
+ * Maximum length: 11 characters.
603
605
  */
604
606
  refNumber?: string;
605
607
 
@@ -680,6 +682,8 @@ export interface BuildAssemblyUpdateParams {
680
682
  * assembly, which can be used to identify the transaction in QuickBooks. This
681
683
  * value is not required to be unique and can be arbitrarily changed by the
682
684
  * QuickBooks user.
685
+ *
686
+ * Maximum length: 11 characters.
683
687
  */
684
688
  refNumber?: string;
685
689
 
@@ -1816,6 +1816,8 @@ export interface CheckCreateParams {
1816
1816
  * QuickBooks (i.e., it does _not_ auto-increment).
1817
1817
  *
1818
1818
  * **IMPORTANT**: For checks, this field is the check number.
1819
+ *
1820
+ * Maximum length: 11 characters.
1819
1821
  */
1820
1822
  refNumber?: string;
1821
1823
 
@@ -1915,6 +1917,9 @@ export namespace CheckCreateParams {
1915
1917
  /**
1916
1918
  * The monetary amount from this check to apply to the specified transaction,
1917
1919
  * represented as a decimal string.
1920
+ *
1921
+ * Decimal string format: exactly 2 decimal places when cents are included and up
1922
+ * to 13 digits before the decimal point (for example, "123.45").
1918
1923
  */
1919
1924
  amount?: string;
1920
1925
  }
@@ -1930,6 +1935,9 @@ export namespace CheckCreateParams {
1930
1935
 
1931
1936
  /**
1932
1937
  * The monetary amount of this expense line, represented as a decimal string.
1938
+ *
1939
+ * Decimal string format: exactly 2 decimal places when cents are included and up
1940
+ * to 13 digits before the decimal point (for example, "123.45").
1933
1941
  */
1934
1942
  amount?: string;
1935
1943
 
@@ -2086,6 +2094,9 @@ export namespace CheckCreateParams {
2086
2094
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2087
2095
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2088
2096
  * suggested `cost`. This field cannot be cleared.
2097
+ *
2098
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2099
+ * to 13 digits before the decimal point (for example, "123.45").
2089
2100
  */
2090
2101
  amount?: string;
2091
2102
 
@@ -2107,6 +2118,9 @@ export namespace CheckCreateParams {
2107
2118
  * The cost of this item line, represented as a decimal string. If both `quantity`
2108
2119
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2109
2120
  * `cost`.
2121
+ *
2122
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2123
+ * decimal point (for example, "123.45").
2110
2124
  */
2111
2125
  cost?: string;
2112
2126
 
@@ -2456,6 +2470,8 @@ export interface CheckUpdateParams {
2456
2470
  * required to be unique and can be arbitrarily changed by the QuickBooks user.
2457
2471
  *
2458
2472
  * **IMPORTANT**: For checks, this field is the check number.
2473
+ *
2474
+ * Maximum length: 11 characters.
2459
2475
  */
2460
2476
  refNumber?: string;
2461
2477
 
@@ -2560,6 +2576,9 @@ export namespace CheckUpdateParams {
2560
2576
  /**
2561
2577
  * The monetary amount from this check to apply to the specified transaction,
2562
2578
  * represented as a decimal string.
2579
+ *
2580
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2581
+ * to 13 digits before the decimal point (for example, "123.45").
2563
2582
  */
2564
2583
  amount?: string;
2565
2584
  }
@@ -2583,6 +2602,9 @@ export namespace CheckUpdateParams {
2583
2602
 
2584
2603
  /**
2585
2604
  * The monetary amount of this expense line, represented as a decimal string.
2605
+ *
2606
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2607
+ * to 13 digits before the decimal point (for example, "123.45").
2586
2608
  */
2587
2609
  amount?: string;
2588
2610
 
@@ -2707,6 +2729,9 @@ export namespace CheckUpdateParams {
2707
2729
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2708
2730
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2709
2731
  * suggested `cost`. This field cannot be cleared.
2732
+ *
2733
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2734
+ * to 13 digits before the decimal point (for example, "123.45").
2710
2735
  */
2711
2736
  amount?: string;
2712
2737
 
@@ -2728,6 +2753,9 @@ export namespace CheckUpdateParams {
2728
2753
  * The cost of this item line, represented as a decimal string. If both `quantity`
2729
2754
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2730
2755
  * `cost`.
2756
+ *
2757
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2758
+ * decimal point (for example, "123.45").
2731
2759
  */
2732
2760
  cost?: string;
2733
2761
 
@@ -2847,6 +2875,9 @@ export namespace CheckUpdateParams {
2847
2875
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2848
2876
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2849
2877
  * suggested `cost`. This field cannot be cleared.
2878
+ *
2879
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2880
+ * to 13 digits before the decimal point (for example, "123.45").
2850
2881
  */
2851
2882
  amount?: string;
2852
2883
 
@@ -2868,6 +2899,9 @@ export namespace CheckUpdateParams {
2868
2899
  * The cost of this item line, represented as a decimal string. If both `quantity`
2869
2900
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2870
2901
  * `cost`.
2902
+ *
2903
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2904
+ * decimal point (for example, "123.45").
2871
2905
  */
2872
2906
  cost?: string;
2873
2907
 
@@ -1661,6 +1661,8 @@ export interface CreditCardChargeCreateParams {
1661
1661
  * value is not required to be unique and can be arbitrarily changed by the
1662
1662
  * QuickBooks user. When left blank in this create request, this field will be left
1663
1663
  * blank in QuickBooks (i.e., it does _not_ auto-increment).
1664
+ *
1665
+ * Maximum length: 11 characters.
1664
1666
  */
1665
1667
  refNumber?: string;
1666
1668
 
@@ -1690,6 +1692,9 @@ export namespace CreditCardChargeCreateParams {
1690
1692
 
1691
1693
  /**
1692
1694
  * The monetary amount of this expense line, represented as a decimal string.
1695
+ *
1696
+ * Decimal string format: exactly 2 decimal places when cents are included and up
1697
+ * to 13 digits before the decimal point (for example, "123.45").
1693
1698
  */
1694
1699
  amount?: string;
1695
1700
 
@@ -1846,6 +1851,9 @@ export namespace CreditCardChargeCreateParams {
1846
1851
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
1847
1852
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
1848
1853
  * suggested `cost`. This field cannot be cleared.
1854
+ *
1855
+ * Decimal string format: exactly 2 decimal places when cents are included and up
1856
+ * to 13 digits before the decimal point (for example, "123.45").
1849
1857
  */
1850
1858
  amount?: string;
1851
1859
 
@@ -1867,6 +1875,9 @@ export namespace CreditCardChargeCreateParams {
1867
1875
  * The cost of this item line, represented as a decimal string. If both `quantity`
1868
1876
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
1869
1877
  * `cost`.
1878
+ *
1879
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
1880
+ * decimal point (for example, "123.45").
1870
1881
  */
1871
1882
  cost?: string;
1872
1883
 
@@ -2192,6 +2203,8 @@ export interface CreditCardChargeUpdateParams {
2192
2203
  * card charge, which can be used to identify the transaction in QuickBooks. This
2193
2204
  * value is not required to be unique and can be arbitrarily changed by the
2194
2205
  * QuickBooks user.
2206
+ *
2207
+ * Maximum length: 11 characters.
2195
2208
  */
2196
2209
  refNumber?: string;
2197
2210
 
@@ -2235,6 +2248,9 @@ export namespace CreditCardChargeUpdateParams {
2235
2248
 
2236
2249
  /**
2237
2250
  * The monetary amount of this expense line, represented as a decimal string.
2251
+ *
2252
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2253
+ * to 13 digits before the decimal point (for example, "123.45").
2238
2254
  */
2239
2255
  amount?: string;
2240
2256
 
@@ -2359,6 +2375,9 @@ export namespace CreditCardChargeUpdateParams {
2359
2375
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2360
2376
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2361
2377
  * suggested `cost`. This field cannot be cleared.
2378
+ *
2379
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2380
+ * to 13 digits before the decimal point (for example, "123.45").
2362
2381
  */
2363
2382
  amount?: string;
2364
2383
 
@@ -2380,6 +2399,9 @@ export namespace CreditCardChargeUpdateParams {
2380
2399
  * The cost of this item line, represented as a decimal string. If both `quantity`
2381
2400
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2382
2401
  * `cost`.
2402
+ *
2403
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2404
+ * decimal point (for example, "123.45").
2383
2405
  */
2384
2406
  cost?: string;
2385
2407
 
@@ -2499,6 +2521,9 @@ export namespace CreditCardChargeUpdateParams {
2499
2521
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2500
2522
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2501
2523
  * suggested `cost`. This field cannot be cleared.
2524
+ *
2525
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2526
+ * to 13 digits before the decimal point (for example, "123.45").
2502
2527
  */
2503
2528
  amount?: string;
2504
2529
 
@@ -2520,6 +2545,9 @@ export namespace CreditCardChargeUpdateParams {
2520
2545
  * The cost of this item line, represented as a decimal string. If both `quantity`
2521
2546
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2522
2547
  * `cost`.
2548
+ *
2549
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2550
+ * decimal point (for example, "123.45").
2523
2551
  */
2524
2552
  cost?: string;
2525
2553
 
@@ -1657,6 +1657,8 @@ export interface CreditCardCreditCreateParams {
1657
1657
  * value is not required to be unique and can be arbitrarily changed by the
1658
1658
  * QuickBooks user. When left blank in this create request, this field will be left
1659
1659
  * blank in QuickBooks (i.e., it does _not_ auto-increment).
1660
+ *
1661
+ * Maximum length: 11 characters.
1660
1662
  */
1661
1663
  refNumber?: string;
1662
1664
 
@@ -1686,6 +1688,9 @@ export namespace CreditCardCreditCreateParams {
1686
1688
 
1687
1689
  /**
1688
1690
  * The monetary amount of this expense line, represented as a decimal string.
1691
+ *
1692
+ * Decimal string format: exactly 2 decimal places when cents are included and up
1693
+ * to 13 digits before the decimal point (for example, "123.45").
1689
1694
  */
1690
1695
  amount?: string;
1691
1696
 
@@ -1842,6 +1847,9 @@ export namespace CreditCardCreditCreateParams {
1842
1847
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
1843
1848
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
1844
1849
  * suggested `cost`. This field cannot be cleared.
1850
+ *
1851
+ * Decimal string format: exactly 2 decimal places when cents are included and up
1852
+ * to 13 digits before the decimal point (for example, "123.45").
1845
1853
  */
1846
1854
  amount?: string;
1847
1855
 
@@ -1863,6 +1871,9 @@ export namespace CreditCardCreditCreateParams {
1863
1871
  * The cost of this item line, represented as a decimal string. If both `quantity`
1864
1872
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
1865
1873
  * `cost`.
1874
+ *
1875
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
1876
+ * decimal point (for example, "123.45").
1866
1877
  */
1867
1878
  cost?: string;
1868
1879
 
@@ -2188,6 +2199,8 @@ export interface CreditCardCreditUpdateParams {
2188
2199
  * card credit, which can be used to identify the transaction in QuickBooks. This
2189
2200
  * value is not required to be unique and can be arbitrarily changed by the
2190
2201
  * QuickBooks user.
2202
+ *
2203
+ * Maximum length: 11 characters.
2191
2204
  */
2192
2205
  refNumber?: string;
2193
2206
 
@@ -2231,6 +2244,9 @@ export namespace CreditCardCreditUpdateParams {
2231
2244
 
2232
2245
  /**
2233
2246
  * The monetary amount of this expense line, represented as a decimal string.
2247
+ *
2248
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2249
+ * to 13 digits before the decimal point (for example, "123.45").
2234
2250
  */
2235
2251
  amount?: string;
2236
2252
 
@@ -2355,6 +2371,9 @@ export namespace CreditCardCreditUpdateParams {
2355
2371
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2356
2372
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2357
2373
  * suggested `cost`. This field cannot be cleared.
2374
+ *
2375
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2376
+ * to 13 digits before the decimal point (for example, "123.45").
2358
2377
  */
2359
2378
  amount?: string;
2360
2379
 
@@ -2376,6 +2395,9 @@ export namespace CreditCardCreditUpdateParams {
2376
2395
  * The cost of this item line, represented as a decimal string. If both `quantity`
2377
2396
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2378
2397
  * `cost`.
2398
+ *
2399
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2400
+ * decimal point (for example, "123.45").
2379
2401
  */
2380
2402
  cost?: string;
2381
2403
 
@@ -2495,6 +2517,9 @@ export namespace CreditCardCreditUpdateParams {
2495
2517
  * to calculate `amount`. If `amount`, `cost`, and `quantity` are all unspecified,
2496
2518
  * then QuickBooks will calculate `amount` based on a `quantity` of `1` and the
2497
2519
  * suggested `cost`. This field cannot be cleared.
2520
+ *
2521
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2522
+ * to 13 digits before the decimal point (for example, "123.45").
2498
2523
  */
2499
2524
  amount?: string;
2500
2525
 
@@ -2516,6 +2541,9 @@ export namespace CreditCardCreditUpdateParams {
2516
2541
  * The cost of this item line, represented as a decimal string. If both `quantity`
2517
2542
  * and `amount` are specified but not `cost`, QuickBooks will use them to calculate
2518
2543
  * `cost`.
2544
+ *
2545
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2546
+ * decimal point (for example, "123.45").
2519
2547
  */
2520
2548
  cost?: string;
2521
2549
 
@@ -878,6 +878,8 @@ export interface CreditCardRefundCreateParams {
878
878
  * value is not required to be unique and can be arbitrarily changed by the
879
879
  * QuickBooks user. When left blank in this create request, this field will be left
880
880
  * blank in QuickBooks (i.e., it does _not_ auto-increment).
881
+ *
882
+ * Maximum length: 11 characters.
881
883
  */
882
884
  refNumber?: string;
883
885
 
@@ -894,6 +896,9 @@ export namespace CreditCardRefundCreateParams {
894
896
  /**
895
897
  * The monetary amount to refund from the linked credit transaction within this
896
898
  * credit transaction, represented as a decimal string.
899
+ *
900
+ * Decimal string format: exactly 2 decimal places when cents are included and up
901
+ * to 13 digits before the decimal point (for example, "123.45").
897
902
  */
898
903
  refundAmount: string;
899
904
 
@@ -1930,6 +1930,8 @@ export interface CreditMemoCreateParams {
1930
1930
  * not required to be unique and can be arbitrarily changed by the QuickBooks user.
1931
1931
  * When left blank in this create request, this field will be left blank in
1932
1932
  * QuickBooks (i.e., it does _not_ auto-increment).
1933
+ *
1934
+ * Maximum length: 11 characters.
1933
1935
  */
1934
1936
  refNumber?: string;
1935
1937
 
@@ -1964,6 +1966,8 @@ export interface CreditMemoCreateParams {
1964
1966
  * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
1965
1967
  * for this field, which stands for "freight on board". This field is informational
1966
1968
  * and has no accounting implications.
1969
+ *
1970
+ * Maximum length: 13 characters.
1967
1971
  */
1968
1972
  shipmentOrigin?: string;
1969
1973
 
@@ -2148,6 +2152,9 @@ export namespace CreditMemoCreateParams {
2148
2152
  * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
2149
2153
  * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
2150
2154
  * `1` and the suggested `rate`. This field cannot be cleared.
2155
+ *
2156
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2157
+ * to 13 digits before the decimal point (for example, "123.45").
2151
2158
  */
2152
2159
  amount?: string;
2153
2160
 
@@ -2242,6 +2249,9 @@ export namespace CreditMemoCreateParams {
2242
2249
  * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
2243
2250
  * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
2244
2251
  * decimal string. This field cannot be cleared.
2252
+ *
2253
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2254
+ * decimal point (for example, "123.45").
2245
2255
  */
2246
2256
  rate?: string;
2247
2257
 
@@ -2542,6 +2552,8 @@ export interface CreditMemoUpdateParams {
2542
2552
  * Body param: The case-sensitive user-defined reference number for this credit
2543
2553
  * memo, which can be used to identify the transaction in QuickBooks. This value is
2544
2554
  * not required to be unique and can be arbitrarily changed by the QuickBooks user.
2555
+ *
2556
+ * Maximum length: 11 characters.
2545
2557
  */
2546
2558
  refNumber?: string;
2547
2559
 
@@ -2576,6 +2588,8 @@ export interface CreditMemoUpdateParams {
2576
2588
  * goods transfer from seller to buyer. Internally, QuickBooks uses the term "FOB"
2577
2589
  * for this field, which stands for "freight on board". This field is informational
2578
2590
  * and has no accounting implications.
2591
+ *
2592
+ * Maximum length: 13 characters.
2579
2593
  */
2580
2594
  shipmentOrigin?: string;
2581
2595
 
@@ -2760,6 +2774,9 @@ export namespace CreditMemoUpdateParams {
2760
2774
  * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
2761
2775
  * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
2762
2776
  * `1` and the suggested `rate`. This field cannot be cleared.
2777
+ *
2778
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2779
+ * to 13 digits before the decimal point (for example, "123.45").
2763
2780
  */
2764
2781
  amount?: string;
2765
2782
 
@@ -2859,6 +2876,9 @@ export namespace CreditMemoUpdateParams {
2859
2876
  * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
2860
2877
  * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
2861
2878
  * decimal string. This field cannot be cleared.
2879
+ *
2880
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
2881
+ * decimal point (for example, "123.45").
2862
2882
  */
2863
2883
  rate?: string;
2864
2884
 
@@ -2916,6 +2936,9 @@ export namespace CreditMemoUpdateParams {
2916
2936
  * use them to calculate `amount`. If `amount`, `rate`, and `quantity` are all
2917
2937
  * unspecified, then QuickBooks will calculate `amount` based on a `quantity` of
2918
2938
  * `1` and the suggested `rate`. This field cannot be cleared.
2939
+ *
2940
+ * Decimal string format: exactly 2 decimal places when cents are included and up
2941
+ * to 13 digits before the decimal point (for example, "123.45").
2919
2942
  */
2920
2943
  amount?: string;
2921
2944
 
@@ -3015,6 +3038,9 @@ export namespace CreditMemoUpdateParams {
3015
3038
  * specified, `rate` will be ignored. If both `quantity` and `amount` are specified
3016
3039
  * but not `rate`, QuickBooks will use them to calculate `rate`. Represented as a
3017
3040
  * decimal string. This field cannot be cleared.
3041
+ *
3042
+ * Decimal string format: up to 5 decimal places and up to 10 digits before the
3043
+ * decimal point (for example, "123.45").
3018
3044
  */
3019
3045
  rate?: string;
3020
3046
 
@@ -1124,6 +1124,8 @@ export interface CustomerCreateParams {
1124
1124
 
1125
1125
  /**
1126
1126
  * Body param: The customer's alternate telephone number.
1127
+ *
1128
+ * Maximum length: 21 characters.
1127
1129
  */
1128
1130
  alternatePhone?: string;
1129
1131
 
@@ -1211,6 +1213,8 @@ export interface CustomerCreateParams {
1211
1213
 
1212
1214
  /**
1213
1215
  * Body param: The customer's fax number.
1216
+ *
1217
+ * Maximum length: 21 characters.
1214
1218
  */
1215
1219
  fax?: string;
1216
1220
 
@@ -1310,6 +1314,8 @@ export interface CustomerCreateParams {
1310
1314
 
1311
1315
  /**
1312
1316
  * Body param: The customer's primary telephone number.
1317
+ *
1318
+ * Maximum length: 21 characters.
1313
1319
  */
1314
1320
  phone?: string;
1315
1321
 
@@ -1788,6 +1794,8 @@ export interface CustomerUpdateParams {
1788
1794
 
1789
1795
  /**
1790
1796
  * Body param: The customer's alternate telephone number.
1797
+ *
1798
+ * Maximum length: 21 characters.
1791
1799
  */
1792
1800
  alternatePhone?: string;
1793
1801
 
@@ -1865,6 +1873,8 @@ export interface CustomerUpdateParams {
1865
1873
 
1866
1874
  /**
1867
1875
  * Body param: The customer's fax number.
1876
+ *
1877
+ * Maximum length: 21 characters.
1868
1878
  */
1869
1879
  fax?: string;
1870
1880
 
@@ -1964,6 +1974,8 @@ export interface CustomerUpdateParams {
1964
1974
 
1965
1975
  /**
1966
1976
  * Body param: The customer's primary telephone number.
1977
+ *
1978
+ * Maximum length: 21 characters.
1967
1979
  */
1968
1980
  phone?: string;
1969
1981
 
@@ -698,6 +698,9 @@ export namespace DepositCreateParams {
698
698
  /**
699
699
  * The cash-back amount taken out of the deposit and recorded to this deposit
700
700
  * cash-back line's account, represented as a decimal string.
701
+ *
702
+ * Decimal string format: exactly 2 decimal places when cents are included and up
703
+ * to 13 digits before the decimal point (for example, "123.45").
701
704
  */
702
705
  amount?: string;
703
706
 
@@ -718,6 +721,9 @@ export namespace DepositCreateParams {
718
721
  /**
719
722
  * For a manual deposit line, the amount transferred from the line's account into
720
723
  * the deposit's destination account, represented as a decimal string.
724
+ *
725
+ * Decimal string format: exactly 2 decimal places when cents are included and up
726
+ * to 13 digits before the decimal point (for example, "123.45").
721
727
  */
722
728
  amount?: string;
723
729
 
@@ -882,6 +888,9 @@ export namespace DepositUpdateParams {
882
888
  /**
883
889
  * The cash-back amount taken out of the deposit and recorded to this deposit
884
890
  * cash-back line's account, represented as a decimal string.
891
+ *
892
+ * Decimal string format: exactly 2 decimal places when cents are included and up
893
+ * to 13 digits before the decimal point (for example, "123.45").
885
894
  */
886
895
  amount?: string;
887
896
 
@@ -910,6 +919,9 @@ export namespace DepositUpdateParams {
910
919
  /**
911
920
  * For a manual deposit line, the amount transferred from the line's account into
912
921
  * the deposit's destination account, represented as a decimal string.
922
+ *
923
+ * Decimal string format: exactly 2 decimal places when cents are included and up
924
+ * to 13 digits before the decimal point (for example, "123.45").
913
925
  */
914
926
  amount?: string;
915
927