@codat/lending 4.0.0 → 4.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 (130) hide show
  1. package/README.md +10 -1
  2. package/dist/sdk/fileupload.js +1 -1
  3. package/dist/sdk/models/operations/uploadfiles.d.ts +1 -5
  4. package/dist/sdk/models/operations/uploadfiles.js +4 -22
  5. package/dist/sdk/models/shared/accountingaccounttransaction.d.ts +7 -0
  6. package/dist/sdk/models/shared/accountingattachment.d.ts +2 -1
  7. package/dist/sdk/models/shared/accountingattachment.js +2 -1
  8. package/dist/sdk/models/shared/accountingbill.d.ts +7 -0
  9. package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +7 -0
  10. package/dist/sdk/models/shared/accountingbillpayment.d.ts +7 -0
  11. package/dist/sdk/models/shared/accountingcreditnote.d.ts +7 -0
  12. package/dist/sdk/models/shared/accountingdirectcost.d.ts +7 -0
  13. package/dist/sdk/models/shared/accountingdirectincome.d.ts +7 -0
  14. package/dist/sdk/models/shared/accountinginvoice.d.ts +7 -0
  15. package/dist/sdk/models/shared/accountingpayment.d.ts +7 -0
  16. package/dist/sdk/models/shared/accountingpaymentallocation.d.ts +7 -0
  17. package/dist/sdk/models/shared/billpaymentlinelink.d.ts +7 -0
  18. package/dist/sdk/models/shared/codatfile.d.ts +5 -0
  19. package/dist/sdk/models/shared/codatfile.js +47 -0
  20. package/dist/sdk/models/shared/directcostprototype.d.ts +7 -0
  21. package/dist/sdk/models/shared/fileupload.d.ts +8 -0
  22. package/dist/sdk/models/shared/fileupload.js +44 -0
  23. package/dist/sdk/models/shared/index.d.ts +2 -0
  24. package/dist/sdk/models/shared/index.js +2 -0
  25. package/dist/sdk/models/shared/payment.d.ts +7 -0
  26. package/dist/sdk/models/shared/paymentallocationpayment.d.ts +7 -0
  27. package/dist/sdk/models/shared/paymentlinelink.d.ts +7 -0
  28. package/dist/sdk/sdk.js +3 -3
  29. package/docs/sdk/models/operations/downloadfilesrequest.md +1 -1
  30. package/docs/sdk/models/operations/getaccountingagedcreditorsreportrequest.md +1 -1
  31. package/docs/sdk/models/operations/getaccountingageddebtorsreportrequest.md +1 -1
  32. package/docs/sdk/models/operations/getaccountingbalancesheetrequest.md +1 -1
  33. package/docs/sdk/models/operations/getaccountingcashflowstatementrequest.md +1 -1
  34. package/docs/sdk/models/operations/getaccountingprofitandlossrequest.md +1 -1
  35. package/docs/sdk/models/operations/uploadfilesrequest.md +5 -5
  36. package/docs/sdk/models/shared/accountingaccount.md +2 -2
  37. package/docs/sdk/models/shared/accountingaccounttransaction.md +15 -15
  38. package/docs/sdk/models/shared/accountingagedcreditorreport.md +2 -2
  39. package/docs/sdk/models/shared/accountingageddebtorreport.md +2 -2
  40. package/docs/sdk/models/shared/accountingattachment.md +5 -4
  41. package/docs/sdk/models/shared/accountingbalancesheet.md +2 -2
  42. package/docs/sdk/models/shared/accountingbankaccount.md +2 -2
  43. package/docs/sdk/models/shared/accountingbanktransaction.md +3 -3
  44. package/docs/sdk/models/shared/accountingbill.md +23 -23
  45. package/docs/sdk/models/shared/accountingbillcreditnote.md +24 -24
  46. package/docs/sdk/models/shared/accountingbillpayment.md +17 -17
  47. package/docs/sdk/models/shared/accountingcashflowstatement.md +2 -2
  48. package/docs/sdk/models/shared/accountingcompanyinfo.md +3 -3
  49. package/docs/sdk/models/shared/accountingcreateaccountresponse.md +2 -2
  50. package/docs/sdk/models/shared/accountingcreatebankaccountresponse.md +2 -2
  51. package/docs/sdk/models/shared/accountingcreatebanktransactionsresponse.md +2 -2
  52. package/docs/sdk/models/shared/accountingcreatedirectcostresponse.md +2 -2
  53. package/docs/sdk/models/shared/accountingcreatepaymentresponse.md +2 -2
  54. package/docs/sdk/models/shared/accountingcreatesupplierresponse.md +2 -2
  55. package/docs/sdk/models/shared/accountingcreatetransferresponse.md +2 -2
  56. package/docs/sdk/models/shared/accountingcreditnote.md +26 -26
  57. package/docs/sdk/models/shared/accountingcustomer.md +2 -2
  58. package/docs/sdk/models/shared/accountingdirectcost.md +18 -18
  59. package/docs/sdk/models/shared/accountingdirectincome.md +18 -18
  60. package/docs/sdk/models/shared/accountinginvoice.md +28 -28
  61. package/docs/sdk/models/shared/accountingjournal.md +3 -3
  62. package/docs/sdk/models/shared/accountingjournalentry.md +5 -5
  63. package/docs/sdk/models/shared/accountingpayment.md +17 -17
  64. package/docs/sdk/models/shared/accountingprofitandlossreport.md +2 -2
  65. package/docs/sdk/models/shared/accountingsupplier.md +2 -2
  66. package/docs/sdk/models/shared/accountingtransfer.md +3 -3
  67. package/docs/sdk/models/shared/agedoutstandingamount.md +2 -2
  68. package/docs/sdk/models/shared/allocation.md +6 -6
  69. package/docs/sdk/models/shared/balancesheet.md +1 -1
  70. package/docs/sdk/models/shared/bankingaccount.md +2 -2
  71. package/docs/sdk/models/shared/bankingaccountbalance.md +3 -3
  72. package/docs/sdk/models/shared/bankingtransaction.md +4 -4
  73. package/docs/sdk/models/shared/bankingtransactioncategory.md +2 -2
  74. package/docs/sdk/models/shared/bankingtransactionref.md +1 -1
  75. package/docs/sdk/models/shared/billpaymentline.md +1 -1
  76. package/docs/sdk/models/shared/billpaymentlinelink.md +6 -6
  77. package/docs/sdk/models/shared/cashflowstatement.md +2 -2
  78. package/docs/sdk/models/shared/clientratelimitreachedwebhookdata.md +1 -1
  79. package/docs/sdk/models/shared/clientratelimitresetwebhookdata.md +1 -1
  80. package/docs/sdk/models/{operations/uploadfilesrequestbody.md → shared/codatfile.md} +1 -1
  81. package/docs/sdk/models/shared/commercecompanyinfo.md +3 -3
  82. package/docs/sdk/models/shared/commercecustomer.md +3 -3
  83. package/docs/sdk/models/shared/commercedispute.md +4 -4
  84. package/docs/sdk/models/shared/commercelocation.md +2 -2
  85. package/docs/sdk/models/shared/commerceorder.md +4 -4
  86. package/docs/sdk/models/shared/commercepayment.md +4 -4
  87. package/docs/sdk/models/shared/commercepaymentmethod.md +2 -2
  88. package/docs/sdk/models/shared/commerceproductcategory.md +2 -2
  89. package/docs/sdk/models/shared/commercetransaction.md +4 -4
  90. package/docs/sdk/models/shared/company.md +2 -2
  91. package/docs/sdk/models/shared/connection.md +2 -2
  92. package/docs/sdk/models/shared/contact.md +1 -1
  93. package/docs/sdk/models/shared/createbankaccounttransaction.md +1 -1
  94. package/docs/sdk/models/shared/dataconnectionerror.md +1 -1
  95. package/docs/sdk/models/shared/dataintegritydates.md +4 -4
  96. package/docs/sdk/models/shared/dataintegritydetail.md +1 -1
  97. package/docs/sdk/models/shared/dataintegritystatusinfo.md +1 -1
  98. package/docs/sdk/models/shared/datastatus.md +1 -1
  99. package/docs/sdk/models/shared/directcostprototype.md +14 -14
  100. package/docs/sdk/models/shared/enhancedcashflowtransaction.md +1 -1
  101. package/docs/sdk/models/shared/enhancedinvoicereportitem.md +5 -5
  102. package/docs/sdk/models/shared/enhancedreportinfo.md +1 -1
  103. package/docs/sdk/models/shared/excelstatus.md +1 -1
  104. package/docs/sdk/models/shared/file.md +1 -1
  105. package/docs/sdk/models/shared/fileupload.md +8 -0
  106. package/docs/sdk/models/shared/loansummaryreportinfo.md +1 -1
  107. package/docs/sdk/models/shared/loansummaryreportitem.md +1 -1
  108. package/docs/sdk/models/shared/loantransactionsreportinfo.md +1 -1
  109. package/docs/sdk/models/shared/payment.md +9 -9
  110. package/docs/sdk/models/shared/paymentallocationpayment.md +10 -10
  111. package/docs/sdk/models/shared/paymentline.md +1 -1
  112. package/docs/sdk/models/shared/paymentlinelink.md +6 -6
  113. package/docs/sdk/models/shared/paymentref.md +4 -4
  114. package/docs/sdk/models/shared/productvariant.md +3 -3
  115. package/docs/sdk/models/shared/profitandlossreport.md +2 -2
  116. package/docs/sdk/models/shared/pulloperation.md +2 -2
  117. package/docs/sdk/models/shared/pushoperation.md +2 -2
  118. package/docs/sdk/models/shared/reportitem.md +1 -1
  119. package/docs/sdk/models/shared/reportitems.md +1 -1
  120. package/docs/sdks/balancesheet/README.md +1 -1
  121. package/docs/sdks/bankaccounts/README.md +2 -2
  122. package/docs/sdks/banktransactions/README.md +1 -1
  123. package/docs/sdks/cashflow/README.md +1 -1
  124. package/docs/sdks/codatlendingpayments/README.md +4 -4
  125. package/docs/sdks/codatlendingsuppliers/README.md +2 -2
  126. package/docs/sdks/directcosts/README.md +3 -3
  127. package/docs/sdks/fileupload/README.md +6 -4
  128. package/docs/sdks/profitandloss/README.md +1 -1
  129. package/docs/sdks/transfers/README.md +3 -3
  130. package/package.json +1 -1
package/docs/sdk/models/shared/accountingbillpayment.md CHANGED
@@ -155,20 +155,20 @@ These two rates allow the calculation of currency loss or gain for any of the tr
155
155
 
156
156
  ## Fields
157
157
 
158
- | Field | Type | Required | Description | Example |
159
- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
160
- | `accountRef` | [shared.AccountRef](../../../sdk/models/shared/accountref.md) | :heavy_minus_sign: | Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. | |
161
- | `currency` | *string* | :heavy_minus_sign: | N/A | GBP |
162
- | `currencyRate` | *number* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.<br/><br/>Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. <br/><br/>It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.<br/><br/>Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). <br/><br/>For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.<br/><br/>## Examples with base currency of GBP<br/><br/>\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|<br/>\| :--------------- \| :------------- \| :------------ \| :------------------------- \|<br/>\| **USD** \| $20 \| 0.781 \| £15.62 \|<br/>\| **EUR** \| €20 \| 0.885 \| £17.70 \|<br/>\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|<br/><br/>## Examples with base currency of USD<br/><br/>\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|<br/>\| :--------------- \| :------------- \| :------------ \| :------------------------- \|<br/>\| **GBP** \| £20 \| 1.277 \| $25.54 \|<br/>\| **EUR** \| €20 \| 1.134 \| $22.68 \|<br/>\| **RUB** \| ₽20 \| 0.015 \| $0.30 \| | |
163
- | `date` | *string* | :heavy_check_mark: | N/A | 2022-10-23T00:00:00.000Z |
164
- | `id` | *string* | :heavy_minus_sign: | Identifier for the bill payment, unique for the company in the accounting platform. | 3d5a8e00-d108-4045-8823-7f342676cffa |
165
- | `lines` | [shared.BillPaymentLine](../../../sdk/models/shared/billpaymentline.md)[] | :heavy_minus_sign: | An array of bill payment lines. | |
166
- | `metadata` | [shared.Metadata](../../../sdk/models/shared/metadata.md) | :heavy_minus_sign: | N/A | |
167
- | `modifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z |
168
- | `note` | *string* | :heavy_minus_sign: | Additional information associated with the payment. | Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 |
169
- | `paymentMethodRef` | [shared.PaymentMethodRef](../../../sdk/models/shared/paymentmethodref.md) | :heavy_minus_sign: | N/A | |
170
- | `reference` | *string* | :heavy_minus_sign: | Additional information associated with the payment. | |
171
- | `sourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z |
172
- | `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. | |
173
- | `supplierRef` | [shared.SupplierRef](../../../sdk/models/shared/supplierref.md) | :heavy_minus_sign: | N/A | |
174
- | `totalAmount` | *number* | :heavy_minus_sign: | Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. | 1329.54 |
158
+ | Field | Type | Required | Description | Example |
159
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
160
+ | `accountRef` | [shared.AccountRef](../../../sdk/models/shared/accountref.md) | :heavy_minus_sign: | Data types that reference an account, for example bill and invoice line items, use an accountRef that includes the ID and name of the linked account. | |
161
+ | `currency` | *string* | :heavy_minus_sign: | N/A | GBP |
162
+ | `currencyRate` | *number* | :heavy_minus_sign: | Rate to convert the total amount of the payment into the base currency for the company at the time of the payment.<br/><br/>Currency rates in Codat are implemented as the multiple of foreign currency units to each base currency unit. <br/><br/>It is not possible to perform the currency conversion with two or more non-base currencies participating in the transaction. For example, if a company's base currency is USD, and it has a bill issued in EUR, then the bill payment must happen in USD or EUR.<br/><br/>Where the currency rate is provided by the underlying accounting platform, it will be available from Codat with the same precision (up to a maximum of 9 decimal places). <br/><br/>For accounting platforms which do not provide an explicit currency rate, it is calculated as `baseCurrency / foreignCurrency` and will be returned to 9 decimal places.<br/><br/>## Examples with base currency of GBP<br/><br/>\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (GBP) \|<br/>\| :--------------- \| :------------- \| :------------ \| :------------------------- \|<br/>\| **USD** \| $20 \| 0.781 \| £15.62 \|<br/>\| **EUR** \| €20 \| 0.885 \| £17.70 \|<br/>\| **RUB** \| ₽20 \| 0.011 \| £0.22 \|<br/><br/>## Examples with base currency of USD<br/><br/>\| Foreign Currency \| Foreign Amount \| Currency Rate \| Base Currency Amount (USD) \|<br/>\| :--------------- \| :------------- \| :------------ \| :------------------------- \|<br/>\| **GBP** \| £20 \| 1.277 \| $25.54 \|<br/>\| **EUR** \| €20 \| 1.134 \| $22.68 \|<br/>\| **RUB** \| ₽20 \| 0.015 \| $0.30 \|<br/><br/><br/>### Integration-specific details<br/><br/>\| Integration \| Scenario \| System behavior \|<br/>\|-------------------\|-------------------------------------------------\|----------------------------------------------------------------------------------------------------------------------------------------------------------------------\|<br/>\| 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. \| | |
163
+ | `date` | *string* | :heavy_check_mark: | N/A | 2022-10-23 00:00:00 +0000 UTC |
164
+ | `id` | *string* | :heavy_minus_sign: | Identifier for the bill payment, unique for the company in the accounting platform. | 3d5a8e00-d108-4045-8823-7f342676cffa |
165
+ | `lines` | [shared.BillPaymentLine](../../../sdk/models/shared/billpaymentline.md)[] | :heavy_minus_sign: | An array of bill payment lines. | |
166
+ | `metadata` | [shared.Metadata](../../../sdk/models/shared/metadata.md) | :heavy_minus_sign: | N/A | |
167
+ | `modifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC |
168
+ | `note` | *string* | :heavy_minus_sign: | Additional information associated with the payment. | Bill Payment against bill c13e37b6-dfaa-4894-b3be-9fe97bda9f44 |
169
+ | `paymentMethodRef` | [shared.PaymentMethodRef](../../../sdk/models/shared/paymentmethodref.md) | :heavy_minus_sign: | N/A | |
170
+ | `reference` | *string* | :heavy_minus_sign: | Additional information associated with the payment. | |
171
+ | `sourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23 00:00:00 +0000 UTC |
172
+ | `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. | |
173
+ | `supplierRef` | [shared.SupplierRef](../../../sdk/models/shared/supplierref.md) | :heavy_minus_sign: | N/A | |
174
+ | `totalAmount` | *number* | :heavy_minus_sign: | Amount of the payment in the payment currency. This value never changes and represents the amount of money that is paid into the supplier's account. | 1329.54 |