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

@codat/lending 0.1.0 → 1.2.0

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

Files changed (389) hide show

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

@@ -7,21 +7,7 @@ Data from a linked accounting platform representing money the business owes mone
 ### Available Operations
 * [downloadBillAttachment](#downloadbillattachment) - Download bill attachment
-* [downloadSupplierAttachment](#downloadsupplierattachment) - Download supplier attachment
-* [getAgedCreditorsReport](#getagedcreditorsreport) - Aged creditors report
-* [getBill](#getbill) - Get bill
 * [getBillAttachment](#getbillattachment) - Get bill attachment
-* [getBillCreditNote](#getbillcreditnote) - Get bill credit note
-* [getBillPayment](#getbillpayment) - Get bill payment
-* [getSupplier](#getsupplier) - Get supplier
-* [getSupplierAttachment](#getsupplierattachment) - Get supplier attachment
-* [isAgedCreditorsReportAvailable](#isagedcreditorsreportavailable) - Aged creditors report available
-* [listBillAttachments](#listbillattachments) - List bill attachments
-* [listBillCreditNotes](#listbillcreditnotes) - List bill credit notes
-* [listBillPayments](#listbillpayments) - List bill payments
-* [listBills](#listbills) - List bills
-* [listSupplierAttachments](#listsupplierattachments) - List supplier attachments
-* [listSuppliers](#listsuppliers) - List suppliers
 ## downloadBillAttachment
@@ -46,7 +32,7 @@ const sdk = new CodatLending({
 sdk.accountsPayable.downloadBillAttachment({
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  billId: "nulla",
+  billId: "corrupti",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
 }).then((res: DownloadAccountingBillAttachmentResponse) => {
@@ -70,143 +56,6 @@ sdk.accountsPayable.downloadBillAttachment({
 **Promise<[operations.DownloadAccountingBillAttachmentResponse](../../models/operations/downloadaccountingbillattachmentresponse.md)>**
-## downloadSupplierAttachment
-The *Download supplier attachment* endpoint downloads a specific attachment for a given `supplierId` and `attachmentId`.
-[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support downloading a supplier attachment.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { DownloadAccountingSupplierAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.downloadSupplierAttachment({
-  attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  supplierId: "corrupti",
-}).then((res: DownloadAccountingSupplierAttachmentResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                                        | Type                                                                                                                             | Required                                                                                                                         | Description                                                                                                                      |
-| -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                                        | [operations.DownloadAccountingSupplierAttachmentRequest](../../models/operations/downloadaccountingsupplierattachmentrequest.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.DownloadAccountingSupplierAttachmentResponse](../../models/operations/downloadaccountingsupplierattachmentresponse.md)>**
-## getAgedCreditorsReport
-Returns aged creditors report for company that shows the total balance owed by a business to its suppliers over time.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetAccountingAgedCreditorsReportResponse } from "@codat/lending/dist/sdk/models/operations";
-import { RFCDate } from "@codat/lending/dist/sdk/types";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.getAgedCreditorsReport({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  numberOfPeriods: 12,
-  periodLengthDays: 30,
-  reportDate: new RFCDate("2022-12-31"),
-}).then((res: GetAccountingAgedCreditorsReportResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                                | Type                                                                                                                     | Required                                                                                                                 | Description                                                                                                              |
-| ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                | [operations.GetAccountingAgedCreditorsReportRequest](../../models/operations/getaccountingagedcreditorsreportrequest.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.GetAccountingAgedCreditorsReportResponse](../../models/operations/getaccountingagedcreditorsreportresponse.md)>**
-## getBill
-The *Get bill* endpoint returns a single bill for a given billId.
-[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support getting a specific bill.
-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 { GetAccountingBillResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.getBill({
-  billId: "illum",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-}).then((res: GetAccountingBillResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                  | Type                                                                                       | Required                                                                                   | Description                                                                                |
-| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
-| `request`                                                                                  | [operations.GetAccountingBillRequest](../../models/operations/getaccountingbillrequest.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.GetAccountingBillResponse](../../models/operations/getaccountingbillresponse.md)>**
 ## getBillAttachment
 The *Get bill attachment* endpoint returns a specific attachment for a given `billId` and `attachmentId`.
@@ -230,7 +79,7 @@ const sdk = new CodatLending({
 sdk.accountsPayable.getBillAttachment({
   attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  billId: "vel",
+  billId: "illum",
   companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
   connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
 }).then((res: GetAccountingBillAttachmentResponse) => {
@@ -253,514 +102,3 @@ sdk.accountsPayable.getBillAttachment({
 **Promise<[operations.GetAccountingBillAttachmentResponse](../../models/operations/getaccountingbillattachmentresponse.md)>**
-## getBillCreditNote
-The *Get bill credit note* endpoint returns a single bill credit note for a given billCreditNoteId.
-[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billCreditNotes) for integrations that support getting a specific bill credit note.
-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 { GetAccountingBillCreditNoteResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.getBillCreditNote({
-  billCreditNoteId: "error",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-}).then((res: GetAccountingBillCreditNoteResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                      | Type                                                                                                           | Required                                                                                                       | Description                                                                                                    |
-| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                      | [operations.GetAccountingBillCreditNoteRequest](../../models/operations/getaccountingbillcreditnoterequest.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.GetAccountingBillCreditNoteResponse](../../models/operations/getaccountingbillcreditnoteresponse.md)>**
-## getBillPayment
-The *Get bill payment* endpoint returns a single bill payment for a given billPaymentId.
-[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable account.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=billPayments) for integrations that support getting a specific bill payment.
-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 { GetAccountingBillPaymentResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.getBillPayment({
-  billPaymentId: "deserunt",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-}).then((res: GetAccountingBillPaymentResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                | Type                                                                                                     | Required                                                                                                 | Description                                                                                              |
-| -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                | [operations.GetAccountingBillPaymentRequest](../../models/operations/getaccountingbillpaymentrequest.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.GetAccountingBillPaymentResponse](../../models/operations/getaccountingbillpaymentresponse.md)>**
-## getSupplier
-The *Get supplier* endpoint returns a single supplier for a given supplierId.
-[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a specific supplier.
-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 { GetAccountingSupplierResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.getSupplier({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  supplierId: "suscipit",
-}).then((res: GetAccountingSupplierResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                          | Type                                                                                               | Required                                                                                           | Description                                                                                        |
-| -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |
-| `request`                                                                                          | [operations.GetAccountingSupplierRequest](../../models/operations/getaccountingsupplierrequest.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.GetAccountingSupplierResponse](../../models/operations/getaccountingsupplierresponse.md)>**
-## getSupplierAttachment
-The *Get supplier attachment* endpoint returns a specific attachment for a given `supplierId` and `attachmentId`.
-[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support getting a supplier attachment.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { GetAccountingSupplierAttachmentResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.getSupplierAttachment({
-  attachmentId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  supplierId: "iure",
-}).then((res: GetAccountingSupplierAttachmentResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                              | Type                                                                                                                   | Required                                                                                                               | Description                                                                                                            |
-| ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                              | [operations.GetAccountingSupplierAttachmentRequest](../../models/operations/getaccountingsupplierattachmentrequest.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.GetAccountingSupplierAttachmentResponse](../../models/operations/getaccountingsupplierattachmentresponse.md)>**
-## isAgedCreditorsReportAvailable
-Indicates whether the aged creditor report is available for the company.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { IsAgedCreditorsReportAvailableResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.isAgedCreditorsReportAvailable({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-}).then((res: IsAgedCreditorsReportAvailableResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                            | Type                                                                                                                 | Required                                                                                                             | Description                                                                                                          |
-| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                            | [operations.IsAgedCreditorsReportAvailableRequest](../../models/operations/isagedcreditorsreportavailablerequest.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.IsAgedCreditorsReportAvailableResponse](../../models/operations/isagedcreditorsreportavailableresponse.md)>**
-## listBillAttachments
-The *List bill attachments* endpoint returns a list of attachments available to download for a given `billId`.
-[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=bills) for integrations that support listing bill attachments.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListAccountingBillAttachmentsResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.listBillAttachments({
-  billId: "magnam",
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-}).then((res: ListAccountingBillAttachmentsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                          | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        |
-| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                          | [operations.ListAccountingBillAttachmentsRequest](../../models/operations/listaccountingbillattachmentsrequest.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.ListAccountingBillAttachmentsResponse](../../models/operations/listaccountingbillattachmentsresponse.md)>**
-## listBillCreditNotes
-The *List bill credit notes* endpoint returns a list of [bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) for a given company's connection.
-[Bill credit notes](https://docs.codat.io/accounting-api#/schemas/BillCreditNote) are issued by a supplier for the purpose of recording credit.
-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 { ListAccountingBillCreditNotesResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.listBillCreditNotes({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "debitis",
-}).then((res: ListAccountingBillCreditNotesResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                          | Type                                                                                                               | Required                                                                                                           | Description                                                                                                        |
-| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                          | [operations.ListAccountingBillCreditNotesRequest](../../models/operations/listaccountingbillcreditnotesrequest.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.ListAccountingBillCreditNotesResponse](../../models/operations/listaccountingbillcreditnotesresponse.md)>**
-## listBillPayments
-The *List bill payments* endpoint returns a list of [bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) for a given company's connection.
-[Bill payments](https://docs.codat.io/accounting-api#/schemas/BillPayment) are an allocation of money within any customer accounts payable 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 { ListAccountingBillPaymentsResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.listBillPayments({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "ipsa",
-}).then((res: ListAccountingBillPaymentsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                    | Type                                                                                                         | Required                                                                                                     | Description                                                                                                  |
-| ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                    | [operations.ListAccountingBillPaymentsRequest](../../models/operations/listaccountingbillpaymentsrequest.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.ListAccountingBillPaymentsResponse](../../models/operations/listaccountingbillpaymentsresponse.md)>**
-## listBills
-The *List bills* endpoint returns a list of [bills](https://docs.codat.io/accounting-api#/schemas/Bill) for a given company's connection.
-[Bills](https://docs.codat.io/accounting-api#/schemas/Bill) are invoices that represent the SMB's financial obligations to their supplier for a purchase of goods or services.
-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 { ListAccountingBillsResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.listBills({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "delectus",
-}).then((res: ListAccountingBillsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                      | Type                                                                                           | Required                                                                                       | Description                                                                                    |
-| ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
-| `request`                                                                                      | [operations.ListAccountingBillsRequest](../../models/operations/listaccountingbillsrequest.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.ListAccountingBillsResponse](../../models/operations/listaccountingbillsresponse.md)>**
-## listSupplierAttachments
-The *List supplier attachments* endpoint returns a list of attachments available to download for given `supplierId`.
-[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=suppliers) for integrations that support listing supplier attachments.
-### Example Usage
-```typescript
-import { CodatLending } from "@codat/lending";
-import { ListAccountingSupplierAttachmentsResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.listSupplierAttachments({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  connectionId: "2e9d2c44-f675-40ba-8049-353bfcb5e171",
-  supplierId: "tempora",
-}).then((res: ListAccountingSupplierAttachmentsResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                                                  | Type                                                                                                                       | Required                                                                                                                   | Description                                                                                                                |
-| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
-| `request`                                                                                                                  | [operations.ListAccountingSupplierAttachmentsRequest](../../models/operations/listaccountingsupplierattachmentsrequest.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.ListAccountingSupplierAttachmentsResponse](../../models/operations/listaccountingsupplierattachmentsresponse.md)>**
-## listSuppliers
-The *List suppliers* endpoint returns a list of [suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) for a given company's connection.
-[Suppliers](https://docs.codat.io/accounting-api#/schemas/Supplier) are people or organizations that provide something, such as a product or service.
-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 { ListAccountingSuppliersResponse } from "@codat/lending/dist/sdk/models/operations";
-const sdk = new CodatLending({
-  security: {
-    authHeader: "Basic BASE_64_ENCODED(API_KEY)",
-  },
-});
-sdk.accountsPayable.listSuppliers({
-  companyId: "8a210b68-6988-11ed-a1eb-0242ac120002",
-  orderBy: "-modifiedDate",
-  page: 1,
-  pageSize: 100,
-  query: "suscipit",
-}).then((res: ListAccountingSuppliersResponse) => {
-  if (res.statusCode == 200) {
-    // handle response
-  }
-});
-```
-### Parameters
-| Parameter                                                                                              | Type                                                                                                   | Required                                                                                               | Description                                                                                            |
-| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                              | [operations.ListAccountingSuppliersRequest](../../models/operations/listaccountingsuppliersrequest.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.ListAccountingSuppliersResponse](../../models/operations/listaccountingsuppliersresponse.md)>**