# mycashflow

> MyCashflow API client

Latest version **0.3.0** (published 2015-08-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install mycashflow
pnpm add mycashflow
yarn add mycashflow
bun add mycashflow
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.3.0 |
| Published | 2015-08-31 |
| First published | 2015-08-29 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| Author | Jukka Koskinen |
| Maintainers | jukkakoskinen |

## Links

- npm: https://www.npmjs.com/package/mycashflow
- npm.io page: https://npm.io/package/mycashflow

## Dependencies (1)

- [superagent](https://npm.io/package/superagent.md) ^1.3.0

## Recent versions

- 0.3.0 (latest) — 2015-08-31
- 0.2.0 — 2015-08-29

## README

# MyCashflow API

A simple node module for working with the MyCashflow API. Please consult the original browseable documentation for more technical insight on API details.

### Usage

First, require the node module:

	var MyCashflow = require('mycashflow');

Configure through `env vars`:

	export MYCASHFLOW_API_USER = x
	export MYCASHFLOW_API_KEY  = y
	export MYCASHFLOW_API_URI  = z

	var myCashflow = new MyCashflow();

Or pass a configuration object:

	var myCashflow = new MyCashflow({
		user:   ..., // Shop API user
		apiKey: ..., // Shop API key
		apiUri: ...  // Shop API endpoint (https://shop.com/api/v1/)
	});

Pass `debug: true` to enable console output.

### Implemented Resources

The client conforms to MyCashflow API version 0.4.0.

* Brands
	* get
	* list
	* create
	* update
	* delete
* Categories
	* list
	* get
	* update
	* subcategories
* Customers
	* get
	* list
	* update
	* secondaryAddresses
* Customer Groups
	* list
	* get
	* create
	* update
	* delete
* Products
	* get
	* list
	* update
* Stock
	* get
	* list
	* update
* Suppliers
	* get
	* list
	* create
	* update
	* delete
* Variations
	* get
	* list
	* update
* Versions
	* get
	* list

### Development

Running the tests:

	npm test

---
_Source: https://npm.io/package/mycashflow · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._