Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gearplug/alegra-python
alegra-python is an API wrapper for Alegra (accounting software), written in Python
https://github.com/gearplug/alegra-python
accounting accounts alegra api contacts inventory invoices python requests taxes wrapper
Last synced: 3 days ago
JSON representation
alegra-python is an API wrapper for Alegra (accounting software), written in Python
- Host: GitHub
- URL: https://github.com/gearplug/alegra-python
- Owner: GearPlug
- License: mit
- Created: 2023-01-12T14:51:59.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-03-27T19:58:17.000Z (over 1 year ago)
- Last Synced: 2023-05-25T02:26:58.868Z (over 1 year ago)
- Topics: accounting, accounts, alegra, api, contacts, inventory, invoices, python, requests, taxes, wrapper
- Language: Python
- Homepage:
- Size: 18.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# alegra-python
 
*alegra-python* is an API wrapper for Alegra (accounting software), written in Python
## Installing
```python
pip install alegra-python
```
## Usage
```python
from alegra.client import Client
client = Client(email, token)
```
### Get company information (Compañía)
```python
company = client.get_company_info()
```
### Get current user (Usuario)
```python
user = client.get_current_user()
```
### Contacts
#### - List contacts (Contactos)
```python
contacts = client.list_contacts(order_field=None, order="ASC", limit=None, start=None)
# order options = "ASC" or "DESC"
# Max limit = 30
```
#### - Get contact by id
```python
contact = client.get_contact(contact_id, extra_fields=None)
# extra_fields current options are: 'statementLink', 'url' or 'statementLink,url'
```
#### - Create Contact (Contacto)
```python
contacto = {
"address": {"city": "Villavicencio", "address": "Calle 10 #01-10"},
"internalContacts": [
{
"name": "Lina",
"lastName": "Montoya",
"email": "[email protected]",
}
],
"name": "Lina Montoya",
"identification": "1018425711",
"mobile": "38845555610",
"seller": 1,
"priceList": 1,
"term": 1,
"email": "[email protected]",
"type": "client"
}
contact = client.create_contact(contacto)
```
#### - List sellers (Vendedores)
```python
vendedores = client.list_sellers()
```
### Inventory
#### - List items (Items)
```python
items = client.list_items(order_field=None, order="ASC", limit=None, start=None)
# order options = "ASC" or "DESC"
# Max limit = 30
```
#### - Create item (Item)
```python
item = {
"name": "PS5",
"description": "Play Station 5",
"reference": "PS5 nuevo",
"price": 3750000,
"category": {"id": 5064},
"inventory": {
"unit": "unit",
"unitCost": 40000,
"negativeSale": False,
"warehouses": [{"initialQuantity": 4, "id": 1, "minQuantity": 2, "maxQuantity": 10}],
},
"tax": 2,
"type": "product",
"customFields": [{"id": 1, "value": "BHUJSK888833"}, {"id": 2, "value": 44}, {"id": 3, "value": 44.45}],
"itemCategory": {"id": 1}
}
item_created = client.create_item(item)
```
#### - List item Categories (Categorias de items)
```python
item_categorias = client.list_item_categories()
```
#### - List Warehouses (Bodegas)
```python
bodegas = client.list_warehouses()
```
#### - List Item Custom Fields (Campos adicionales)
```python
campos = client.list_item_custom_fields()
```
#### - List Variant Attributes (Variantes)
```python
atributos_variantes = client.list_variant_attributes()
```
#### - List price lists (Lista de precios)
```python
lista_precios = client.list_price_lists()
```
### Invoices
#### - List invoices (Facturas de venta)
```python
items = client.list_invoices(order_field=None, order="ASC", limit=None, start=None, date=None)
# order options = "ASC" or "DESC"
# Max limit = 30
# Date format YYYY-MM-DD
```
### Terms
#### - List Terms (Condiciones de pago)
```python
condiciones = client.list_terms()
```
### Taxes
#### - List Taxes (Impuestos)
```python
impuestos = client.list_taxes()
```
### Accounts
#### - List Accounts (Cuentas)
```python
cuentas = client.list_accounts(format_acc="tree", type_acc=None)
# format_acc options = "tree" or "plain"
# type_acc options = "income", "expense", "asset", "liability" or "equity"
```