@codat/lending 4.2.0 → 4.3.0

package/docs/sdk/models/shared/accountingjournalentry.md

@@ -36,7 +36,7 @@ In Codat a journal entry contains details of:
 | `metadata`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | [shared.Metadata](../../../sdk/models/shared/metadata.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `modifiedDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 2022-10-23 00:00:00 +0000 UTC                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | `postedOn`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          | *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-23 00:00:00 +0000 UTC                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
-| `recordRef`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | [shared.RecordRef](../../../sdk/models/shared/recordref.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Links the current record to the underlying record or data type that created it. <br/><br/>For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
+| `recordRef`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | [shared.JournalEntryRecordRef](../../../sdk/models/shared/journalentryrecordref.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | Links a journal entry to the underlying record that created it.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `sourceModifiedDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | 2022-10-23 00:00:00 +0000 UTC                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
 | `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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
 | `updatedOn`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         | *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-23 00:00:00 +0000 UTC                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

package/docs/sdk/models/shared/accountingjournals.md

@@ -3,10 +3,10 @@
 
 ## Fields
 
-| Field                                                                         | Type                                                                          | Required                                                                      | Description                                                                   |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
-| `links`                                                                       | [shared.Links](../../../sdk/models/shared/links.md)                           | :heavy_check_mark:                                                            | N/A                                                                           |
-| `pageNumber`                                                                  | *number*                                                                      | :heavy_check_mark:                                                            | Current page number.                                                          |
-| `pageSize`                                                                    | *number*                                                                      | :heavy_check_mark:                                                            | Number of items to return in results array.                                   |
-| `results`                                                                     | [shared.AccountingJournal](../../../sdk/models/shared/accountingjournal.md)[] | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `totalResults`                                                                | *number*                                                                      | :heavy_check_mark:                                                            | Total number of items.                                                        |
+| Field                                                                                                                       | Type                                                                                                                        | Required                                                                                                                    | Description                                                                                                                 | Example                                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `links`                                                                                                                     | [shared.Links](../../../sdk/models/shared/links.md)                                                                         | :heavy_check_mark:                                                                                                          | N/A                                                                                                                         | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} |
+| `pageNumber`                                                                                                                | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Current page number.                                                                                                        |                                                                                                                             |
+| `pageSize`                                                                                                                  | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Number of items to return in results array.                                                                                 |                                                                                                                             |
+| `results`                                                                                                                   | [shared.AccountingJournal](../../../sdk/models/shared/accountingjournal.md)[]                                               | :heavy_minus_sign:                                                                                                          | N/A                                                                                                                         |                                                                                                                             |
+| `totalResults`                                                                                                              | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Total number of items.                                                                                                      |                                                                                                                             |

package/docs/sdk/models/shared/accountingpayment.md

@@ -694,7 +694,7 @@ In this example, a payment on account is used to pay the same invoice in January
 | `metadata`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                | [shared.Metadata](../../../sdk/models/shared/metadata.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | `modifiedDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                            | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | 2022-10-23 00:00:00 +0000 UTC                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | `note`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Any additional information associated with the payment.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
-| `paymentMethodRef`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [shared.PaymentMethodRef](../../../sdk/models/shared/paymentmethodref.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | The payment method the record is linked to in the accounting or commerce platform.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
+| `paymentMethodRef`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | [shared.PaymentMethodRef](../../../sdk/models/shared/paymentmethodref.md)                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | The payment method the record is linked to in the accounting or commerce platform.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | {"id":"EILBDVJVNUAGVKRQ","name":"AliPay"}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
 | `reference`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | Friendly reference for the payment.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |
 | `sourceModifiedDate`                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                      | *string*                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | N/A                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       | 2022-10-23 00:00:00 +0000 UTC                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                             |
 | `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.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                           |

package/docs/sdk/models/shared/accountingpayments.md

@@ -3,10 +3,10 @@
 
 ## Fields
 
-| Field                                                                         | Type                                                                          | Required                                                                      | Description                                                                   |
-| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
-| `links`                                                                       | [shared.Links](../../../sdk/models/shared/links.md)                           | :heavy_check_mark:                                                            | N/A                                                                           |
-| `pageNumber`                                                                  | *number*                                                                      | :heavy_check_mark:                                                            | Current page number.                                                          |
-| `pageSize`                                                                    | *number*                                                                      | :heavy_check_mark:                                                            | Number of items to return in results array.                                   |
-| `results`                                                                     | [shared.AccountingPayment](../../../sdk/models/shared/accountingpayment.md)[] | :heavy_minus_sign:                                                            | N/A                                                                           |
-| `totalResults`                                                                | *number*                                                                      | :heavy_check_mark:                                                            | Total number of items.                                                        |
+| Field                                                                                                                       | Type                                                                                                                        | Required                                                                                                                    | Description                                                                                                                 | Example                                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `links`                                                                                                                     | [shared.Links](../../../sdk/models/shared/links.md)                                                                         | :heavy_check_mark:                                                                                                          | N/A                                                                                                                         | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} |
+| `pageNumber`                                                                                                                | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Current page number.                                                                                                        |                                                                                                                             |
+| `pageSize`                                                                                                                  | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Number of items to return in results array.                                                                                 |                                                                                                                             |
+| `results`                                                                                                                   | [shared.AccountingPayment](../../../sdk/models/shared/accountingpayment.md)[]                                               | :heavy_minus_sign:                                                                                                          | N/A                                                                                                                         |                                                                                                                             |
+| `totalResults`                                                                                                              | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Total number of items.                                                                                                      |                                                                                                                             |

package/docs/sdk/models/shared/accountingsuppliers.md

@@ -3,10 +3,10 @@
 
 ## Fields
 
-| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
-| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `links`                                                                         | [shared.Links](../../../sdk/models/shared/links.md)                             | :heavy_check_mark:                                                              | N/A                                                                             |
-| `pageNumber`                                                                    | *number*                                                                        | :heavy_check_mark:                                                              | Current page number.                                                            |
-| `pageSize`                                                                      | *number*                                                                        | :heavy_check_mark:                                                              | Number of items to return in results array.                                     |
-| `results`                                                                       | [shared.AccountingSupplier](../../../sdk/models/shared/accountingsupplier.md)[] | :heavy_minus_sign:                                                              | N/A                                                                             |
-| `totalResults`                                                                  | *number*                                                                        | :heavy_check_mark:                                                              | Total number of items.                                                          |
+| Field                                                                                                                       | Type                                                                                                                        | Required                                                                                                                    | Description                                                                                                                 | Example                                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `links`                                                                                                                     | [shared.Links](../../../sdk/models/shared/links.md)                                                                         | :heavy_check_mark:                                                                                                          | N/A                                                                                                                         | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} |
+| `pageNumber`                                                                                                                | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Current page number.                                                                                                        |                                                                                                                             |
+| `pageSize`                                                                                                                  | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Number of items to return in results array.                                                                                 |                                                                                                                             |
+| `results`                                                                                                                   | [shared.AccountingSupplier](../../../sdk/models/shared/accountingsupplier.md)[]                                             | :heavy_minus_sign:                                                                                                          | N/A                                                                                                                         |                                                                                                                             |
+| `totalResults`                                                                                                              | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Total number of items.                                                                                                      |                                                                                                                             |

package/docs/sdk/models/shared/accountingtransfers.md

@@ -3,10 +3,10 @@
 
 ## Fields
 
-| Field                                                                           | Type                                                                            | Required                                                                        | Description                                                                     |
-| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
-| `links`                                                                         | [shared.Links](../../../sdk/models/shared/links.md)                             | :heavy_check_mark:                                                              | N/A                                                                             |
-| `pageNumber`                                                                    | *number*                                                                        | :heavy_check_mark:                                                              | Current page number.                                                            |
-| `pageSize`                                                                      | *number*                                                                        | :heavy_check_mark:                                                              | Number of items to return in results array.                                     |
-| `results`                                                                       | [shared.AccountingTransfer](../../../sdk/models/shared/accountingtransfer.md)[] | :heavy_minus_sign:                                                              | N/A                                                                             |
-| `totalResults`                                                                  | *number*                                                                        | :heavy_check_mark:                                                              | Total number of items.                                                          |
+| Field                                                                                                                       | Type                                                                                                                        | Required                                                                                                                    | Description                                                                                                                 | Example                                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `links`                                                                                                                     | [shared.Links](../../../sdk/models/shared/links.md)                                                                         | :heavy_check_mark:                                                                                                          | N/A                                                                                                                         | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} |
+| `pageNumber`                                                                                                                | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Current page number.                                                                                                        |                                                                                                                             |
+| `pageSize`                                                                                                                  | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Number of items to return in results array.                                                                                 |                                                                                                                             |
+| `results`                                                                                                                   | [shared.AccountingTransfer](../../../sdk/models/shared/accountingtransfer.md)[]                                             | :heavy_minus_sign:                                                                                                          | N/A                                                                                                                         |                                                                                                                             |
+| `totalResults`                                                                                                              | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Total number of items.                                                                                                      |                                                                                                                             |

package/docs/sdk/models/shared/accounts.md

@@ -11,4 +11,4 @@
 | `currency`                                                                                                                                                                                                                                                                                                                                                                                   | *string*                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                           | The currency data type in Codat is the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code, e.g. _GBP_.<br/><br/>## Unknown currencies<br/><br/>In line with the ISO 4217 specification, the code _XXX_ is used when the data source does not return a currency for a transaction. <br/><br/>There are only a very small number of edge cases where this currency code is returned by the Codat system. | GBP                                                                                                                                                                                                                                                                                                                                                                                          |
 | `currentBalance`                                                                                                                                                                                                                                                                                                                                                                             | *number*                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                           | The balance of the bank account.                                                                                                                                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                                                                                                                                                              |
 | `platformName`                                                                                                                                                                                                                                                                                                                                                                               | *string*                                                                                                                                                                                                                                                                                                                                                                                     | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                           | Name of the banking data source, e.g. "Plaid".                                                                                                                                                                                                                                                                                                                                               |                                                                                                                                                                                                                                                                                                                                                                                              |
-| `sourceRef`                                                                                                                                                                                                                                                                                                                                                                                  | [shared.SourceRef](../../../sdk/models/shared/sourceref.md)                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                           | A source reference containing the `sourceType` object "Banking".                                                                                                                                                                                                                                                                                                                             |                                                                                                                                                                                                                                                                                                                                                                                              |
+| `sourceRef`                                                                                                                                                                                                                                                                                                                                                                                  | [shared.SourceRef](../../../sdk/models/shared/sourceref.md)                                                                                                                                                                                                                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                                                                                                                                                                                                                                           | A source reference containing the `sourceType` object "Banking".                                                                                                                                                                                                                                                                                                                             | {"Example":{"value":{"sourceRef":{"sourceType":"Banking"}}}}                                                                                                                                                                                                                                                                                                                                 |

package/docs/sdk/models/shared/accounttransactionline.md

@@ -3,8 +3,8 @@
 
 ## Fields
 
-| Field                                                                                                                                                                                                                                                   | Type                                                                                                                                                                                                                                                    | Required                                                                                                                                                                                                                                                | Description                                                                                                                                                                                                                                             |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| `amount`                                                                                                                                                                                                                                                | *number*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Amount in the bill payment currency.                                                                                                                                                                                                                    |
-| `description`                                                                                                                                                                                                                                           | *string*                                                                                                                                                                                                                                                | :heavy_minus_sign:                                                                                                                                                                                                                                      | Description of the account transaction.                                                                                                                                                                                                                 |
-| `recordRef`                                                                                                                                                                                                                                             | [shared.RecordRef](../../../sdk/models/shared/recordref.md)                                                                                                                                                                                             | :heavy_minus_sign:                                                                                                                                                                                                                                      | Links the current record to the underlying record or data type that created it. <br/><br/>For example, if a journal entry is generated based on an invoice, this property allows you to connect the journal entry to the underlying invoice in our data model.  |
+| Field                                                                                                   | Type                                                                                                    | Required                                                                                                | Description                                                                                             |
+| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
+| `amount`                                                                                                | *number*                                                                                                | :heavy_minus_sign:                                                                                      | Amount in the bill payment currency.                                                                    |
+| `description`                                                                                           | *string*                                                                                                | :heavy_minus_sign:                                                                                      | Description of the account transaction.                                                                 |
+| `recordRef`                                                                                             | [shared.AccountTransactionLineRecordRef](../../../sdk/models/shared/accounttransactionlinerecordref.md) | :heavy_minus_sign:                                                                                      | Links an account transaction line to the underlying record that created it.                             |

package/docs/sdk/models/shared/accounttransactionlinerecordref.md

@@ -0,0 +1,11 @@
+# AccountTransactionLineRecordRef
+
+Links an account transaction line to the underlying record that created it.
+
+
+## Fields
+
+| Field                                                                                                                   | Type                                                                                                                    | Required                                                                                                                | Description                                                                                                             | Example                                                                                                                 |
+| ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
+| `dataType`                                                                                                              | [shared.AccountTransactionLineRecordRefDataType](../../../sdk/models/shared/accounttransactionlinerecordrefdatatype.md) | :heavy_minus_sign:                                                                                                      | Name of underlying data type.                                                                                           | transfers                                                                                                               |
+| `id`                                                                                                                    | *string*                                                                                                                | :heavy_minus_sign:                                                                                                      | 'id' of the underlying record or data type.                                                                             |                                                                                                                         |

package/docs/sdk/models/shared/accounttransactionlinerecordrefdatatype.md

@@ -0,0 +1,20 @@
+# AccountTransactionLineRecordRefDataType
+
+Name of underlying data type.
+
+
+## Values
+
+| Name               | Value              |
+| ------------------ | ------------------ |
+| `BankTransactions` | bankTransactions   |
+| `BillCreditNotes`  | billCreditNotes    |
+| `BillPayments`     | billPayments       |
+| `Bills`            | bills              |
+| `CreditNotes`      | creditNotes        |
+| `DirectCosts`      | directCosts        |
+| `DirectIncomes`    | directIncomes      |
+| `Invoices`         | invoices           |
+| `JournalEntries`   | journalEntries     |
+| `Payments`         | payments           |
+| `Transfers`        | transfers          |

package/docs/sdk/models/shared/bankingaccountbalances.md

@@ -3,10 +3,10 @@
 
 ## Fields
 
-| Field                                                                                 | Type                                                                                  | Required                                                                              | Description                                                                           |
-| ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
-| `links`                                                                               | [shared.Links](../../../sdk/models/shared/links.md)                                   | :heavy_check_mark:                                                                    | N/A                                                                                   |
-| `pageNumber`                                                                          | *number*                                                                              | :heavy_check_mark:                                                                    | Current page number.                                                                  |
-| `pageSize`                                                                            | *number*                                                                              | :heavy_check_mark:                                                                    | Number of items to return in results array.                                           |
-| `results`                                                                             | [shared.BankingAccountBalance](../../../sdk/models/shared/bankingaccountbalance.md)[] | :heavy_minus_sign:                                                                    | N/A                                                                                   |
-| `totalResults`                                                                        | *number*                                                                              | :heavy_check_mark:                                                                    | Total number of items.                                                                |
+| Field                                                                                                                       | Type                                                                                                                        | Required                                                                                                                    | Description                                                                                                                 | Example                                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| `links`                                                                                                                     | [shared.Links](../../../sdk/models/shared/links.md)                                                                         | :heavy_check_mark:                                                                                                          | N/A                                                                                                                         | {"self":{"href":"/companies/{id}/data/{dataType}"},"current":{"href":"/companies/{id}/data/{dataType}?page=1&pageSize=10"}} |
+| `pageNumber`                                                                                                                | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Current page number.                                                                                                        |                                                                                                                             |
+| `pageSize`                                                                                                                  | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Number of items to return in results array.                                                                                 |                                                                                                                             |
+| `results`                                                                                                                   | [shared.BankingAccountBalance](../../../sdk/models/shared/bankingaccountbalance.md)[]                                       | :heavy_minus_sign:                                                                                                          | N/A                                                                                                                         |                                                                                                                             |
+| `totalResults`                                                                                                              | *number*                                                                                                                    | :heavy_check_mark:                                                                                                          | Total number of items.                                                                                                      |                                                                                                                             |