# Attachments (*accounting.attachments*) ## Overview ### Available Operations * [list](#list) - List Attachments * [get](#get) - Get Attachment * [delete](#delete) - Delete Attachment * [download](#download) - Download Attachment ## list List Attachments ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.accounting.attachments.list({ referenceType: "invoice", referenceId: "123456", serviceId: "salesforce", fields: "id,updated_at", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { accountingAttachmentsList } from "@apideck/sdk/funcs/accountingAttachmentsList.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await accountingAttachmentsList(apideck, { referenceType: "invoice", referenceId: "123456", serviceId: "salesforce", fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AccountingAttachmentsAllRequest](../../models/operations/accountingattachmentsallrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AccountingAttachmentsAllResponse](../../models/operations/accountingattachmentsallresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## get Get Attachment ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.accounting.attachments.get({ referenceType: "invoice", referenceId: "123456", id: "", serviceId: "salesforce", fields: "id,updated_at", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { accountingAttachmentsGet } from "@apideck/sdk/funcs/accountingAttachmentsGet.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await accountingAttachmentsGet(apideck, { referenceType: "invoice", referenceId: "123456", id: "", serviceId: "salesforce", fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AccountingAttachmentsOneRequest](../../models/operations/accountingattachmentsonerequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AccountingAttachmentsOneResponse](../../models/operations/accountingattachmentsoneresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## delete Delete Attachment ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.accounting.attachments.delete({ referenceType: "invoice", referenceId: "123456", id: "", serviceId: "salesforce", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { accountingAttachmentsDelete } from "@apideck/sdk/funcs/accountingAttachmentsDelete.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await accountingAttachmentsDelete(apideck, { referenceType: "invoice", referenceId: "123456", id: "", serviceId: "salesforce", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AccountingAttachmentsDeleteRequest](../../models/operations/accountingattachmentsdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AccountingAttachmentsDeleteResponse](../../models/operations/accountingattachmentsdeleteresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* | ## download Download Attachment ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.accounting.attachments.download({ referenceType: "invoice", referenceId: "123456", id: "", serviceId: "salesforce", fields: "id,updated_at", }); // Handle the result console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { ApideckCore } from "@apideck/sdk/core.js"; import { accountingAttachmentsDownload } from "@apideck/sdk/funcs/accountingAttachmentsDownload.js"; // Use `ApideckCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const apideck = new ApideckCore({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const res = await accountingAttachmentsDownload(apideck, { referenceType: "invoice", referenceId: "123456", id: "", serviceId: "salesforce", fields: "id,updated_at", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AccountingAttachmentsDownloadRequest](../../models/operations/accountingattachmentsdownloadrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[operations.AccountingAttachmentsDownloadResponse](../../models/operations/accountingattachmentsdownloadresponse.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------ | ------------------------------ | ------------------------------ | | errors.BadRequestResponse | 400 | application/json | | errors.UnauthorizedResponse | 401 | application/json | | errors.PaymentRequiredResponse | 402 | application/json | | errors.NotFoundResponse | 404 | application/json | | errors.UnprocessableResponse | 422 | application/json | | errors.APIError | 4XX, 5XX | \*/\* |