@codat/lending 1.2.0 → 3.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 (122) hide show
  1. package/README.md +57 -59
  2. package/dist/sdk/accountspayable.d.ts +0 -34
  3. package/dist/sdk/accountspayable.js +1 -260
  4. package/dist/sdk/accountspayablebills.d.ts +28 -0
  5. package/dist/sdk/accountspayablebills.js +183 -1
  6. package/dist/sdk/models/shared/accountcategoriesupdatedwebhook.d.ts +40 -0
  7. package/dist/sdk/models/shared/accountcategoriesupdatedwebhook.js +90 -0
  8. package/dist/sdk/models/shared/accountcategoriesupdatedwebhookdata.d.ts +7 -0
  9. package/dist/sdk/models/shared/accountcategoriesupdatedwebhookdata.js +45 -0
  10. package/dist/sdk/models/shared/{addressesitems.d.ts → accountingaddress.d.ts} +1 -1
  11. package/dist/sdk/models/shared/{addressesitems.js → accountingaddress.js} +13 -13
  12. package/dist/sdk/models/shared/accountingbillcreditnote.d.ts +2 -2
  13. package/dist/sdk/models/shared/accountingbillcreditnote.js +3 -3
  14. package/dist/sdk/models/shared/accountingcompanyinfo.d.ts +6 -66
  15. package/dist/sdk/models/shared/accountingcompanyinfo.js +10 -100
  16. package/dist/sdk/models/shared/accountingcreditnote.d.ts +2 -2
  17. package/dist/sdk/models/shared/accountingcreditnote.js +3 -3
  18. package/dist/sdk/models/shared/accountingcustomer.d.ts +2 -2
  19. package/dist/sdk/models/shared/accountingcustomer.js +3 -3
  20. package/dist/sdk/models/shared/accountinginvoice.d.ts +2 -2
  21. package/dist/sdk/models/shared/accountinginvoice.js +3 -3
  22. package/dist/sdk/models/shared/accountingsupplier.d.ts +2 -2
  23. package/dist/sdk/models/shared/accountingsupplier.js +3 -3
  24. package/dist/sdk/models/shared/clientratelimitreachedwebhook.d.ts +32 -0
  25. package/dist/sdk/models/shared/clientratelimitreachedwebhook.js +80 -0
  26. package/dist/sdk/models/shared/clientratelimitreachedwebhookdata.d.ts +31 -0
  27. package/dist/sdk/models/shared/clientratelimitreachedwebhookdata.js +50 -0
  28. package/dist/sdk/models/shared/clientratelimitresetwebhook.d.ts +32 -0
  29. package/dist/sdk/models/shared/clientratelimitresetwebhook.js +80 -0
  30. package/dist/sdk/models/shared/clientratelimitresetwebhookdata.d.ts +39 -0
  31. package/dist/sdk/models/shared/clientratelimitresetwebhookdata.js +60 -0
  32. package/dist/sdk/models/shared/commercecompanyinfo.d.ts +4 -4
  33. package/dist/sdk/models/shared/commercecompanyinfo.js +6 -6
  34. package/dist/sdk/models/shared/contact.d.ts +4 -4
  35. package/dist/sdk/models/shared/contact.js +6 -6
  36. package/dist/sdk/models/shared/index.d.ts +9 -3
  37. package/dist/sdk/models/shared/index.js +9 -3
  38. package/dist/sdk/models/shared/items.d.ts +2 -9
  39. package/dist/sdk/models/shared/items.js +5 -6
  40. package/dist/sdk/models/shared/phonenumber.d.ts +12 -0
  41. package/dist/sdk/models/shared/{withholdingtaxitems.js → phonenumber.js} +12 -11
  42. package/dist/sdk/models/shared/{weblinksitems.d.ts → weblink.d.ts} +3 -3
  43. package/dist/sdk/models/shared/{weblinksitems.js → weblink.js} +14 -14
  44. package/dist/sdk/models/webhooks/accountcategoriesupdated.d.ts +7 -0
  45. package/dist/sdk/models/webhooks/accountcategoriesupdated.js +51 -0
  46. package/dist/sdk/models/webhooks/clientratelimitreached.d.ts +7 -0
  47. package/dist/sdk/models/webhooks/clientratelimitreached.js +51 -0
  48. package/dist/sdk/models/webhooks/clientratelimitreset.d.ts +7 -0
  49. package/dist/sdk/models/webhooks/clientratelimitreset.js +51 -0
  50. package/dist/sdk/models/webhooks/index.d.ts +3 -0
  51. package/dist/sdk/models/webhooks/index.js +22 -0
  52. package/dist/sdk/sdk.d.ts +1 -4
  53. package/dist/sdk/sdk.js +3 -3
  54. package/docs/models/shared/accountcategoriesupdatedwebhook.md +18 -0
  55. package/docs/models/shared/accountcategoriesupdatedwebhookdata.md +8 -0
  56. package/docs/models/shared/{addressesitems.md → accountingaddress.md} +1 -1
  57. package/docs/models/shared/accountingbillcreditnote.md +1 -1
  58. package/docs/models/shared/accountingcompanyinfo.md +3 -3
  59. package/docs/models/shared/accountingcreditnote.md +1 -1
  60. package/docs/models/shared/accountingcustomer.md +1 -1
  61. package/docs/models/shared/accountinginvoice.md +1 -1
  62. package/docs/models/shared/accountingsupplier.md +1 -1
  63. package/docs/models/shared/clientratelimitreachedwebhook.md +16 -0
  64. package/docs/models/shared/clientratelimitreachedwebhookdata.md +9 -0
  65. package/docs/models/shared/clientratelimitresetwebhook.md +16 -0
  66. package/docs/models/shared/clientratelimitresetwebhookdata.md +11 -0
  67. package/docs/models/shared/commercecompanyinfo.md +2 -2
  68. package/docs/models/shared/contact.md +2 -2
  69. package/docs/models/shared/items.md +4 -4
  70. package/docs/models/shared/{accountingcompanyinfophone.md → phonenumber.md} +1 -1
  71. package/docs/models/shared/weblink.md +11 -0
  72. package/docs/models/shared/{itemstype.md → weblinktype.md} +1 -1
  73. package/docs/models/webhooks/accountcategoriesupdatedresponse.md +10 -0
  74. package/docs/models/webhooks/clientratelimitreachedresponse.md +10 -0
  75. package/docs/models/webhooks/clientratelimitresetresponse.md +10 -0
  76. package/docs/sdks/accountingbankdata/README.md +1 -1
  77. package/docs/sdks/accountingbankdataaccounts/README.md +3 -3
  78. package/docs/sdks/accountspayable/README.md +1 -101
  79. package/docs/sdks/accountspayablebillcreditnotes/README.md +5 -5
  80. package/docs/sdks/accountspayablebillpayments/README.md +5 -5
  81. package/docs/sdks/accountspayablebills/README.md +103 -7
  82. package/docs/sdks/accountspayablesuppliers/README.md +11 -11
  83. package/docs/sdks/accountsreceivable/README.md +1 -1
  84. package/docs/sdks/accountsreceivablecreditnotes/README.md +3 -3
  85. package/docs/sdks/accountsreceivablecustomers/README.md +6 -6
  86. package/docs/sdks/accountsreceivabledirectincomes/README.md +6 -6
  87. package/docs/sdks/accountsreceivableinvoices/README.md +8 -8
  88. package/docs/sdks/accountsreceivablepayments/README.md +3 -3
  89. package/docs/sdks/accountsreceivablereports/README.md +5 -5
  90. package/docs/sdks/banking/README.md +1 -1
  91. package/docs/sdks/bankingaccountbalances/README.md +2 -2
  92. package/docs/sdks/bankingcategorizedstatement/README.md +2 -2
  93. package/docs/sdks/bankingtransactioncategories/README.md +3 -3
  94. package/docs/sdks/companies/README.md +2 -2
  95. package/docs/sdks/companyinfo/README.md +1 -1
  96. package/docs/sdks/connections/README.md +4 -4
  97. package/docs/sdks/dataintegrity/README.md +3 -3
  98. package/docs/sdks/excelreports/README.md +4 -4
  99. package/docs/sdks/fileupload/README.md +3 -3
  100. package/docs/sdks/financialstatements/README.md +1 -1
  101. package/docs/sdks/financialstatementsaccounts/README.md +3 -3
  102. package/docs/sdks/financialstatementsbalancesheet/README.md +3 -3
  103. package/docs/sdks/financialstatementscashflow/README.md +2 -2
  104. package/docs/sdks/financialstatementsprofitandloss/README.md +3 -3
  105. package/docs/sdks/liabilities/README.md +2 -2
  106. package/docs/sdks/managedata/README.md +1 -1
  107. package/docs/sdks/managedatapulloperations/README.md +3 -3
  108. package/docs/sdks/managedatarefresh/README.md +3 -3
  109. package/docs/sdks/sales/README.md +1 -1
  110. package/docs/sdks/salespaymentmethods/README.md +3 -3
  111. package/docs/sdks/salesproductcategories/README.md +3 -3
  112. package/docs/sdks/transactions/README.md +1 -1
  113. package/docs/sdks/transactionsaccounttransactions/README.md +3 -3
  114. package/docs/sdks/transactionsdirectcosts/README.md +6 -6
  115. package/docs/sdks/transactionsjournalentries/README.md +3 -3
  116. package/package.json +1 -1
  117. package/dist/sdk/models/shared/withholdingtaxitems.d.ts +0 -5
  118. package/docs/models/shared/accountingcompanyinfoaccountingaddress.md +0 -14
  119. package/docs/models/shared/accountingcompanyinfoweblink.md +0 -11
  120. package/docs/models/shared/accountingcompanyinfoweblinktype.md +0 -12
  121. package/docs/models/shared/weblinksitems.md +0 -11
  122. package/docs/models/shared/withholdingtaxitems.md +0 -9
package/docs/models/shared/accountinginvoice.md CHANGED
@@ -60,4 +60,4 @@ In Codat, an invoice contains details of:
60
60
  | `totalAmount` | *number* | :heavy_check_mark: | Amount of the invoice, inclusive of tax. | |
61
61
  | `totalDiscount` | *number* | :heavy_minus_sign: | Numerical value of discounts applied to the invoice. | |
62
62
  | `totalTaxAmount` | *number* | :heavy_check_mark: | Amount of tax on the invoice. | |
63
- | `withholdingTax` | [WithholdingTaxitems](../../models/shared/withholdingtaxitems.md)[] | :heavy_minus_sign: | N/A | |
63
+ | `withholdingTax` | [Items](../../models/shared/items.md)[] | :heavy_minus_sign: | N/A | |
package/docs/models/shared/accountingsupplier.md CHANGED
@@ -11,7 +11,7 @@ From the **Suppliers** endpoints, you can retrieve a list of [all the suppliers
11
11
 
12
12
  | Field | Type | Required | Description | Example |
13
13
  | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
14
- | `addresses` | [Addressesitems](../../models/shared/addressesitems.md)[] | :heavy_minus_sign: | An array of Addresses. | |
14
+ | `addresses` | [AccountingAddress](../../models/shared/accountingaddress.md)[] | :heavy_minus_sign: | An array of Addresses. | |
15
15
  | `contactName` | *string* | :heavy_minus_sign: | Name of the main contact for the supplier. | |
16
16
  | `defaultCurrency` | *string* | :heavy_minus_sign: | Default currency the supplier's transactional data is recorded in. | |
17
17
  | `emailAddress` | *string* | :heavy_minus_sign: | Email address that the supplier may be contacted on. | |
package/docs/models/shared/clientratelimitreachedwebhook.md ADDED
@@ -0,0 +1,16 @@
1
+ # ClientRateLimitReachedWebhook
2
+
3
+ Webhook request body for a client that has reached their rate limit.
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
10
+ | `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. |
11
+ | `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. |
12
+ | `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. |
13
+ | `data` | [ClientRateLimitReachedWebhookData](../../models/shared/clientratelimitreachedwebhookdata.md) | :heavy_minus_sign: | N/A |
14
+ | `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. |
15
+ | `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. |
16
+ | `ruleType` | *string* | :heavy_minus_sign: | The type of rule. |
package/docs/models/shared/clientratelimitreachedwebhookdata.md ADDED
@@ -0,0 +1,9 @@
1
+ # ClientRateLimitReachedWebhookData
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `dailyQuota` | *number* | :heavy_minus_sign: | The number of available requests per day. | |
9
+ | `expiresUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
package/docs/models/shared/clientratelimitresetwebhook.md ADDED
@@ -0,0 +1,16 @@
1
+ # ClientRateLimitResetWebhook
2
+
3
+ Webhook request body for a client that has had their rate limit reset.
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
10
+ | `alertId` | *string* | :heavy_minus_sign: | Unique identifier of the webhook event. |
11
+ | `clientId` | *string* | :heavy_minus_sign: | Unique identifier for your client in Codat. |
12
+ | `clientName` | *string* | :heavy_minus_sign: | Name of your client in Codat. |
13
+ | `data` | [ClientRateLimitResetWebhookData](../../models/shared/clientratelimitresetwebhookdata.md) | :heavy_minus_sign: | N/A |
14
+ | `message` | *string* | :heavy_minus_sign: | A human readable message about the webhook. |
15
+ | `ruleId` | *string* | :heavy_minus_sign: | Unique identifier for the rule. |
16
+ | `ruleType` | *string* | :heavy_minus_sign: | The type of rule. |
package/docs/models/shared/clientratelimitresetwebhookdata.md ADDED
@@ -0,0 +1,11 @@
1
+ # ClientRateLimitResetWebhookData
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description | Example |
7
+ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
+ | `dailyQuota` | *number* | :heavy_minus_sign: | The number of available requests per day. | |
9
+ | `expiresUtc` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
10
+ | `quotaRemaining` | *number* | :heavy_minus_sign: | Total number of request remaining for your client. | |
11
+ | `resetReason` | *string* | :heavy_minus_sign: | The reason for your rate limit quota being reset. | |
package/docs/models/shared/commercecompanyinfo.md CHANGED
@@ -19,8 +19,8 @@ Explore our [data coverage](https://knowledge.codat.io/supported-features/commer
19
19
  | `companyName` | *string* | :heavy_minus_sign: | The name of the company | Codat |
20
20
  | `createdDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
21
21
  | `modifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z |
22
- | `phoneNumbers` | [Items](../../models/shared/items.md)[] | :heavy_minus_sign: | Phone numbers associated with the company | |
22
+ | `phoneNumbers` | [PhoneNumber](../../models/shared/phonenumber.md)[] | :heavy_minus_sign: | Phone numbers associated with the company | |
23
23
  | `registrationNumber` | *string* | :heavy_minus_sign: | The registration number of the company | 10480375 |
24
24
  | `sourceModifiedDate` | *string* | :heavy_minus_sign: | N/A | 2022-10-23T00:00:00.000Z |
25
25
  | `sourceUrls` | Record<string, *string*> | :heavy_minus_sign: | URL addresses for the originating system. For example, potential use cases include 'deeplinking' to the originating system | |
26
- | `webLinks` | [WebLinksitems](../../models/shared/weblinksitems.md)[] | :heavy_minus_sign: | Weblinks associated with the company | |
26
+ | `webLinks` | [WebLink](../../models/shared/weblink.md)[] | :heavy_minus_sign: | Weblinks associated with the company | |
package/docs/models/shared/contact.md CHANGED
@@ -5,9 +5,9 @@
5
5
 
6
6
  | Field | Type | Required | Description | Example |
7
7
  | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
8
- | `address` | [Addressesitems](../../models/shared/addressesitems.md) | :heavy_minus_sign: | N/A | |
8
+ | `address` | [AccountingAddress](../../models/shared/accountingaddress.md) | :heavy_minus_sign: | N/A | |
9
9
  | `email` | *string* | :heavy_minus_sign: | Email of a contact for a customer. | |
10
10
  | `modifiedDate` | *string* | :heavy_minus_sign: | In Codat's data model, dates and times are represented using the <a class="external" href="https://en.wikipedia.org/wiki/ISO_8601" target="_blank">ISO 8601 standard</a>. Date and time fields are formatted as strings; for example:<br/><br/>```<br/>2020-10-08T22:40:50Z<br/>2021-01-01T00:00:00<br/>```<br/><br/><br/><br/>When syncing data that contains `DateTime` fields from Codat, make sure you support the following cases when reading time information:<br/><br/>- Coordinated Universal Time (UTC): `2021-11-15T06:00:00Z`<br/>- Unqualified local time: `2021-11-15T01:00:00`<br/>- UTC time offsets: `2021-11-15T01:00:00-05:00`<br/><br/>> Time zones<br/>> <br/>> Not all dates from Codat will contain information about time zones. <br/>> Where it is not available from the underlying platform, Codat will return these as times local to the business whose data has been synced. | 2022-10-23T00:00:00.000Z |
11
11
  | `name` | *string* | :heavy_minus_sign: | Name of a contact for a customer. | |
12
- | `phone` | [Items](../../models/shared/items.md)[] | :heavy_minus_sign: | An array of Phone numbers. | |
12
+ | `phone` | [PhoneNumber](../../models/shared/phonenumber.md)[] | :heavy_minus_sign: | An array of Phone numbers. | |
13
13
  | `status` | [CustomerStatus](../../models/shared/customerstatus.md) | :heavy_check_mark: | Status of customer. | |
package/docs/models/shared/items.md CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Fields
5
5
 
6
- | Field | Type | Required | Description | Example |
7
- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- | --------------------------------------------------------- |
8
- | `number` | *string* | :heavy_check_mark: | A phone number. | +44 25691 154789 |
9
- | `type` | [PhoneNumberType](../../models/shared/phonenumbertype.md) | :heavy_check_mark: | The type of phone number | |
6
+ | Field | Type | Required | Description |
7
+ | ------------------ | ------------------ | ------------------ | ------------------ |
8
+ | `amount` | *number* | :heavy_check_mark: | N/A |
9
+ | `name` | *string* | :heavy_check_mark: | N/A |
package/docs/models/shared/{accountingcompanyinfophone.md → phonenumber.md} RENAMED
@@ -1,4 +1,4 @@
1
- # AccountingCompanyInfoPhone
1
+ # PhoneNumber
2
2
 
3
3
 
4
4
  ## Fields
package/docs/models/shared/weblink.md ADDED
@@ -0,0 +1,11 @@
1
+ # WebLink
2
+
3
+ Weblink associated with the company.
4
+
5
+
6
+ ## Fields
7
+
8
+ | Field | Type | Required | Description |
9
+ | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- |
10
+ | `type` | [WebLinkType](../../models/shared/weblinktype.md) | :heavy_minus_sign: | The type of the weblink. |
11
+ | `url` | *string* | :heavy_minus_sign: | The full URL for the weblink. |
package/docs/models/shared/{itemstype.md → weblinktype.md} RENAMED
@@ -1,4 +1,4 @@
1
- # ItemsType
1
+ # WebLinkType
2
2
 
3
3
  The type of the weblink.
4
4
 
package/docs/models/webhooks/accountcategoriesupdatedresponse.md ADDED
@@ -0,0 +1,10 @@
1
+ # AccountCategoriesUpdatedResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | N/A |
9
+ | `statusCode` | *number* | :heavy_check_mark: | N/A |
10
+ | `rawResponse` | [AxiosResponse>](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | N/A |
package/docs/models/webhooks/clientratelimitreachedresponse.md ADDED
@@ -0,0 +1,10 @@
1
+ # ClientRateLimitReachedResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | N/A |
9
+ | `statusCode` | *number* | :heavy_check_mark: | N/A |
10
+ | `rawResponse` | [AxiosResponse>](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | N/A |
package/docs/models/webhooks/clientratelimitresetresponse.md ADDED
@@ -0,0 +1,10 @@
1
+ # ClientRateLimitResetResponse
2
+
3
+
4
+ ## Fields
5
+
6
+ | Field | Type | Required | Description |
7
+ | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- |
8
+ | `contentType` | *string* | :heavy_check_mark: | N/A |
9
+ | `statusCode` | *number* | :heavy_check_mark: | N/A |
10
+ | `rawResponse` | [AxiosResponse>](https://axios-http.com/docs/res_schema) | :heavy_minus_sign: | N/A |
package/docs/sdks/accountingbankdata/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # accountingBankData
1
+ # AccountingBankData
2
2
 
3
3
  ## Overview
4
4