Netzo

🇺🇸 EN

🇪🇸 ES

🇺🇸 EN

🇪🇸 ES

Appearance

On this page
netzo/apis/facturama

Facturama ​

Facturama provides a cloud-based platform for the management of mexican electronic invoices, electronic receipts, and electronic payment receipts.

  • labels: accounting, invoicing, billing, finance
  • authentication: basic

Usage ​

ts
import { facturama } from 'https://deno.land/x/netzo/apis/facturama/mod.ts'

const { api } = facturama({
  username: Deno.env.get('FACTURAMA_USERNAME'),
  password: Deno.env.get('FACTURAMA_PASSWORD')
})
import { facturama } from 'https://deno.land/x/netzo/apis/facturama/mod.ts'

const { api } = facturama({
  username: Deno.env.get('FACTURAMA_USERNAME'),
  password: Deno.env.get('FACTURAMA_PASSWORD')
})

Configuration ​

The facturama factory function expects an object with the following, and returns an object with an HTTP client api.

ParamTypeDefaultDescription
usernamestringDeno.env.get('FACTURAMA_USERNAME')Facturama username
passwordstringDeno.env.get('FACTURAMA_PASSWORD')Facturama password

Refer to the API documentation to get the required information.

Examples ​

The following examples assume you have created an api client instance. Refer to the type definitions for all exported types to pass to the api client for typed responses.

Get product ​

Get a product by id.

ts
import type { Product } from 'netzo/apis/facturama/types.ts'

const resultData = await api.Product[PRODUCT_ID].get<Product>()
import type { Product } from 'netzo/apis/facturama/types.ts'

const resultData = await api.Product[PRODUCT_ID].get<Product>()

Add product ​

Add a new product.

ts
import type { DataAddProduct, Product } from 'netzo/apis/facturama/types.ts'

const data: DataAddProduct = {
  name: 'New Product',
  description: 'Product description',
  price: 100,
  unit: 'service'
}
const resultData = await api.Product.post<Product>(data)
import type { DataAddProduct, Product } from 'netzo/apis/facturama/types.ts'

const data: DataAddProduct = {
  name: 'New Product',
  description: 'Product description',
  price: 100,
  unit: 'service'
}
const resultData = await api.Product.post<Product>(data)

Update product ​

Update a product by id.

ts
import type { DataUpdateProduct } from 'netzo/apis/facturama/types.ts'

const data: DataUpdateProduct = { description: 'Updated description' }
await api.Product[PRODUCT_ID].put<void>(data)
import type { DataUpdateProduct } from 'netzo/apis/facturama/types.ts'

const data: DataUpdateProduct = { description: 'Updated description' }
await api.Product[PRODUCT_ID].put<void>(data)

Delete product ​

Delete a product by id.

ts
import type { Product } from 'netzo/apis/facturama/types.ts'

const resultData = await api.Product[PRODUCT_ID].delete<Product>()
import type { Product } from 'netzo/apis/facturama/types.ts'

const resultData = await api.Product[PRODUCT_ID].delete<Product>()

References ​

Copyright © 2023 Netzo