# LedgerAccounts (*accounting.ledgerAccounts*) ## Overview ### Available Operations * [list](#list) - List Ledger Accounts * [create](#create) - Create Ledger Account * [get](#get) - Get Ledger Account * [update](#update) - Update Ledger Account * [delete](#delete) - Delete Ledger Account ## list List Ledger Accounts ### 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.ledgerAccounts.list({ serviceId: "salesforce", filter: { updatedSince: new Date("2020-09-30T07:43:32.000Z"), }, sort: { by: "updated_at", direction: "desc", }, passThrough: { "search": "San Francisco", }, 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 { accountingLedgerAccountsList } from "@apideck/sdk/funcs/accountingLedgerAccountsList.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 accountingLedgerAccountsList(apideck, { serviceId: "salesforce", filter: { updatedSince: new Date("2020-09-30T07:43:32.000Z"), }, sort: { by: "updated_at", direction: "desc", }, passThrough: { "search": "San Francisco", }, 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.AccountingLedgerAccountsAllRequest](../../models/operations/accountingledgeraccountsallrequest.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.AccountingLedgerAccountsAllResponse](../../models/operations/accountingledgeraccountsallresponse.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 | \*/\* | ## create Create Ledger Account ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; import { RFCDate } from "@apideck/sdk/types"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.accounting.ledgerAccounts.create({ serviceId: "salesforce", ledgerAccount: { displayId: "1-12345", code: "453", classification: "asset", type: "bank", subType: "CHECKING_ACCOUNT", name: "Bank account", fullyQualifiedName: "Asset.Bank.Checking_Account", description: "Main checking account", openingBalance: 75000, currentBalance: 20000, currency: "USD", taxType: "NONE", taxRate: { id: "123456", rate: 10, }, level: 1, active: true, status: "active", header: true, bankAccount: { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, parentAccount: { id: "12345", name: "Bank Accounts", displayId: "1-1100", }, subAccount: false, lastReconciliationDate: new RFCDate("2020-09-30"), rowVersion: "1-12345", passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // 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 { accountingLedgerAccountsCreate } from "@apideck/sdk/funcs/accountingLedgerAccountsCreate.js"; import { RFCDate } from "@apideck/sdk/types"; // 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 accountingLedgerAccountsCreate(apideck, { serviceId: "salesforce", ledgerAccount: { displayId: "1-12345", code: "453", classification: "asset", type: "bank", subType: "CHECKING_ACCOUNT", name: "Bank account", fullyQualifiedName: "Asset.Bank.Checking_Account", description: "Main checking account", openingBalance: 75000, currentBalance: 20000, currency: "USD", taxType: "NONE", taxRate: { id: "123456", rate: 10, }, level: 1, active: true, status: "active", header: true, bankAccount: { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, parentAccount: { id: "12345", name: "Bank Accounts", displayId: "1-1100", }, subAccount: false, lastReconciliationDate: new RFCDate("2020-09-30"), rowVersion: "1-12345", passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AccountingLedgerAccountsAddRequest](../../models/operations/accountingledgeraccountsaddrequest.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.AccountingLedgerAccountsAddResponse](../../models/operations/accountingledgeraccountsaddresponse.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 Ledger Account ### 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.ledgerAccounts.get({ 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 { accountingLedgerAccountsGet } from "@apideck/sdk/funcs/accountingLedgerAccountsGet.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 accountingLedgerAccountsGet(apideck, { 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.AccountingLedgerAccountsOneRequest](../../models/operations/accountingledgeraccountsonerequest.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.AccountingLedgerAccountsOneResponse](../../models/operations/accountingledgeraccountsoneresponse.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 | \*/\* | ## update Update Ledger Account ### Example Usage ```typescript import { Apideck } from "@apideck/sdk"; import { RFCDate } from "@apideck/sdk/types"; const apideck = new Apideck({ apiKey: process.env["APIDECK_API_KEY"] ?? "", consumerId: "test-consumer", appId: "dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX", }); async function run() { const result = await apideck.accounting.ledgerAccounts.update({ id: "", serviceId: "salesforce", ledgerAccount: { displayId: "1-12345", code: "453", classification: "asset", type: "bank", subType: "CHECKING_ACCOUNT", name: "Bank account", fullyQualifiedName: "Asset.Bank.Checking_Account", description: "Main checking account", openingBalance: 75000, currentBalance: 20000, currency: "USD", taxType: "NONE", taxRate: { id: "123456", rate: 10, }, level: 1, active: true, status: "active", header: true, bankAccount: { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, parentAccount: { id: "12345", name: "Bank Accounts", displayId: "1-1100", }, subAccount: false, lastReconciliationDate: new RFCDate("2020-09-30"), rowVersion: "1-12345", passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); // 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 { accountingLedgerAccountsUpdate } from "@apideck/sdk/funcs/accountingLedgerAccountsUpdate.js"; import { RFCDate } from "@apideck/sdk/types"; // 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 accountingLedgerAccountsUpdate(apideck, { id: "", serviceId: "salesforce", ledgerAccount: { displayId: "1-12345", code: "453", classification: "asset", type: "bank", subType: "CHECKING_ACCOUNT", name: "Bank account", fullyQualifiedName: "Asset.Bank.Checking_Account", description: "Main checking account", openingBalance: 75000, currentBalance: 20000, currency: "USD", taxType: "NONE", taxRate: { id: "123456", rate: 10, }, level: 1, active: true, status: "active", header: true, bankAccount: { bankName: "Monzo", accountNumber: "123465", accountName: "SPACEX LLC", accountType: "credit_card", iban: "CH2989144532982975332", bic: "AUDSCHGGXXX", routingNumber: "012345678", bsbNumber: "062-001", branchIdentifier: "001", bankCode: "BNH", currency: "USD", }, parentAccount: { id: "12345", name: "Bank Accounts", displayId: "1-1100", }, subAccount: false, lastReconciliationDate: new RFCDate("2020-09-30"), rowVersion: "1-12345", passThrough: [ { serviceId: "", extendPaths: [ { path: "$.nested.property", value: { "TaxClassificationRef": { "value": "EUC-99990201-V1-00020000", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AccountingLedgerAccountsUpdateRequest](../../models/operations/accountingledgeraccountsupdaterequest.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.AccountingLedgerAccountsUpdateResponse](../../models/operations/accountingledgeraccountsupdateresponse.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 Ledger Account ### 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.ledgerAccounts.delete({ 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 { accountingLedgerAccountsDelete } from "@apideck/sdk/funcs/accountingLedgerAccountsDelete.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 accountingLedgerAccountsDelete(apideck, { 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.AccountingLedgerAccountsDeleteRequest](../../models/operations/accountingledgeraccountsdeleterequest.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.AccountingLedgerAccountsDeleteResponse](../../models/operations/accountingledgeraccountsdeleteresponse.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 | \*/\* |