{"id":19987787,"url":"https://github.com/mawrkus/holded-client","last_synced_at":"2025-05-04T08:31:33.008Z","repository":{"id":32067888,"uuid":"131496462","full_name":"mawrkus/holded-client","owner":"mawrkus","description":"💎  A Node.js client for the Holded API","archived":false,"fork":false,"pushed_at":"2023-03-03T01:26:59.000Z","size":800,"stargazers_count":3,"open_issues_count":3,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-23T04:43:57.440Z","etag":null,"topics":["api-client","holded","invoice-api","invoicing","javascript"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mawrkus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-04-29T13:24:47.000Z","updated_at":"2024-01-23T10:24:40.000Z","dependencies_parsed_at":"2023-01-14T20:26:31.948Z","dependency_job_id":null,"html_url":"https://github.com/mawrkus/holded-client","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mawrkus%2Fholded-client","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mawrkus%2Fholded-client/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mawrkus%2Fholded-client/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mawrkus%2Fholded-client/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mawrkus","download_url":"https://codeload.github.com/mawrkus/holded-client/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252308032,"owners_count":21727112,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-client","holded","invoice-api","invoicing","javascript"],"created_at":"2024-11-13T04:38:22.426Z","updated_at":"2025-05-04T08:31:32.583Z","avatar_url":"https://github.com/mawrkus.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 💎 Holded invoice API client\n\n[![npm](https://img.shields.io/npm/l/holded-client.svg)](https://www.npmjs.org/package/holded-client) [![npm](https://img.shields.io/npm/v/holded-client.svg)](https://www.npmjs.org/package/holded-client)\n![Node version](https://img.shields.io/node/v/holded-client.svg?style=flat-square)\n\nA Node.js client for the Holded *invoice* API v1.0, see https://developers.holded.com/\n\n## Installation\n\n```bash\nyarn install holded-client\n```\n\n## Usage\n\nFor example:\n\n```js\nconst HoldedClient = require('holded-client');\n\nconst client = new HoldedClient({ apiKey: 'your private api key' });\n\nconst { docTypes } = client.documents;\n\nconst invoicesList = await client.documents.list({ type: docTypes.INVOICE });\n```\n\n## API\n\nThe client exposes the following Promise-based APIs:\n\n- `contacts`\n- `saleschannels`\n- `products`\n- `warehouses`\n- `treasury`\n- `expensesaccounts`\n- `payments`\n- `documents`\n\nEach api exposes the following methods:\n\n- `list()`\n- `create({ resource })`\n- `get({ id })`\n- `update({ id, resource })`\n- `delete({ id })`\n\nExcept for the documents API:\n\n- `list({ type })`\n- `create({ type, document })`\n- `get({ type, id })`\n- `update({ type, id, document })`\n- `delete({ type, id })`\n- `downloadPdf({ type, id })`\n- `pay({ type, id, payment })`\n\n## Testing\n\nClone the repository and execute:\n\n```bash\nyarn test\n```\n\n## Contribute\n\n1. Fork it: `git clone https://github.com/mawrkus/holded-client.git`\n2. Create your feature branch: `git checkout -b feature/my-new-feature`\n3. Commit your changes: `git commit -am 'Added some feature'`\n4. Check the build: `npm run build`\n5. Push to the branch: `git push origin my-new-feature`\n6. Submit a pull request :D\n\n## Roadmap\n\n- Invoice API -\u003e `/numberingseries` support\n- Projects API?\n- CRM API?\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmawrkus%2Fholded-client","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmawrkus%2Fholded-client","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmawrkus%2Fholded-client/lists"}