holded
Holded is a business management software.
Usage
import { holded } from 'netzo/apis/holded.ts'
const api = holded({
apiKey: Deno.env.get('HOLDED_API_KEY')
})
Configuration
The holded factory function expects an object with the following, and returns an object with an API client api.
| Param | Type | Default | Description |
|---|---|---|---|
apiKey | string | Deno.env.get('HOLDED_API_KEY') | the api key to use for authentication |
Refer to the API documentation to get the required information.
Examples
The following examples assume you have created an api client instance.
Find contacts
Find all contacts that match the query.
const query: QueryContacts = {}
const resultData = await api.invoicing.v1.contacts.get<Contact[]>(query)
Get contact
Get a contact by id.
const resultData = await api.invoicing.v1.contacts[CONTACT_ID].get<Contact>()
Add contact
Add a new contact.
const data: DataAddContact = { name: 'New contact name' }
const resultData = await api.invoicing.v1.contacts.post<ContactResult>(data)
Update contact
Update a contact by id.
const data: DataUpdateContact = { name: 'Updated contact name' }
const resultData = await api.invoicing.v1.contacts[CONTACT_ID].put<ContactResult>(data)
Delete contact
Delete a contact by id.
const resultData = await api.invoicing.v1.contacts[CONTACT_ID].delete<ContactResult>()