@codat/lending 4.0.0 → 4.1.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 (118) hide show
  1. package/README.md +10 -1
  2. package/dist/sdk/models/shared/accountingaccounttransaction.d.ts +7 -0
  3. package/dist/sdk/models/shared/accountingattachment.d.ts +2 -1
  4. package/dist/sdk/models/shared/accountingattachment.js +2 -1
  5. package/dist/sdk/models/shared/accountingbill.d.ts +7 -0
  6. package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +7 -0
  7. package/dist/sdk/models/shared/accountingbillpayment.d.ts +7 -0
  8. package/dist/sdk/models/shared/accountingcreditnote.d.ts +7 -0
  9. package/dist/sdk/models/shared/accountingdirectcost.d.ts +7 -0
  10. package/dist/sdk/models/shared/accountingdirectincome.d.ts +7 -0
  11. package/dist/sdk/models/shared/accountinginvoice.d.ts +7 -0
  12. package/dist/sdk/models/shared/accountingpayment.d.ts +7 -0
  13. package/dist/sdk/models/shared/accountingpaymentallocation.d.ts +7 -0
  14. package/dist/sdk/models/shared/billpaymentlinelink.d.ts +7 -0
  15. package/dist/sdk/models/shared/directcostprototype.d.ts +7 -0
  16. package/dist/sdk/models/shared/payment.d.ts +7 -0
  17. package/dist/sdk/models/shared/paymentallocationpayment.d.ts +7 -0
  18. package/dist/sdk/models/shared/paymentlinelink.d.ts +7 -0
  19. package/dist/sdk/sdk.js +3 -3
  20. package/docs/sdk/models/operations/downloadfilesrequest.md +1 -1
  21. package/docs/sdk/models/operations/getaccountingagedcreditorsreportrequest.md +1 -1
  22. package/docs/sdk/models/operations/getaccountingageddebtorsreportrequest.md +1 -1
  23. package/docs/sdk/models/operations/getaccountingbalancesheetrequest.md +1 -1
  24. package/docs/sdk/models/operations/getaccountingcashflowstatementrequest.md +1 -1
  25. package/docs/sdk/models/operations/getaccountingprofitandlossrequest.md +1 -1
  26. package/docs/sdk/models/shared/accountingaccount.md +2 -2
  27. package/docs/sdk/models/shared/accountingaccounttransaction.md +15 -15
  28. package/docs/sdk/models/shared/accountingagedcreditorreport.md +2 -2
  29. package/docs/sdk/models/shared/accountingageddebtorreport.md +2 -2
  30. package/docs/sdk/models/shared/accountingattachment.md +5 -4
  31. package/docs/sdk/models/shared/accountingbalancesheet.md +2 -2
  32. package/docs/sdk/models/shared/accountingbankaccount.md +2 -2
  33. package/docs/sdk/models/shared/accountingbanktransaction.md +3 -3
  34. package/docs/sdk/models/shared/accountingbill.md +23 -23
  35. package/docs/sdk/models/shared/accountingbillcreditnote.md +24 -24
  36. package/docs/sdk/models/shared/accountingbillpayment.md +17 -17
  37. package/docs/sdk/models/shared/accountingcashflowstatement.md +2 -2
  38. package/docs/sdk/models/shared/accountingcompanyinfo.md +3 -3
  39. package/docs/sdk/models/shared/accountingcreateaccountresponse.md +2 -2
  40. package/docs/sdk/models/shared/accountingcreatebankaccountresponse.md +2 -2
  41. package/docs/sdk/models/shared/accountingcreatebanktransactionsresponse.md +2 -2
  42. package/docs/sdk/models/shared/accountingcreatedirectcostresponse.md +2 -2
  43. package/docs/sdk/models/shared/accountingcreatepaymentresponse.md +2 -2
  44. package/docs/sdk/models/shared/accountingcreatesupplierresponse.md +2 -2
  45. package/docs/sdk/models/shared/accountingcreatetransferresponse.md +2 -2
  46. package/docs/sdk/models/shared/accountingcreditnote.md +26 -26
  47. package/docs/sdk/models/shared/accountingcustomer.md +2 -2
  48. package/docs/sdk/models/shared/accountingdirectcost.md +18 -18
  49. package/docs/sdk/models/shared/accountingdirectincome.md +18 -18
  50. package/docs/sdk/models/shared/accountinginvoice.md +28 -28
  51. package/docs/sdk/models/shared/accountingjournal.md +3 -3
  52. package/docs/sdk/models/shared/accountingjournalentry.md +5 -5
  53. package/docs/sdk/models/shared/accountingpayment.md +17 -17
  54. package/docs/sdk/models/shared/accountingprofitandlossreport.md +2 -2
  55. package/docs/sdk/models/shared/accountingsupplier.md +2 -2
  56. package/docs/sdk/models/shared/accountingtransfer.md +3 -3
  57. package/docs/sdk/models/shared/agedoutstandingamount.md +2 -2
  58. package/docs/sdk/models/shared/allocation.md +6 -6
  59. package/docs/sdk/models/shared/balancesheet.md +1 -1
  60. package/docs/sdk/models/shared/bankingaccount.md +2 -2
  61. package/docs/sdk/models/shared/bankingaccountbalance.md +3 -3
  62. package/docs/sdk/models/shared/bankingtransaction.md +4 -4
  63. package/docs/sdk/models/shared/bankingtransactioncategory.md +2 -2
  64. package/docs/sdk/models/shared/bankingtransactionref.md +1 -1
  65. package/docs/sdk/models/shared/billpaymentline.md +1 -1
  66. package/docs/sdk/models/shared/billpaymentlinelink.md +6 -6
  67. package/docs/sdk/models/shared/cashflowstatement.md +2 -2
  68. package/docs/sdk/models/shared/clientratelimitreachedwebhookdata.md +1 -1
  69. package/docs/sdk/models/shared/clientratelimitresetwebhookdata.md +1 -1
  70. package/docs/sdk/models/shared/commercecompanyinfo.md +3 -3
  71. package/docs/sdk/models/shared/commercecustomer.md +3 -3
  72. package/docs/sdk/models/shared/commercedispute.md +4 -4
  73. package/docs/sdk/models/shared/commercelocation.md +2 -2
  74. package/docs/sdk/models/shared/commerceorder.md +4 -4
  75. package/docs/sdk/models/shared/commercepayment.md +4 -4
  76. package/docs/sdk/models/shared/commercepaymentmethod.md +2 -2
  77. package/docs/sdk/models/shared/commerceproductcategory.md +2 -2
  78. package/docs/sdk/models/shared/commercetransaction.md +4 -4
  79. package/docs/sdk/models/shared/company.md +2 -2
  80. package/docs/sdk/models/shared/connection.md +2 -2
  81. package/docs/sdk/models/shared/contact.md +1 -1
  82. package/docs/sdk/models/shared/createbankaccounttransaction.md +1 -1
  83. package/docs/sdk/models/shared/dataconnectionerror.md +1 -1
  84. package/docs/sdk/models/shared/dataintegritydates.md +4 -4
  85. package/docs/sdk/models/shared/dataintegritydetail.md +1 -1
  86. package/docs/sdk/models/shared/dataintegritystatusinfo.md +1 -1
  87. package/docs/sdk/models/shared/datastatus.md +1 -1
  88. package/docs/sdk/models/shared/directcostprototype.md +14 -14
  89. package/docs/sdk/models/shared/enhancedcashflowtransaction.md +1 -1
  90. package/docs/sdk/models/shared/enhancedinvoicereportitem.md +5 -5
  91. package/docs/sdk/models/shared/enhancedreportinfo.md +1 -1
  92. package/docs/sdk/models/shared/excelstatus.md +1 -1
  93. package/docs/sdk/models/shared/file.md +1 -1
  94. package/docs/sdk/models/shared/loansummaryreportinfo.md +1 -1
  95. package/docs/sdk/models/shared/loansummaryreportitem.md +1 -1
  96. package/docs/sdk/models/shared/loantransactionsreportinfo.md +1 -1
  97. package/docs/sdk/models/shared/payment.md +9 -9
  98. package/docs/sdk/models/shared/paymentallocationpayment.md +10 -10
  99. package/docs/sdk/models/shared/paymentline.md +1 -1
  100. package/docs/sdk/models/shared/paymentlinelink.md +6 -6
  101. package/docs/sdk/models/shared/paymentref.md +4 -4
  102. package/docs/sdk/models/shared/productvariant.md +3 -3
  103. package/docs/sdk/models/shared/profitandlossreport.md +2 -2
  104. package/docs/sdk/models/shared/pulloperation.md +2 -2
  105. package/docs/sdk/models/shared/pushoperation.md +2 -2
  106. package/docs/sdk/models/shared/reportitem.md +1 -1
  107. package/docs/sdk/models/shared/reportitems.md +1 -1
  108. package/docs/sdks/balancesheet/README.md +1 -1
  109. package/docs/sdks/bankaccounts/README.md +2 -2
  110. package/docs/sdks/banktransactions/README.md +1 -1
  111. package/docs/sdks/cashflow/README.md +1 -1
  112. package/docs/sdks/codatlendingpayments/README.md +4 -4
  113. package/docs/sdks/codatlendingsuppliers/README.md +2 -2
  114. package/docs/sdks/directcosts/README.md +3 -3
  115. package/docs/sdks/fileupload/README.md +1 -1
  116. package/docs/sdks/profitandloss/README.md +1 -1
  117. package/docs/sdks/transfers/README.md +3 -3
  118. package/package.json +1 -1
package/README.md CHANGED
@@ -616,5 +616,14 @@ run();
616
616
 
617
617
  <!-- Placeholder for Future Speakeasy SDK Sections -->
618
618
 
619
+ <!-- Start Codat Support Notes -->
620
+ ### Support
619
621
 
620
- ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
622
+ If you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance.
623
+ You can raise any issues by contacting your dedicated Codat representative or reaching out to our [support team](mailto:support@codat.io).
624
+ We're here to help ensure a smooth experience for you.
625
+ <!-- End Codat Support Notes -->
626
+
627
+ <!-- Start Codat Generated By -->
628
+ ### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)
629
+ <!-- End Codat Generated By -->
package/dist/sdk/models/shared/accountingaccounttransaction.d.ts CHANGED
@@ -77,6 +77,13 @@ export declare class AccountingAccountTransaction extends SpeakeasyBase {
77
77
  * | **GBP** | £20 | 1.277 | $25.54 |
78
78
  * | **EUR** | €20 | 1.134 | $22.68 |
79
79
  * | **RUB** | ₽20 | 0.015 | $0.30 |
80
+ *
81
+ *
82
+ * ### Integration-specific details
83
+ *
84
+ * | Integration | Scenario | System behavior |
85
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
86
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
80
87
  */
81
88
  currencyRate?: number;
82
89
  /**
package/dist/sdk/models/shared/accountingattachment.d.ts CHANGED
@@ -17,8 +17,9 @@ import { SpeakeasyBase } from "../../../internal/utils";
17
17
  * | Xero | 4 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP |
18
18
  * | QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML |
19
19
  * | NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |
20
+ * | Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state <a className="external" href="https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice" target="_blank">here</a> that "You can attach any type of file, such as text, image, or video files". |
20
21
  *
21
- * View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>.
22
+ * View the coverage for each integration in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting" target="_blank">Data coverage explorer</a>.
22
23
  *
23
24
  */
24
25
  export declare class AccountingAttachment extends SpeakeasyBase {
package/dist/sdk/models/shared/accountingattachment.js CHANGED
@@ -48,8 +48,9 @@ var class_transformer_1 = require("class-transformer");
48
48
  * | Xero | 4 MB | 7Z, BMP, CSV, DOC, DOCX, EML, GIF, JPEG, JPG, KEYNOTE, MSG, NUMBERS, ODF, ODS, ODT, PAGES, PDF, PNG, PPT, PPTX, RAR, RTF, TIF, TIFF, TXT, XLS, XLSX, ZIP |
49
49
  * | QuickBooks Online | 100 MB | AI, CSV, DOC, DOCX, EPS, GIF, JPEG, JPG, ODS, PAGES, PDF, PNG, RTF, TIF, TXT, XLS, XLSX, XML |
50
50
  * | NetSuite | 100 MB | BMP, CSV, XLS, XLSX, JSON, PDF, PJPG, PJPEG, PNG, TXT, SVG, TIF, TIFF, DOC, DOCX, ZIP |
51
+ * | Dynamics 365 Business Central | 350 MB | Dynamics do not explicitly outline which file types are supported but they do state <a className="external" href="https://learn.microsoft.com/en-gb/dynamics365/business-central/ui-how-add-link-to-record#to-attach-a-file-to-a-purchase-invoice" target="_blank">here</a> that "You can attach any type of file, such as text, image, or video files". |
51
52
  *
52
- * View the coverage for accounts in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=chartOfAccounts" target="_blank">Data coverage explorer</a>.
53
+ * View the coverage for each integration in the <a className="external" href="https://knowledge.codat.io/supported-features/accounting" target="_blank">Data coverage explorer</a>.
53
54
  *
54
55
  */
55
56
  var AccountingAttachment = /** @class */ (function (_super) {
package/dist/sdk/models/shared/accountingbill.d.ts CHANGED
@@ -93,6 +93,13 @@ export declare class AccountingBill extends SpeakeasyBase {
93
93
  * | **GBP** | £20 | 1.277 | $25.54 |
94
94
  * | **EUR** | €20 | 1.134 | $22.68 |
95
95
  * | **RUB** | ₽20 | 0.015 | $0.30 |
96
+ *
97
+ *
98
+ * ### Integration-specific details
99
+ *
100
+ * | Integration | Scenario | System behavior |
101
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
102
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
96
103
  */
97
104
  currencyRate?: number;
98
105
  dueDate?: string;
package/dist/sdk/models/shared/accountingbillcreditnote.d.ts CHANGED
@@ -95,6 +95,13 @@ export declare class AccountingBillCreditNote extends SpeakeasyBase {
95
95
  * | **GBP** | £20 | 1.277 | $25.54 |
96
96
  * | **EUR** | €20 | 1.134 | $22.68 |
97
97
  * | **RUB** | ₽20 | 0.015 | $0.30 |
98
+ *
99
+ *
100
+ * ### Integration-specific details
101
+ *
102
+ * | Integration | Scenario | System behavior |
103
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
104
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
98
105
  */
99
106
  currencyRate?: number;
100
107
  /**
package/dist/sdk/models/shared/accountingbillpayment.d.ts CHANGED
@@ -194,6 +194,13 @@ export declare class AccountingBillPayment extends SpeakeasyBase {
194
194
  * | **GBP** | £20 | 1.277 | $25.54 |
195
195
  * | **EUR** | €20 | 1.134 | $22.68 |
196
196
  * | **RUB** | ₽20 | 0.015 | $0.30 |
197
+ *
198
+ *
199
+ * ### Integration-specific details
200
+ *
201
+ * | Integration | Scenario | System behavior |
202
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
203
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
197
204
  */
198
205
  currencyRate?: number;
199
206
  date: string;
package/dist/sdk/models/shared/accountingcreditnote.d.ts CHANGED
@@ -99,6 +99,13 @@ export declare class AccountingCreditNote extends SpeakeasyBase {
99
99
  * | **GBP** | £20 | 1.277 | $25.54 |
100
100
  * | **EUR** | €20 | 1.134 | $22.68 |
101
101
  * | **RUB** | ₽20 | 0.015 | $0.30 |
102
+ *
103
+ *
104
+ * ### Integration-specific details
105
+ *
106
+ * | Integration | Scenario | System behavior |
107
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
108
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
102
109
  */
103
110
  currencyRate?: number;
104
111
  customerRef?: AccountingCustomerRef;
package/dist/sdk/models/shared/accountingdirectcost.d.ts CHANGED
@@ -81,6 +81,13 @@ export declare class AccountingDirectCost extends SpeakeasyBase {
81
81
  * | **GBP** | £20 | 1.277 | $25.54 |
82
82
  * | **EUR** | €20 | 1.134 | $22.68 |
83
83
  * | **RUB** | ₽20 | 0.015 | $0.30 |
84
+ *
85
+ *
86
+ * ### Integration-specific details
87
+ *
88
+ * | Integration | Scenario | System behavior |
89
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
90
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
84
91
  */
85
92
  currencyRate?: number;
86
93
  /**
package/dist/sdk/models/shared/accountingdirectincome.d.ts CHANGED
@@ -69,6 +69,13 @@ export declare class AccountingDirectIncome extends SpeakeasyBase {
69
69
  * | **GBP** | £20 | 1.277 | $25.54 |
70
70
  * | **EUR** | €20 | 1.134 | $22.68 |
71
71
  * | **RUB** | ₽20 | 0.015 | $0.30 |
72
+ *
73
+ *
74
+ * ### Integration-specific details
75
+ *
76
+ * | Integration | Scenario | System behavior |
77
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
78
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
72
79
  */
73
80
  currencyRate?: number;
74
81
  /**
package/dist/sdk/models/shared/accountinginvoice.d.ts CHANGED
@@ -103,6 +103,13 @@ export declare class AccountingInvoice extends SpeakeasyBase {
103
103
  * | **GBP** | £20 | 1.277 | $25.54 |
104
104
  * | **EUR** | €20 | 1.134 | $22.68 |
105
105
  * | **RUB** | ₽20 | 0.015 | $0.30 |
106
+ *
107
+ *
108
+ * ### Integration-specific details
109
+ *
110
+ * | Integration | Scenario | System behavior |
111
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
112
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
106
113
  */
107
114
  currencyRate?: number;
108
115
  customerRef?: AccountingCustomerRef;
package/dist/sdk/models/shared/accountingpayment.d.ts CHANGED
@@ -732,6 +732,13 @@ export declare class AccountingPayment extends SpeakeasyBase {
732
732
  * | **GBP** | £20 | 1.277 | $25.54 |
733
733
  * | **EUR** | €20 | 1.134 | $22.68 |
734
734
  * | **RUB** | ₽20 | 0.015 | $0.30 |
735
+ *
736
+ *
737
+ * ### Integration-specific details
738
+ *
739
+ * | Integration | Scenario | System behavior |
740
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
741
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
735
742
  */
736
743
  currencyRate?: number;
737
744
  customerRef?: AccountingCustomerRef;
package/dist/sdk/models/shared/accountingpaymentallocation.d.ts CHANGED
@@ -65,6 +65,13 @@ export declare class Allocation extends SpeakeasyBase {
65
65
  * | **GBP** | £20 | 1.277 | $25.54 |
66
66
  * | **EUR** | €20 | 1.134 | $22.68 |
67
67
  * | **RUB** | ₽20 | 0.015 | $0.30 |
68
+ *
69
+ *
70
+ * ### Integration-specific details
71
+ *
72
+ * | Integration | Scenario | System behavior |
73
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
74
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
68
75
  */
69
76
  currencyRate?: number;
70
77
  /**
package/dist/sdk/models/shared/billpaymentlinelink.d.ts CHANGED
@@ -38,6 +38,13 @@ export declare class BillPaymentLineLink extends SpeakeasyBase {
38
38
  * | **GBP** | £20 | 1.277 | $25.54 |
39
39
  * | **EUR** | €20 | 1.134 | $22.68 |
40
40
  * | **RUB** | ₽20 | 0.015 | $0.30 |
41
+ *
42
+ *
43
+ * ### Integration-specific details
44
+ *
45
+ * | Integration | Scenario | System behavior |
46
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
47
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
41
48
  */
42
49
  currencyRate?: number;
43
50
  /**
package/dist/sdk/models/shared/directcostprototype.d.ts CHANGED
@@ -61,6 +61,13 @@ export declare class DirectCostPrototype extends SpeakeasyBase {
61
61
  * | **GBP** | £20 | 1.277 | $25.54 |
62
62
  * | **EUR** | €20 | 1.134 | $22.68 |
63
63
  * | **RUB** | ₽20 | 0.015 | $0.30 |
64
+ *
65
+ *
66
+ * ### Integration-specific details
67
+ *
68
+ * | Integration | Scenario | System behavior |
69
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
70
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
64
71
  */
65
72
  currencyRate?: number;
66
73
  /**
package/dist/sdk/models/shared/payment.d.ts CHANGED
@@ -46,6 +46,13 @@ export declare class Payment extends SpeakeasyBase {
46
46
  * | **GBP** | £20 | 1.277 | $25.54 |
47
47
  * | **EUR** | €20 | 1.134 | $22.68 |
48
48
  * | **RUB** | ₽20 | 0.015 | $0.30 |
49
+ *
50
+ *
51
+ * ### Integration-specific details
52
+ *
53
+ * | Integration | Scenario | System behavior |
54
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
55
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
49
56
  */
50
57
  currencyRate?: number;
51
58
  /**
package/dist/sdk/models/shared/paymentallocationpayment.d.ts CHANGED
@@ -45,6 +45,13 @@ export declare class PaymentAllocationPayment extends SpeakeasyBase {
45
45
  * | **GBP** | £20 | 1.277 | $25.54 |
46
46
  * | **EUR** | €20 | 1.134 | $22.68 |
47
47
  * | **RUB** | ₽20 | 0.015 | $0.30 |
48
+ *
49
+ *
50
+ * ### Integration-specific details
51
+ *
52
+ * | Integration | Scenario | System behavior |
53
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
54
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
48
55
  */
49
56
  currencyRate?: number;
50
57
  /**
package/dist/sdk/models/shared/paymentlinelink.d.ts CHANGED
@@ -37,6 +37,13 @@ export declare class PaymentLineLink extends SpeakeasyBase {
37
37
  * | **GBP** | £20 | 1.277 | $25.54 |
38
38
  * | **EUR** | €20 | 1.134 | $22.68 |
39
39
  * | **RUB** | ₽20 | 0.015 | $0.30 |
40
+ *
41
+ *
42
+ * ### Integration-specific details
43
+ *
44
+ * | Integration | Scenario | System behavior |
45
+ * |-------------------|-------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|
46
+ * | QuickBooks Online | Transaction currency differs from base currency | If currency rate value is left `null`, a rate of 1 will be used by QBO by default. To override this, include the required currency rate in the expense transaction. |
40
47
  */
41
48
  currencyRate?: number;
42
49
  /**
package/dist/sdk/sdk.js CHANGED
@@ -37,9 +37,9 @@ var SDKConfiguration = /** @class */ (function () {
37
37
  function SDKConfiguration(init) {
38
38
  this.language = "typescript";
39
39
  this.openapiDocVersion = "3.0.0";
40
- this.sdkVersion = "4.0.0";
41
- this.genVersion = "2.210.3";
42
- this.userAgent = "speakeasy-sdk/typescript 4.0.0 2.210.3 3.0.0 @codat/lending";
40
+ this.sdkVersion = "4.1.0";
41
+ this.genVersion = "2.214.3";
42
+ this.userAgent = "speakeasy-sdk/typescript 4.1.0 2.214.3 3.0.0 @codat/lending";
43
43
  Object.assign(this, init);
44
44
  }
45
45
  return SDKConfiguration;
package/docs/sdk/models/operations/downloadfilesrequest.md CHANGED
@@ -6,4 +6,4 @@
6
6
  | Field | Type | Required | Description | Example |
7
7
  | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ | ------------------------------------------ |
8
8
  | `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9
- | `date` | *string* | :heavy_minus_sign: | Only download files uploaded on this date. | 2022-10-23T00:00:00.000Z |
9
+ | `date` | *string* | :heavy_minus_sign: | Only download files uploaded on this date. | 2022-10-23 00:00:00 +0000 UTC |
package/docs/sdk/models/operations/getaccountingagedcreditorsreportrequest.md CHANGED
@@ -8,4 +8,4 @@
8
8
  | `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9
9
  | `numberOfPeriods` | *number* | :heavy_minus_sign: | Number of periods to include in the report. | 12 |
10
10
  | `periodLengthDays` | *number* | :heavy_minus_sign: | The length of period in days. | 30 |
11
- | `reportDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | Date the report is generated up to. | 2022-12-31 |
11
+ | `reportDate` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | Date the report is generated up to. | 2022-12-31 |
package/docs/sdk/models/operations/getaccountingageddebtorsreportrequest.md CHANGED
@@ -8,4 +8,4 @@
8
8
  | `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9
9
  | `numberOfPeriods` | *number* | :heavy_minus_sign: | Number of periods to include in the report. | 12 |
10
10
  | `periodLengthDays` | *number* | :heavy_minus_sign: | The length of period in days. | 30 |
11
- | `reportDate` | [RFCDate](../../types/rfcdate.md) | :heavy_minus_sign: | Date the report is generated up to. | 2022-12-31 |
11
+ | `reportDate` | [RFCDate](../../../types/rfcdate.md) | :heavy_minus_sign: | Date the report is generated up to. | 2022-12-31 |
package/docs/sdk/models/operations/getaccountingbalancesheetrequest.md CHANGED
@@ -8,4 +8,4 @@
8
8
  | `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9
9
  | `periodLength` | *number* | :heavy_check_mark: | Number of months defining the period of interest. | 4 |
10
10
  | `periodsToCompare` | *number* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 |
11
- | `startMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00.000Z |
11
+ | `startMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23 00:00:00 +0000 UTC |
package/docs/sdk/models/operations/getaccountingcashflowstatementrequest.md CHANGED
@@ -8,4 +8,4 @@
8
8
  | `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9
9
  | `periodLength` | *number* | :heavy_check_mark: | Number of months defining the period of interest. | 4 |
10
10
  | `periodsToCompare` | *number* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 |
11
- | `startMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00.000Z |
11
+ | `startMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23 00:00:00 +0000 UTC |
package/docs/sdk/models/operations/getaccountingprofitandlossrequest.md CHANGED
@@ -8,4 +8,4 @@
8
8
  | `companyId` | *string* | :heavy_check_mark: | Unique identifier for a company. | 8a210b68-6988-11ed-a1eb-0242ac120002 |
9
9
  | `periodLength` | *number* | :heavy_check_mark: | Number of months defining the period of interest. | 4 |
10
10
  | `periodsToCompare` | *number* | :heavy_check_mark: | Number of periods with `periodLength` to compare. | 20 |
11
- | `startMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23T00:00:00.000Z |
11
+ | `startMonth` | *string* | :heavy_minus_sign: | The month the report starts from. | 2022-10-23 00:00:00 +0000 UTC |
package/docs/sdk/models/shared/accountingaccount.md CHANGED
@@ -42,10 +42,10 @@ To determine the list of allowed categories for a specific integration, you can:
42
42
  | `id` | *string* | :heavy_minus_sign: | Identifier for the account, unique for the company. | 1b6266d1-1e44-46c5-8eb5-a8f98e03124e |
43
43
  | `isBankAccount` | *boolean* | :heavy_minus_sign: | Confirms whether the account is a bank account or not. | |
44
44
  | `metadata` | [shared.Metadata](../../../sdk/models/shared/metadata.md) | :heavy_minus_sign: | N/A | |
45
- | `modifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z |
45
+ | `modifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC |
46
46
  | `name` | *string* | :heavy_minus_sign: | Name of the account. | Accounts Receivable |
47
47
  | `nominalCode` | *string* | :heavy_minus_sign: | Reference given to each nominal account for a business. It ensures money is allocated to the correct account. This code isn't a unique identifier in the Codat system. | 610 |
48
- | `sourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z |
48
+ | `sourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC |
49
49
  | `status` | [shared.AccountStatus](../../../sdk/models/shared/accountstatus.md) | :heavy_minus_sign: | Status of the account | Active |
50
50
  | `supplementalData` | [shared.SupplementalData](../../../sdk/models/shared/supplementaldata.md) | :heavy_minus_sign: | Supplemental data is additional data you can include in our standard data types. <br/><br/>It is referenced as a configured dynamic key value pair that is unique to the accounting platform. [Learn more](https://docs.codat.io/using-the-api/supplemental-data/overview) about supplemental data. | |
51
51
  | `type` | [shared.AccountType](../../../sdk/models/shared/accounttype.md) | :heavy_minus_sign: | Type of account | Asset |