# CreditNotes (*accounting.creditNotes*) ## Overview ### Available Operations * [list](#list) - List Credit Notes * [create](#create) - Create Credit Note * [get](#get) - Get Credit Note * [update](#update) - Update Credit Note * [delete](#delete) - Delete Credit Note ## list List Credit Notes ### 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.creditNotes.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 { accountingCreditNotesList } from "@apideck/sdk/funcs/accountingCreditNotesList.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 accountingCreditNotesList(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.AccountingCreditNotesAllRequest](../../models/operations/accountingcreditnotesallrequest.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.AccountingCreditNotesAllResponse](../../models/operations/accountingcreditnotesallresponse.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 Credit Note ### 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.creditNotes.create({ serviceId: "salesforce", creditNote: { number: "OIT00546", customer: { id: "12345", displayName: "Windsurf Shop", email: "boring@boring.com", }, companyId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, subTotal: 27500, totalAmount: 49.99, totalTax: 2500, taxCode: "1234", balance: 27500, remainingCredit: 27500, status: "authorised", reference: "123456", dateIssued: new Date("2021-05-01T12:00:00.000Z"), datePaid: new Date("2021-05-01T12:00:00.000Z"), type: "accounts_receivable_credit", account: { id: "123456", nominalCode: "N091", code: "453", }, lineItems: [ { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", "", ], }, ], rowVersion: "1-12345", }, { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", ], }, ], rowVersion: "1-12345", }, ], allocations: [ { id: "123456", amount: 49.99, allocationId: "123456", }, { id: "123456", amount: 49.99, allocationId: "123456", }, { id: "123456", amount: 49.99, allocationId: "123456", }, ], note: "Some notes about this credit note", terms: "Some terms about this credit note", billingAddress: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, shippingAddress: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, trackingCategories: [ { id: "123456", name: "New York", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], 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", }, }, }, { 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 { accountingCreditNotesCreate } from "@apideck/sdk/funcs/accountingCreditNotesCreate.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 accountingCreditNotesCreate(apideck, { serviceId: "salesforce", creditNote: { number: "OIT00546", customer: { id: "12345", displayName: "Windsurf Shop", email: "boring@boring.com", }, companyId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, subTotal: 27500, totalAmount: 49.99, totalTax: 2500, taxCode: "1234", balance: 27500, remainingCredit: 27500, status: "authorised", reference: "123456", dateIssued: new Date("2021-05-01T12:00:00.000Z"), datePaid: new Date("2021-05-01T12:00:00.000Z"), type: "accounts_receivable_credit", account: { id: "123456", nominalCode: "N091", code: "453", }, lineItems: [ { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", "", ], }, ], rowVersion: "1-12345", }, { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", ], }, ], rowVersion: "1-12345", }, ], allocations: [ { id: "123456", amount: 49.99, allocationId: "123456", }, { id: "123456", amount: 49.99, allocationId: "123456", }, { id: "123456", amount: 49.99, allocationId: "123456", }, ], note: "Some notes about this credit note", terms: "Some terms about this credit note", billingAddress: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, shippingAddress: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, trackingCategories: [ { id: "123456", name: "New York", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], 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", }, }, }, { 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.AccountingCreditNotesAddRequest](../../models/operations/accountingcreditnotesaddrequest.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.AccountingCreditNotesAddResponse](../../models/operations/accountingcreditnotesaddresponse.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 Credit Note ### 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.creditNotes.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 { accountingCreditNotesGet } from "@apideck/sdk/funcs/accountingCreditNotesGet.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 accountingCreditNotesGet(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.AccountingCreditNotesOneRequest](../../models/operations/accountingcreditnotesonerequest.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.AccountingCreditNotesOneResponse](../../models/operations/accountingcreditnotesoneresponse.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 Credit Note ### 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.creditNotes.update({ id: "", serviceId: "salesforce", creditNote: { number: "OIT00546", customer: { id: "12345", displayName: "Windsurf Shop", email: "boring@boring.com", }, companyId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, subTotal: 27500, totalAmount: 49.99, totalTax: 2500, taxCode: "1234", balance: 27500, remainingCredit: 27500, status: "authorised", reference: "123456", dateIssued: new Date("2021-05-01T12:00:00.000Z"), datePaid: new Date("2021-05-01T12:00:00.000Z"), type: "accounts_receivable_credit", account: { id: "123456", nominalCode: "N091", code: "453", }, lineItems: [ { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: 10, }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", "", ], }, ], rowVersion: "1-12345", }, { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: 10, }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", ], }, ], rowVersion: "1-12345", }, { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: {}, }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: 10, }, ], rowVersion: "1-12345", }, ], allocations: [ { id: "123456", amount: 49.99, allocationId: "123456", }, ], note: "Some notes about this credit note", terms: "Some terms about this credit note", billingAddress: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, shippingAddress: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, trackingCategories: [ { id: "123456", name: "New York", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ {}, ], }, ], 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", }, }, }, ], }, ], }, }); // 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 { accountingCreditNotesUpdate } from "@apideck/sdk/funcs/accountingCreditNotesUpdate.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 accountingCreditNotesUpdate(apideck, { id: "", serviceId: "salesforce", creditNote: { number: "OIT00546", customer: { id: "12345", displayName: "Windsurf Shop", email: "boring@boring.com", }, companyId: "12345", currency: "USD", currencyRate: 0.69, taxInclusive: true, subTotal: 27500, totalAmount: 49.99, totalTax: 2500, taxCode: "1234", balance: 27500, remainingCredit: 27500, status: "authorised", reference: "123456", dateIssued: new Date("2021-05-01T12:00:00.000Z"), datePaid: new Date("2021-05-01T12:00:00.000Z"), type: "accounts_receivable_credit", account: { id: "123456", nominalCode: "N091", code: "453", }, lineItems: [ { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: 10, }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", "", ], }, ], rowVersion: "1-12345", }, { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: 10, }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: [ "", "", ], }, ], rowVersion: "1-12345", }, { id: "12345", rowId: "12345", code: "120-C", lineNumber: 1, description: "Model Y is a fully electric, mid-size SUV, with seating for up to seven, dual motor AWD and unparalleled protection.", type: "sales_item", taxAmount: 27500, totalAmount: 27500, quantity: 1, unitPrice: 27500.5, unitOfMeasure: "pc.", discountPercentage: 0.01, discountAmount: 19.99, locationId: "1234", departmentId: "1234", item: { id: "12344", code: "120-C", name: "Model Y", }, taxRate: { id: "123456", rate: 10, }, trackingCategories: [ { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, { id: "123456", name: "New York", }, ], ledgerAccount: { id: "123456", nominalCode: "N091", code: "453", }, customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: {}, }, { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: 10, }, ], rowVersion: "1-12345", }, ], allocations: [ { id: "123456", amount: 49.99, allocationId: "123456", }, ], note: "Some notes about this credit note", terms: "Some terms about this credit note", billingAddress: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, shippingAddress: { id: "123", type: "primary", string: "25 Spring Street, Blackburn, VIC 3130", name: "HQ US", line1: "Main street", line2: "apt #", line3: "Suite #", line4: "delivery instructions", streetNumber: "25", city: "San Francisco", state: "CA", postalCode: "94104", country: "US", latitude: "40.759211", longitude: "-73.984638", county: "Santa Clara", contactName: "Elon Musk", salutation: "Mr", phoneNumber: "111-111-1111", fax: "122-111-1111", email: "elon@musk.com", website: "https://elonmusk.com", notes: "Address notes or delivery instructions.", rowVersion: "1-12345", }, trackingCategories: [ { id: "123456", name: "New York", }, ], customFields: [ { id: "2389328923893298", name: "employee_level", description: "Employee Level", value: true, }, ], 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", }, }, }, ], }, ], }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result); } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.AccountingCreditNotesUpdateRequest](../../models/operations/accountingcreditnotesupdaterequest.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.AccountingCreditNotesUpdateResponse](../../models/operations/accountingcreditnotesupdateresponse.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 Credit Note ### 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.creditNotes.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 { accountingCreditNotesDelete } from "@apideck/sdk/funcs/accountingCreditNotesDelete.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 accountingCreditNotesDelete(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.AccountingCreditNotesDeleteRequest](../../models/operations/accountingcreditnotesdeleterequest.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.AccountingCreditNotesDeleteResponse](../../models/operations/accountingcreditnotesdeleteresponse.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 | \*/\* |