@codat/lending 0.1.0 → 1.2.0

package/dist/sdk/accountsreceivableinvoices.d.ts

@@ -0,0 +1,93 @@
+import * as utils from "../internal/utils";
+import * as operations from "./models/operations";
+import { SDKConfiguration } from "./sdk";
+import { AxiosRequestConfig } from "axios";
+export declare enum DownloadAttachmentAcceptEnum {
+    applicationJson = "application/json",
+    applicationOctetStream = "application/octet-stream"
+}
+export declare class AccountsReceivableInvoices {
+    private sdkConfiguration;
+    constructor(sdkConfig: SDKConfiguration);
+    /**
+     * Download invoice attachment
+     *
+     * @remarks
+     * The *Download invoice attachment* endpoint downloads a specific attachment for a given `invoiceId` and `attachmentId`.
+     *
+     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support downloading an invoice attachment.
+     *
+     */
+    downloadAttachment(req: operations.DownloadAccountingInvoiceAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig, acceptHeaderOverride?: DownloadAttachmentAcceptEnum): Promise<operations.DownloadAccountingInvoiceAttachmentResponse>;
+    /**
+     * Get invoice as PDF
+     *
+     * @remarks
+     * Download invoice as a pdf.
+     */
+    downloadPdf(req: operations.DownloadAccountingInvoicePdfRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.DownloadAccountingInvoicePdfResponse>;
+    /**
+     * Get invoice
+     *
+     * @remarks
+     * The *Get invoice* endpoint returns a single invoice for a given invoiceId.
+     *
+     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting a specific invoice.
+     *
+     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+     */
+    get(req: operations.GetAccountingInvoiceRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingInvoiceResponse>;
+    /**
+     * Get invoice attachment
+     *
+     * @remarks
+     * The *Get invoice attachment* endpoint returns a specific attachment for a given `invoiceId` and `attachmentId`.
+     *
+     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support getting an invoice attachment.
+     *
+     */
+    getAttachment(req: operations.GetAccountingInvoiceAttachmentRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.GetAccountingInvoiceAttachmentResponse>;
+    /**
+     * List invoices
+     *
+     * @remarks
+     * The *List invoices* endpoint returns a list of [invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) for a given company's connection.
+     *
+     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
+     *
+     * Before using this endpoint, you must have [retrieved data for the company](https://docs.codat.io/lending-api#/operations/refresh-company-data).
+     *
+     * ### Useful queries
+     *
+     * - Outstanding invoices - `query = amountDue > 0`
+     * - Invoices due after a certain date: `query = dueDate > 2021-01-28`
+     *
+     * [Read more about querying](https://docs.codat.io/using-the-api/querying).
+     */
+    list(req: operations.ListAccountingInvoicesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingInvoicesResponse>;
+    /**
+     * List invoice attachments
+     *
+     * @remarks
+     * The *List invoice attachments* endpoint returns a list of attachments available to download for given `invoiceId`.
+     *
+     * [Invoices](https://docs.codat.io/accounting-api#/schemas/Invoice) are itemized records of goods sold or services provided to a customer.
+     *
+     * Check out our [coverage explorer](https://knowledge.codat.io/supported-features/accounting?view=tab-by-data-type&dataType=invoices) for integrations that support listing invoice attachments.
+     *
+     */
+    listAttachments(req: operations.ListAccountingInvoiceAttachmentsRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListAccountingInvoiceAttachmentsResponse>;
+    /**
+     * List reconciled invoices
+     *
+     * @remarks
+     * Gets a list of invoices linked to the corresponding banking transaction
+     */
+    listReconciled(req: operations.ListReconciledInvoicesRequest, retries?: utils.RetryConfig, config?: AxiosRequestConfig): Promise<operations.ListReconciledInvoicesResponse>;
+}