Skip to content

EcuaByte-lat/ecuapi-sdk-python

Repository files navigation

ecuapi-sdk-python

API for electronic invoicing in Ecuador. Generate, sign, and send invoices to SRI.

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.18.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://ecuapi.com

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import ecuapi

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import ecuapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ecuapi
from ecuapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.ecuapi.com
# See configuration.py for a list of all supported configuration parameters.
configuration = ecuapi.Configuration(
    host = "https://api.ecuapi.com"
)



# Enter a context with an instance of the API client
with ecuapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ecuapi.CertificatesApi(api_client)

    try:
        # List certificates
        api_response = api_instance.list_certificates()
        print("The response of CertificatesApi->list_certificates:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CertificatesApi->list_certificates: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.ecuapi.com

Class Method HTTP request Description
CertificatesApi list_certificates GET /v1/certificates List certificates
CertificatesApi upload_certificate POST /v1/certificates/upload Upload P12 certificate
HealthApi get_api_info GET /health Basic health check
HealthApi get_api_info_0 GET /v1/health Basic health check
HealthApi get_detailed_health GET /health/health Detailed health check
HealthApi get_detailed_health_0 GET /v1/health/health Detailed health check
InvoicesApi authorize_invoice POST /v1/invoices/{id}/authorize Authorize invoice
InvoicesApi create_invoice POST /v1/invoices Create invoice
InvoicesApi get_invoice GET /v1/invoices/{id} Get invoice by ID
InvoicesApi get_invoice_pdf GET /v1/invoices/{id}/pdf Download RIDE PDF
InvoicesApi get_invoice_xml GET /v1/invoices/{id}/xml Download signed XML
InvoicesApi list_invoices GET /v1/invoices List invoices
InvoicesApi send_invoice POST /v1/invoices/{id}/send Send invoice to SRI
InvoicesApi void_invoice DELETE /v1/invoices/{id} Void invoice

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

support@ecuabyte.lat

About

Python SDK for ECUAPI

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published