npm - @codat/lending - Versions diffs - 0.1.0 → 1.1.0 - Mend

@codat/lending 0.1.0 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (389) hide show

package/docs/sdks/transactions/README.md CHANGED Viewed

@@ -1,642 +1,4 @@
 # transactions
-## Overview
-Data from a linked accounting platform representing transactions.
 ### Available Operations
-* [downloadDirectCostAttachment](#downloaddirectcostattachment) - Download direct cost attachment
-* [getAccountTransaction](#getaccounttransaction) - Get account transaction
-* [getDirectCost](#getdirectcost) - Get direct cost
-* [getDirectCostAttachment](#getdirectcostattachment) - Get direct cost attachment
-* [getJournal](#getjournal) - Get journal
-* [getJournalEntry](#getjournalentry) - Get journal entry
-* [getTransfer](#gettransfer) - Get transfer
-* [listAccountTransactions](#listaccounttransactions) - List account transactions
-* [listDirectCostAttachments](#listdirectcostattachments) - List direct cost attachments
-* [listDirectCosts](#listdirectcosts) - List direct costs
-* [listJournalEntries](#listjournalentries) - List journal entries
-* [listJournals](#listjournals) - List journals
-* [listTransfers](#listtransfers) - List transfers
-## downloadDirectCostAttachment
-The *Download direct cost attachment* endpoint downloads a specific attachment for a given `directCostId` and `attachmentId`.
-[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support downloading a direct cost attachment.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { DownloadAccountingDirectCostAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.downloadDirectCostAttachment({
-  attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  directCostId: "aut",
-}).then((res: DownloadAccountingDirectCostAttachmentResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                                            | Type                                                                                                                                 | Required                                                                                                                             | Description                                                                                                                          |
-| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                            | [operations.DownloadAccountingDirectCostAttachmentRequest](../../models/operations/downloadaccountingdirectcostattachmentrequest.md) | :heavy_check_mark:                                                                                                                   | The request object to use for the request.                                                                                           |
-| `retries`                                                                                                                            | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                               | :heavy_minus_sign:                                                                                                                   | Configuration to override the default retry behavior of the client.                                                                  |
-| `config`                                                                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                                         | :heavy_minus_sign:                                                                                                                   | Available config options for making requests.                                                                                        |
-### Response
-**Promise<[operations.DownloadAccountingDirectCostAttachmentResponse](../../models/operations/downloadaccountingdirectcostattachmentresponse.md)>**
-## getAccountTransaction
-The *Get account transaction* endpoint returns a single account transaction for a given accountTransactionId.
-[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=accountTransactions) for integrations that support getting a specific account transaction.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetAccountingAccountTransactionResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.getAccountTransaction({
-  accountTransactionId: "quasi",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-}).then((res: GetAccountingAccountTransactionResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                              | Type                                                                                                                   | Required                                                                                                               | Description                                                                                                            |
-| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                              | [operations.GetAccountingAccountTransactionRequest](../../models/operations/getaccountingaccounttransactionrequest.md) | :heavy_check_mark:                                                                                                     | The request object to use for the request.                                                                             |
-| `retries`                                                                                                              | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                 | :heavy_minus_sign:                                                                                                     | Configuration to override the default retry behavior of the client.                                                    |
-| `config`                                                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                           | :heavy_minus_sign:                                                                                                     | Available config options for making requests.                                                                          |
-### Response
-**Promise<[operations.GetAccountingAccountTransactionResponse](../../models/operations/getaccountingaccounttransactionresponse.md)>**
-## getDirectCost
-The *Get direct cost* endpoint returns a single direct cost for a given directCostId.
-[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a specific direct cost.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetAccountingDirectCostResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.getDirectCost({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  directCostId: "error",
-}).then((res: GetAccountingDirectCostResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                              | [operations.GetAccountingDirectCostRequest](../../models/operations/getaccountingdirectcostrequest.md) | :heavy_check_mark:                                                                                     | The request object to use for the request.                                                             |
-| `retries`                                                                                              | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                 | :heavy_minus_sign:                                                                                     | Configuration to override the default retry behavior of the client.                                    |
-| `config`                                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                           | :heavy_minus_sign:                                                                                     | Available config options for making requests.                                                          |
-### Response
-**Promise<[operations.GetAccountingDirectCostResponse](../../models/operations/getaccountingdirectcostresponse.md)>**
-## getDirectCostAttachment
-The *Get direct cost attachment* endpoint returns a specific attachment for a given `directCostId` and `attachmentId`.
-[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support getting a direct cost attachment.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetAccountingDirectCostAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.getDirectCostAttachment({
-  attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  directCostId: "temporibus",
-}).then((res: GetAccountingDirectCostAttachmentResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                                  | Type                                                                                                                       | Required                                                                                                                   | Description                                                                                                                |
-| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                                  | [operations.GetAccountingDirectCostAttachmentRequest](../../models/operations/getaccountingdirectcostattachmentrequest.md) | :heavy_check_mark:                                                                                                         | The request object to use for the request.                                                                                 |
-| `retries`                                                                                                                  | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                     | :heavy_minus_sign:                                                                                                         | Configuration to override the default retry behavior of the client.                                                        |
-| `config`                                                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                               | :heavy_minus_sign:                                                                                                         | Available config options for making requests.                                                                              |
-### Response
-**Promise<[operations.GetAccountingDirectCostAttachmentResponse](../../models/operations/getaccountingdirectcostattachmentresponse.md)>**
-## getJournal
-The *Get journal* endpoint returns a single journal for a given journalId.
-[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journals) for integrations that support getting a specific journal.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetAccountingJournalResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.getJournal({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  journalId: "laborum",
-}).then((res: GetAccountingJournalResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                        | Type                                                                                             | Required                                                                                         | Description                                                                                      |
-| ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------ |
-| `request`                                                                                        | [operations.GetAccountingJournalRequest](../../models/operations/getaccountingjournalrequest.md) | :heavy_check_mark:                                                                               | The request object to use for the request.                                                       |
-| `retries`                                                                                        | [utils.RetryConfig](../../models/utils/retryconfig.md)                                           | :heavy_minus_sign:                                                                               | Configuration to override the default retry behavior of the client.                              |
-| `config`                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                     | :heavy_minus_sign:                                                                               | Available config options for making requests.                                                    |
-### Response
-**Promise<[operations.GetAccountingJournalResponse](../../models/operations/getaccountingjournalresponse.md)>**
-## getJournalEntry
-The *Get journal entry* endpoint returns a single journal entry for a given journalEntryId.
-[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are  made in a company's general ledger, or accounts, when transactions are approved.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=journalEntries) for integrations that support getting a specific journal entry.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetAccountingJournalEntryResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.getJournalEntry({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  journalEntryId: "quasi",
-}).then((res: GetAccountingJournalEntryResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                  | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
-| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                  | [operations.GetAccountingJournalEntryRequest](../../models/operations/getaccountingjournalentryrequest.md) | :heavy_check_mark:                                                                                         | The request object to use for the request.                                                                 |
-| `retries`                                                                                                  | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                     | :heavy_minus_sign:                                                                                         | Configuration to override the default retry behavior of the client.                                        |
-| `config`                                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                               | :heavy_minus_sign:                                                                                         | Available config options for making requests.                                                              |
-### Response
-**Promise<[operations.GetAccountingJournalEntryResponse](../../models/operations/getaccountingjournalentryresponse.md)>**
-## getTransfer
-The *Get transfer* endpoint returns a single transfer for a given transferId.
-[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=transfers) for integrations that support getting a specific transfer.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetAccountingTransferResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.getTransfer({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  transferId: "reiciendis",
-}).then((res: GetAccountingTransferResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `request`                                                                                          | [operations.GetAccountingTransferRequest](../../models/operations/getaccountingtransferrequest.md) | :heavy_check_mark:                                                                                 | The request object to use for the request.                                                         |
-| `retries`                                                                                          | [utils.RetryConfig](../../models/utils/retryconfig.md)                                             | :heavy_minus_sign:                                                                                 | Configuration to override the default retry behavior of the client.                                |
-| `config`                                                                                           | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                       | :heavy_minus_sign:                                                                                 | Available config options for making requests.                                                      |
-### Response
-**Promise<[operations.GetAccountingTransferResponse](../../models/operations/getaccountingtransferresponse.md)>**
-## listAccountTransactions
-The *List account transactions* endpoint returns a list of [account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) for a given company's connection.
-[Account transactions](https://docs.codat.io/accounting-api#/schemas/AccountTransaction) represent bank activity within an accounting platform. All transactions that go through a bank account are recorded as account transactions.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListAccountingAccountTransactionsResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.listAccountTransactions({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "voluptatibus",
-}).then((res: ListAccountingAccountTransactionsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                                  | Type                                                                                                                       | Required                                                                                                                   | Description                                                                                                                |
-| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                                  | [operations.ListAccountingAccountTransactionsRequest](../../models/operations/listaccountingaccounttransactionsrequest.md) | :heavy_check_mark:                                                                                                         | The request object to use for the request.                                                                                 |
-| `retries`                                                                                                                  | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                     | :heavy_minus_sign:                                                                                                         | Configuration to override the default retry behavior of the client.                                                        |
-| `config`                                                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                               | :heavy_minus_sign:                                                                                                         | Available config options for making requests.                                                                              |
-### Response
-**Promise<[operations.ListAccountingAccountTransactionsResponse](../../models/operations/listaccountingaccounttransactionsresponse.md)>**
-## listDirectCostAttachments
-The *List direct cost attachments* endpoint returns a list of attachments available to download for given `directCostId`.
-[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=directCosts) for integrations that support listing direct cost attachments.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListAccountingDirectCostAttachmentsResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.listDirectCostAttachments({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  directCostId: "vero",
-}).then((res: ListAccountingDirectCostAttachmentsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                                      | Type                                                                                                                           | Required                                                                                                                       | Description                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                      | [operations.ListAccountingDirectCostAttachmentsRequest](../../models/operations/listaccountingdirectcostattachmentsrequest.md) | :heavy_check_mark:                                                                                                             | The request object to use for the request.                                                                                     |
-| `retries`                                                                                                                      | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                                         | :heavy_minus_sign:                                                                                                             | Configuration to override the default retry behavior of the client.                                                            |
-| `config`                                                                                                                       | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                                   | :heavy_minus_sign:                                                                                                             | Available config options for making requests.                                                                                  |
-### Response
-**Promise<[operations.ListAccountingDirectCostAttachmentsResponse](../../models/operations/listaccountingdirectcostattachmentsresponse.md)>**
-## listDirectCosts
-The *List direct costs* endpoint returns a list of [direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) for a given company's connection.
-[Direct costs](https://docs.codat.io/accounting-api#/schemas/DirectCost) are purchases of items that are paid off at the point of the purchase.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListAccountingDirectCostsResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.listDirectCosts({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "nihil",
-}).then((res: ListAccountingDirectCostsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                  | Type                                                                                                       | Required                                                                                                   | Description                                                                                                |
-| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                  | [operations.ListAccountingDirectCostsRequest](../../models/operations/listaccountingdirectcostsrequest.md) | :heavy_check_mark:                                                                                         | The request object to use for the request.                                                                 |
-| `retries`                                                                                                  | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                     | :heavy_minus_sign:                                                                                         | Configuration to override the default retry behavior of the client.                                        |
-| `config`                                                                                                   | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                               | :heavy_minus_sign:                                                                                         | Available config options for making requests.                                                              |
-### Response
-**Promise<[operations.ListAccountingDirectCostsResponse](../../models/operations/listaccountingdirectcostsresponse.md)>**
-## listJournalEntries
-The *List journal entries* endpoint returns a list of [journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) for a given company's connection.
-[Journal entries](https://docs.codat.io/accounting-api#/schemas/JournalEntry) are  made in a company's general ledger, or accounts, when transactions are approved.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListAccountingJournalEntriesResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.listJournalEntries({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "praesentium",
-}).then((res: ListAccountingJournalEntriesResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                        | Type                                                                                                             | Required                                                                                                         | Description                                                                                                      |
-| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                        | [operations.ListAccountingJournalEntriesRequest](../../models/operations/listaccountingjournalentriesrequest.md) | :heavy_check_mark:                                                                                               | The request object to use for the request.                                                                       |
-| `retries`                                                                                                        | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                           | :heavy_minus_sign:                                                                                               | Configuration to override the default retry behavior of the client.                                              |
-| `config`                                                                                                         | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                                     | :heavy_minus_sign:                                                                                               | Available config options for making requests.                                                                    |
-### Response
-**Promise<[operations.ListAccountingJournalEntriesResponse](../../models/operations/listaccountingjournalentriesresponse.md)>**
-## listJournals
-The *List journals* endpoint returns a list of [journals](https://docs.codat.io/accounting-api#/schemas/Journal) for a given company's connection.
-[Journals](https://docs.codat.io/accounting-api#/schemas/Journal) are used to record all the financial transactions of a company.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListAccountingJournalsResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.listJournals({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "voluptatibus",
-}).then((res: ListAccountingJournalsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                            | Type                                                                                                 | Required                                                                                             | Description                                                                                          |
-| ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- |
-| `request`                                                                                            | [operations.ListAccountingJournalsRequest](../../models/operations/listaccountingjournalsrequest.md) | :heavy_check_mark:                                                                                   | The request object to use for the request.                                                           |
-| `retries`                                                                                            | [utils.RetryConfig](../../models/utils/retryconfig.md)                                               | :heavy_minus_sign:                                                                                   | Configuration to override the default retry behavior of the client.                                  |
-| `config`                                                                                             | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                         | :heavy_minus_sign:                                                                                   | Available config options for making requests.                                                        |
-### Response
-**Promise<[operations.ListAccountingJournalsResponse](../../models/operations/listaccountingjournalsresponse.md)>**
-## listTransfers
-The *List transfers* endpoint returns a list of [transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) for a given company's connection.
-[Transfers](https://docs.codat.io/accounting-api#/schemas/Transfer) record the movement of money between two bank accounts, or between a bank account and a nominal account.
-Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListAccountingTransfersResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.transactions.listTransfers({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "ipsa",
-}).then((res: ListAccountingTransfersResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                              | [operations.ListAccountingTransfersRequest](../../models/operations/listaccountingtransfersrequest.md) | :heavy_check_mark:                                                                                     | The request object to use for the request.                                                             |
-| `retries`                                                                                              | [utils.RetryConfig](../../models/utils/retryconfig.md)                                                 | :heavy_minus_sign:                                                                                     | Configuration to override the default retry behavior of the client.                                    |
-| `config`                                                                                               | [AxiosRequestConfig](https://axios-http.com/docs/req_config)                                           | :heavy_minus_sign:                                                                                     | Available config options for making requests.                                                          |
-### Response
-**Promise<[operations.ListAccountingTransfersResponse](../../models/operations/listaccountingtransfersresponse.md)>**