{"_id":"@codat/sync-for-expenses-version-1","_rev":"9-83845d3b7795a1ec56ad868bb43178eb","name":"@codat/sync-for-expenses-version-1","dist-tags":{"latest":"0.7.0"},"versions":{"0.1.0":{"name":"@codat/sync-for-expenses-version-1","version":"0.1.0","author":{"name":"Codat"},"_id":"@codat/sync-for-expenses-version-1@0.1.0","maintainers":[{"name":"tigerswithguitars","email":"jdryhurstsmith@gmail.com"},{"name":"mcclowes","email":"contact@mcclowes.com"},{"name":"lucy-m","email":"l.mair@codat.io"},{"name":"codat-engineer","email":"engineering@codat.io"}],"homepage":"https://github.com/codatio/client-sdk-typescript#readme","bugs":{"url":"https://github.com/codatio/client-sdk-typescript/issues"},"dist":{"shasum":"d8a40c807af17a152ab4705c36fea374bf125490","tarball":"https://registry.npmjs.org/@codat/sync-for-expenses-version-1/-/sync-for-expenses-version-1-0.1.0.tgz","fileCount":294,"integrity":"sha512-XWQczZUbeBKLQIFSEhTx4h4yCZAjp2HspuNyxklGQhMZ1G/Z50+KwlqGoSBPLB5j0NnyDdwmdf0WsAzZE/iUXw==","signatures":[{"sig":"MEUCICOUyIuPdLKQdzskn1igx7mN4K1wrAgBm0eU4yETNtDcAiEAxxGjBrKRLrX8e9yS0Lr67ydcA8PlTwU6bFBK87swIkw=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1246740},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"bdc55d38137a0054e93facf8ad7e335a1344dbe0","scripts":{"prepare":"tsc --build"},"_npmUser":{"name":"mcclowes","email":"contact@mcclowes.com"},"repository":{"url":"git+https://github.com/codatio/client-sdk-typescript.git","type":"git","directory":"previous-versions/sync-for-expenses-version-1"},"_npmVersion":"8.19.4","description":"","directories":{},"_nodeVersion":"16.20.2","dependencies":{"axios":"^1.1.3","jsonpath":"^1.1.1","form-data":"^4.0.0","reflect-metadata":"^0.1.13","class-transformer":"^0.5.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.36.0","typescript":"^4.8.4","@types/node":"^18.11.5","@types/jsonpath":"^0.2.0","@typescript-eslint/parser":"^5.56.0","@typescript-eslint/eslint-plugin":"^5.56.0"},"_npmOperationalInternal":{"tmp":"tmp/sync-for-expenses-version-1_0.1.0_1694620203481_0.06879666291644382","host":"s3://npm-registry-packages"}},"0.2.0":{"name":"@codat/sync-for-expenses-version-1","version":"0.2.0","author":{"name":"Codat"},"_id":"@codat/sync-for-expenses-version-1@0.2.0","maintainers":[{"name":"tigerswithguitars","email":"jdryhurstsmith@gmail.com"},{"name":"mcclowes","email":"contact@mcclowes.com"},{"name":"lucy-m","email":"l.mair@codat.io"},{"name":"codat-engineer","email":"engineering@codat.io"}],"homepage":"https://github.com/codatio/client-sdk-typescript#readme","bugs":{"url":"https://github.com/codatio/client-sdk-typescript/issues"},"dist":{"shasum":"520f2a2a0ff5edddb69a236200379ff46cc5df67","tarball":"https://registry.npmjs.org/@codat/sync-for-expenses-version-1/-/sync-for-expenses-version-1-0.2.0.tgz","fileCount":294,"integrity":"sha512-Xx6hXcWSiudFh3KfuLtpAXbmfHUQFlLABLg4EsJN4FwOSB0lGbj44XWBhMgl4bkO/yvmVvuuut1At3bkQp8JVg==","signatures":[{"sig":"MEQCIHhaSU83ZeGvqkOjv7kbdG3xbUhWo43BRnWpiBpHgaLQAiBcUfp00V2HFzAWhqBc618Ia7mqdIC1eLy6mNNKXu1zXw==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1246740},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"92cc7a29ffc6e0400c98b93ccf3af5357e1d250c","scripts":{"prepare":"tsc --build"},"_npmUser":{"name":"mcclowes","email":"contact@mcclowes.com"},"repository":{"url":"git+https://github.com/codatio/client-sdk-typescript.git","type":"git","directory":"previous-versions/sync-for-expenses-version-1"},"_npmVersion":"8.19.4","description":"","directories":{},"_nodeVersion":"16.20.2","dependencies":{"axios":"^1.1.3","jsonpath":"^1.1.1","form-data":"^4.0.0","reflect-metadata":"^0.1.13","class-transformer":"^0.5.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.36.0","typescript":"^4.8.4","@types/node":"^18.11.5","@types/jsonpath":"^0.2.0","@typescript-eslint/parser":"^5.56.0","@typescript-eslint/eslint-plugin":"^5.56.0"},"_npmOperationalInternal":{"tmp":"tmp/sync-for-expenses-version-1_0.2.0_1694700688273_0.5889284673075139","host":"s3://npm-registry-packages"}},"0.3.0":{"name":"@codat/sync-for-expenses-version-1","version":"0.3.0","author":{"name":"Codat"},"_id":"@codat/sync-for-expenses-version-1@0.3.0","maintainers":[{"name":"tigerswithguitars","email":"jdryhurstsmith@gmail.com"},{"name":"mcclowes","email":"contact@mcclowes.com"},{"name":"lucy-m","email":"l.mair@codat.io"},{"name":"codat-engineer","email":"engineering@codat.io"}],"homepage":"https://github.com/codatio/client-sdk-typescript#readme","bugs":{"url":"https://github.com/codatio/client-sdk-typescript/issues"},"dist":{"shasum":"a980e3e72758300be6d2ae40fd61feec9eed9747","tarball":"https://registry.npmjs.org/@codat/sync-for-expenses-version-1/-/sync-for-expenses-version-1-0.3.0.tgz","fileCount":298,"integrity":"sha512-N3W3tpHuQNzXYWAlLUzeoUQ9jXDRzgQ0qxUkKl0o3Jr4iP5ZzdL6dYsZkugPl0+9/LV71SO2jWePyZjcSNWNfQ==","signatures":[{"sig":"MEQCIDZ3xc9AYKIFx1s5jHh1B1faAdHKsL20xkmaWGJrDPJUAiAMx5i/D0rT2ZDVQ6KagUOYP6r0f2x9VIpNXPjgV20rvQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1262706},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"f383b9b6baf4bfbc7924bd322fba8d006ebe2103","scripts":{"check":"npm run check:tsc && npm run check:eslint","prepare":"tsc --build","check:tsc":"tsc --noEmit --skipLibCheck","check:eslint":"eslint --max-warnings=0 src"},"_npmUser":{"name":"mcclowes","email":"contact@mcclowes.com"},"repository":{"url":"git+https://github.com/codatio/client-sdk-typescript.git","type":"git","directory":"previous-versions/sync-for-expenses-version-1"},"_npmVersion":"8.19.4","description":" Push expenses to accounting platforms. ","directories":{},"_nodeVersion":"16.20.2","dependencies":{"axios":"^1.1.3","jsonpath":"^1.1.1","form-data":"^4.0.0","reflect-metadata":"^0.1.13","class-transformer":"^0.5.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.36.0","typescript":"^4.8.4","@types/node":"^18.11.5","@types/jsonpath":"^0.2.0","@typescript-eslint/parser":"^5.56.0","@typescript-eslint/eslint-plugin":"^5.56.0"},"_npmOperationalInternal":{"tmp":"tmp/sync-for-expenses-version-1_0.3.0_1697551771547_0.37791950191427226","host":"s3://npm-registry-packages"}},"0.4.0":{"name":"@codat/sync-for-expenses-version-1","version":"0.4.0","author":{"name":"Codat"},"_id":"@codat/sync-for-expenses-version-1@0.4.0","maintainers":[{"name":"tigerswithguitars","email":"jdryhurstsmith@gmail.com"},{"name":"mcclowes","email":"contact@mcclowes.com"},{"name":"lucy-m","email":"l.mair@codat.io"},{"name":"codat-engineer","email":"eng-leadership@codat.io"}],"homepage":"https://github.com/codatio/client-sdk-typescript#readme","bugs":{"url":"https://github.com/codatio/client-sdk-typescript/issues"},"dist":{"shasum":"b26bea31b043b392dfe654c48791186c3348a0e5","tarball":"https://registry.npmjs.org/@codat/sync-for-expenses-version-1/-/sync-for-expenses-version-1-0.4.0.tgz","fileCount":300,"integrity":"sha512-W9YszLPGPbgXHkX3tZrJEfJuYGeWSzY+97wmBsuN19OjLtf+ugKJoJckw9XMJp28ShyqE/9f3kzb+Py8kMf3QA==","signatures":[{"sig":"MEYCIQD9XgiW9ZL/tEsh+iFpGPucUaN439goD/7OJPJjr3t9SQIhAPv6psTEHVbjYcSF4boAEAixvSrRO7AqSdN80FvyEoGY","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1288456},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"d8d29f687f3ee21883d32e1b2b00713397ee8aca","scripts":{"check":"npm run check:tsc && npm run check:eslint","prepare":"tsc --build","check:tsc":"tsc --noEmit --skipLibCheck","check:eslint":"eslint --max-warnings=0 src"},"_npmUser":{"name":"mcclowes","email":"contact@mcclowes.com"},"repository":{"url":"git+https://github.com/codatio/client-sdk-typescript.git","type":"git","directory":"previous-versions/sync-for-expenses-version-1"},"_npmVersion":"8.19.4","description":" Push expenses to accounting platforms. ","directories":{},"_nodeVersion":"16.20.2","dependencies":{"axios":"^1.1.3","jsonpath":"^1.1.1","form-data":"^4.0.0","reflect-metadata":"^0.1.13","class-transformer":"^0.5.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.36.0","typescript":"^4.8.4","@types/node":"^18.11.5","@types/jsonpath":"^0.2.0","@typescript-eslint/parser":"^5.56.0","@typescript-eslint/eslint-plugin":"^5.56.0"},"_npmOperationalInternal":{"tmp":"tmp/sync-for-expenses-version-1_0.4.0_1701854094167_0.4596817005958074","host":"s3://npm-registry-packages"}},"0.5.0":{"name":"@codat/sync-for-expenses-version-1","version":"0.5.0","author":{"name":"Codat"},"_id":"@codat/sync-for-expenses-version-1@0.5.0","maintainers":[{"name":"tigerswithguitars","email":"jdryhurstsmith@gmail.com"},{"name":"mcclowes","email":"contact@mcclowes.com"},{"name":"lucy-m","email":"l.mair@codat.io"},{"name":"codat-engineer","email":"eng-leadership@codat.io"}],"homepage":"https://github.com/codatio/client-sdk-typescript#readme","bugs":{"url":"https://github.com/codatio/client-sdk-typescript/issues"},"dist":{"shasum":"880777f1ef7a587694af7748b797fe073c5d8f3c","tarball":"https://registry.npmjs.org/@codat/sync-for-expenses-version-1/-/sync-for-expenses-version-1-0.5.0.tgz","fileCount":300,"integrity":"sha512-BftKFlQNy7Mvy4dER7ulDlSqsSnD2M01CrFNzNvtdYfONI9ND3kTNgd99eMrHaIqVmmARbdRIN6e4UoqWv4YFg==","signatures":[{"sig":"MEYCIQDRUUHy74oeqiFC0PQh4ixJ9uU5Q6Re+nzM+dfnfTFiegIhALEXSguYQ7VMhvS4ddNDlqOUadfP2950PIzDpY+PZc4b","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1369512},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"496da3354010b2a01a3d7f945c4f9671948698ef","scripts":{"check":"npm run check:tsc && npm run check:eslint","prepare":"tsc --build","check:tsc":"tsc --noEmit --skipLibCheck","check:eslint":"eslint --max-warnings=0 src"},"_npmUser":{"name":"mcclowes","email":"contact@mcclowes.com"},"repository":{"url":"git+https://github.com/codatio/client-sdk-typescript.git","type":"git","directory":"previous-versions/sync-for-expenses-version-1"},"_npmVersion":"8.19.4","description":" Push expenses to accounting platforms. ","directories":{},"_nodeVersion":"16.20.2","dependencies":{"axios":"^1.1.3","jsonpath":"^1.1.1","form-data":"^4.0.0","reflect-metadata":"^0.1.13","class-transformer":"^0.5.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.36.0","typescript":"^4.8.4","@types/node":"^18.11.5","@types/jsonpath":"^0.2.0","@typescript-eslint/parser":"^5.56.0","@typescript-eslint/eslint-plugin":"^5.56.0"},"_npmOperationalInternal":{"tmp":"tmp/sync-for-expenses-version-1_0.5.0_1702572446096_0.9531740436775349","host":"s3://npm-registry-packages"}},"0.6.0":{"name":"@codat/sync-for-expenses-version-1","version":"0.6.0","author":{"name":"Codat"},"_id":"@codat/sync-for-expenses-version-1@0.6.0","maintainers":[{"name":"tigerswithguitars","email":"jdryhurstsmith@gmail.com"},{"name":"mcclowes","email":"contact@mcclowes.com"},{"name":"lucy-m","email":"l.mair@codat.io"},{"name":"codat-engineer","email":"eng-leadership@codat.io"}],"homepage":"https://github.com/codatio/client-sdk-typescript#readme","bugs":{"url":"https://github.com/codatio/client-sdk-typescript/issues"},"dist":{"shasum":"353d25a3ab6ddf39c4e21c40b68b5a43f0ce18c6","tarball":"https://registry.npmjs.org/@codat/sync-for-expenses-version-1/-/sync-for-expenses-version-1-0.6.0.tgz","fileCount":310,"integrity":"sha512-k8j+PX4iZ5rgUmDNbvIA+9T6L0YdAfjf91otjgKDGR8sF3RBvsuFmQuHS0eiOgs1CZSAtyljQRWBRnz2rNbu5Q==","signatures":[{"sig":"MEYCIQDQd40423UtF9jjULtCnVFXo0Tv3+bhJJ9Quqy8QK+44gIhAI4LQRTUxvlfgkjKkdhH3nnbT4Y5g0I5wuaLL7syslA/","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1473700},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"2514a66153b67bf80e3da2b92f038d54f41db24b","scripts":{"check":"npm run check:tsc && npm run check:eslint","prepare":"tsc --build","check:tsc":"tsc --noEmit --skipLibCheck","check:eslint":"eslint --max-warnings=0 src"},"_npmUser":{"name":"mcclowes","email":"contact@mcclowes.com"},"repository":{"url":"git+https://github.com/codatio/client-sdk-typescript.git","type":"git","directory":"previous-versions/sync-for-expenses-version-1"},"_npmVersion":"8.19.4","description":" Push expenses to accounting platforms. ","directories":{},"_nodeVersion":"16.20.2","dependencies":{"axios":"^1.1.3","jsonpath":"^1.1.1","form-data":"^4.0.0","reflect-metadata":"^0.1.13","class-transformer":"^0.5.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.36.0","typescript":"^4.8.4","@types/node":"^18.11.5","@types/jsonpath":"^0.2.0","@typescript-eslint/parser":"^5.56.0","@typescript-eslint/eslint-plugin":"^5.56.0"},"_npmOperationalInternal":{"tmp":"tmp/sync-for-expenses-version-1_0.6.0_1707841135529_0.3755443852926743","host":"s3://npm-registry-packages"}},"0.7.0":{"name":"@codat/sync-for-expenses-version-1","version":"0.7.0","author":{"name":"Codat"},"_id":"@codat/sync-for-expenses-version-1@0.7.0","maintainers":[{"name":"tigerswithguitars","email":"jdryhurstsmith@gmail.com"},{"name":"mcclowes","email":"contact@mcclowes.com"},{"name":"lucy-m","email":"l.mair@codat.io"},{"name":"codat-engineer","email":"eng-leadership@codat.io"}],"homepage":"https://github.com/codatio/client-sdk-typescript#readme","bugs":{"url":"https://github.com/codatio/client-sdk-typescript/issues"},"dist":{"shasum":"687ef5dafea628dcb6574ec1db3a7a015ea53ce6","tarball":"https://registry.npmjs.org/@codat/sync-for-expenses-version-1/-/sync-for-expenses-version-1-0.7.0.tgz","fileCount":310,"integrity":"sha512-nef4wwFtZOjzhhKpVzURbSJwSI71hQZEntxbGhAWrZxeUNBNCLyloJO7C/hxig700V2aEsJx6tzutABNgH4zcA==","signatures":[{"sig":"MEQCIFCztnZB9jIGQTwpwXfUtBmtCVAwKpj9ZBfUgFM1pnmOAiBt7eiXDPdBSgFkjJRiyj3Wm86bIANTnTZKaQ8DIVpmEg==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1494614},"main":"dist/index.js","types":"./dist/index.d.ts","gitHead":"25fbfb959a217675aa2059046fb792880541b2a9","scripts":{"check":"npm run check:tsc && npm run check:eslint","prepare":"tsc --build","check:tsc":"tsc --noEmit --skipLibCheck","check:eslint":"eslint --max-warnings=0 src"},"_npmUser":{"name":"mcclowes","email":"contact@mcclowes.com"},"repository":{"url":"git+https://github.com/codatio/client-sdk-typescript.git","type":"git","directory":"previous-versions/sync-for-expenses-version-1"},"_npmVersion":"8.19.4","description":" Push expenses to accounting platforms. ","directories":{},"_nodeVersion":"16.20.2","dependencies":{"axios":"^1.1.3","jsonpath":"^1.1.1","form-data":"^4.0.0","reflect-metadata":"^0.1.13","class-transformer":"^0.5.1"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.36.0","typescript":"^4.8.4","@types/node":"^18.11.5","@types/jsonpath":"^0.2.0","@typescript-eslint/parser":"^5.56.0","@typescript-eslint/eslint-plugin":"^5.56.0"},"_npmOperationalInternal":{"tmp":"tmp/sync-for-expenses-version-1_0.7.0_1710955522787_0.27656668517263827","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-09-13T15:50:03.333Z","modified":"2025-07-28T10:07:58.570Z","0.1.0":"2023-09-13T15:50:03.751Z","0.2.0":"2023-09-14T14:11:28.595Z","0.3.0":"2023-10-17T14:09:31.809Z","0.4.0":"2023-12-06T09:14:54.322Z","0.5.0":"2023-12-14T16:47:26.297Z","0.6.0":"2024-02-13T16:18:55.693Z","0.7.0":"2024-03-20T17:25:22.947Z"},"bugs":{"url":"https://github.com/codatio/client-sdk-typescript/issues"},"author":{"name":"Codat"},"homepage":"https://github.com/codatio/client-sdk-typescript#readme","repository":{"url":"git+https://github.com/codatio/client-sdk-typescript.git","type":"git","directory":"previous-versions/sync-for-expenses-version-1"},"description":" Push expenses to accounting platforms. ","maintainers":[{"email":"eng-leadership@codat.io","name":"codat-engineer"}],"readme":"# Sync for Expenses version 1\n\n\nPush expenses to accounting platforms.\n\n\n\n## SDK Installation\n\n### NPM\n\n```bash\nnpm add @codat/sync-for-expenses-version-1\n```\n\n### Yarn\n\n```bash\nyarn add @codat/sync-for-expenses-version-1\n```\n\n\n## Example Usage\n\n## SDK Example Usage\n\n### Example\n\n```typescript\nimport { CodatSyncExpenses } from \"@codat/sync-for-expenses-version-1\";\n\nasync function run() {\n const sdk = new CodatSyncExpenses({\n security: {\n authHeader: \"Basic BASE_64_ENCODED(API_KEY)\",\n },\n });\n\n const res = await sdk.companies.createCompany({\n description: \"Requested early access to the new financing scheme.\",\n groups: [\n {\n id: \"60d2fa12-8a04-11ee-b9d1-0242ac120002\",\n },\n ],\n name: \"Bank of Dave\",\n });\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();\n\n```\n\n\n\n## Available Resources and Operations\n\n### [companies](docs/sdks/companies/README.md)\n\n* [createCompany](docs/sdks/companies/README.md#createcompany) - Create company\n* [deleteCompany](docs/sdks/companies/README.md#deletecompany) - Delete a company\n* [getCompany](docs/sdks/companies/README.md#getcompany) - Get company\n* [listCompanies](docs/sdks/companies/README.md#listcompanies) - List companies\n* [updateCompany](docs/sdks/companies/README.md#updatecompany) - Update company\n\n### [connections](docs/sdks/connections/README.md)\n\n* [createConnection](docs/sdks/connections/README.md#createconnection) - Create connection\n* [createPartnerExpenseConnection](docs/sdks/connections/README.md#createpartnerexpenseconnection) - Create partner expense connection\n* [deleteConnection](docs/sdks/connections/README.md#deleteconnection) - Delete connection\n* [getConnection](docs/sdks/connections/README.md#getconnection) - Get connection\n* [listConnections](docs/sdks/connections/README.md#listconnections) - List connections\n* [unlink](docs/sdks/connections/README.md#unlink) - Unlink connection\n\n### [configuration](docs/sdks/configuration/README.md)\n\n* [getCompanyConfiguration](docs/sdks/configuration/README.md#getcompanyconfiguration) - Get company configuration\n* [saveCompanyConfiguration](docs/sdks/configuration/README.md#savecompanyconfiguration) - Set company configuration\n\n### [expenses](docs/sdks/expenses/README.md)\n\n* [createExpenseDataset](docs/sdks/expenses/README.md#createexpensedataset) - Create expense-transactions\n* [updateExpenseDataset](docs/sdks/expenses/README.md#updateexpensedataset) - Update expense transactions\n* [uploadAttachment](docs/sdks/expenses/README.md#uploadattachment) - Upload attachment\n\n### [mappingOptions](docs/sdks/mappingoptions/README.md)\n\n* [getMappingOptions](docs/sdks/mappingoptions/README.md#getmappingoptions) - Mapping options\n\n### [sync](docs/sdks/sync/README.md)\n\n* [initiateSync](docs/sdks/sync/README.md#initiatesync) - Initiate sync\n\n### [syncStatus](docs/sdks/syncstatus/README.md)\n\n* [getLastSuccessfulSync](docs/sdks/syncstatus/README.md#getlastsuccessfulsync) - Last successful sync\n* [getLatestSync](docs/sdks/syncstatus/README.md#getlatestsync) - Latest sync status\n* [getSyncById](docs/sdks/syncstatus/README.md#getsyncbyid) - Get sync status\n* [listSyncs](docs/sdks/syncstatus/README.md#listsyncs) - List sync statuses\n\n### [transactionStatus](docs/sdks/transactionstatus/README.md)\n\n* [getSyncTransaction](docs/sdks/transactionstatus/README.md#getsynctransaction) - Get sync transaction\n* [listSyncTransactions](docs/sdks/transactionstatus/README.md#listsynctransactions) - Get sync transactions\n\n\n\n\n\n## Retries\n\nSome of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.\n\nTo change the default retry strategy for a single API call, simply provide a retryConfig object to the call:\n```typescript\nimport { CodatSyncExpenses } from \"@codat/sync-for-expenses-version-1\";\n\nasync function run() {\n const sdk = new CodatSyncExpenses({\n security: {\n authHeader: \"Basic BASE_64_ENCODED(API_KEY)\",\n },\n });\n\n const res = await sdk.companies.createCompany(\n {\n description: \"Requested early access to the new financing scheme.\",\n groups: [\n {\n id: \"60d2fa12-8a04-11ee-b9d1-0242ac120002\",\n },\n ],\n name: \"Bank of Dave\",\n },\n {\n strategy: \"backoff\",\n backoff: {\n initialInterval: 1,\n maxInterval: 50,\n exponent: 1.1,\n maxElapsedTime: 100,\n },\n retryConnectionErrors: false,\n }\n );\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();\n\n```\n\nIf you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:\n```typescript\nimport { CodatSyncExpenses } from \"@codat/sync-for-expenses-version-1\";\n\nasync function run() {\n const sdk = new CodatSyncExpenses({\n retry_config: {\n strategy: \"backoff\",\n backoff: {\n initialInterval: 1,\n maxInterval: 50,\n exponent: 1.1,\n maxElapsedTime: 100,\n },\n retryConnectionErrors: false,\n },\n security: {\n authHeader: \"Basic BASE_64_ENCODED(API_KEY)\",\n },\n });\n\n const res = await sdk.companies.createCompany({\n description: \"Requested early access to the new financing scheme.\",\n groups: [\n {\n id: \"60d2fa12-8a04-11ee-b9d1-0242ac120002\",\n },\n ],\n name: \"Bank of Dave\",\n });\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();\n\n```\n\n\n\n## Error Handling\n\nHandling errors in this SDK should largely match your expectations. All operations return a response object or throw an error. If Error objects are specified in your OpenAPI Spec, the SDK will throw the appropriate Error type.\n\n| Error Object | Status Code | Content Type |\n| --------------- | --------------- | --------------- |\n| errors.SDKError | 4xx-5xx | */* |\n\nExample\n\n```typescript\nimport { CodatSyncExpenses } from \"@codat/sync-for-expenses-version-1\";\n\nasync function run() {\n const sdk = new CodatSyncExpenses({\n security: {\n authHeader: \"Basic BASE_64_ENCODED(API_KEY)\",\n },\n });\n\n let res;\n try {\n res = await sdk.companies.createCompany({\n description: \"Requested early access to the new financing scheme.\",\n groups: [\n {\n id: \"60d2fa12-8a04-11ee-b9d1-0242ac120002\",\n },\n ],\n name: \"Bank of Dave\",\n });\n } catch (err) {\n if (err instanceof errors.SDKError) {\n console.error(err); // handle exception\n throw err;\n }\n }\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();\n\n```\n\n\n\n## Server Selection\n\n### Select Server by Index\n\nYou can override the default server globally by passing a server index to the `serverIdx: number` optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:\n\n| # | Server | Variables |\n| - | ------ | --------- |\n| 0 | `https://api.codat.io` | None |\n\n#### Example\n\n```typescript\nimport { CodatSyncExpenses } from \"@codat/sync-for-expenses-version-1\";\n\nasync function run() {\n const sdk = new CodatSyncExpenses({\n serverIdx: 0,\n security: {\n authHeader: \"Basic BASE_64_ENCODED(API_KEY)\",\n },\n });\n\n const res = await sdk.companies.createCompany({\n description: \"Requested early access to the new financing scheme.\",\n groups: [\n {\n id: \"60d2fa12-8a04-11ee-b9d1-0242ac120002\",\n },\n ],\n name: \"Bank of Dave\",\n });\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();\n\n```\n\n\n### Override Server URL Per-Client\n\nThe default server can also be overridden globally by passing a URL to the `serverURL: str` optional parameter when initializing the SDK client instance. For example:\n```typescript\nimport { CodatSyncExpenses } from \"@codat/sync-for-expenses-version-1\";\n\nasync function run() {\n const sdk = new CodatSyncExpenses({\n serverURL: \"https://api.codat.io\",\n security: {\n authHeader: \"Basic BASE_64_ENCODED(API_KEY)\",\n },\n });\n\n const res = await sdk.companies.createCompany({\n description: \"Requested early access to the new financing scheme.\",\n groups: [\n {\n id: \"60d2fa12-8a04-11ee-b9d1-0242ac120002\",\n },\n ],\n name: \"Bank of Dave\",\n });\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();\n\n```\n\n\n\n## Custom HTTP Client\n\nThe Typescript SDK makes API calls using the [axios](https://axios-http.com/docs/intro) HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom `AxiosInstance` object.\n\nFor example, you could specify a header for every request that your sdk makes as follows:\n\n```typescript\nimport { @codat/sync-for-expenses-version-1 } from \"CodatSyncExpenses\";\nimport axios from \"axios\";\n\nconst httpClient = axios.create({\n headers: {'x-custom-header': 'someValue'}\n})\n\nconst sdk = new CodatSyncExpenses({defaultClient: httpClient});\n```\n\n\n\n## Authentication\n\n### Per-Client Security Schemes\n\nThis SDK supports the following security scheme globally:\n\n| Name | Type | Scheme |\n| ------------ | ------------ | ------------ |\n| `authHeader` | apiKey | API key |\n\nYou can set the security parameters through the `security` optional parameter when initializing the SDK client instance. For example:\n```typescript\nimport { CodatSyncExpenses } from \"@codat/sync-for-expenses-version-1\";\n\nasync function run() {\n const sdk = new CodatSyncExpenses({\n security: {\n authHeader: \"Basic BASE_64_ENCODED(API_KEY)\",\n },\n });\n\n const res = await sdk.companies.createCompany({\n description: \"Requested early access to the new financing scheme.\",\n groups: [\n {\n id: \"60d2fa12-8a04-11ee-b9d1-0242ac120002\",\n },\n ],\n name: \"Bank of Dave\",\n });\n\n if (res.statusCode == 200) {\n // handle response\n }\n}\n\nrun();\n\n```\n\n\n\n\n\n### Support\n\nIf you encounter any challenges while utilizing our SDKs, please don't hesitate to reach out for assistance. \nYou can raise any issues by contacting your dedicated Codat representative or reaching out to our [support team](mailto:support@codat.io).\nWe're here to help ensure a smooth experience for you.\n\n\n\n### Library generated by [Speakeasy](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks)\n","readmeFilename":"README.md"}