API Alegra Proveedor Electrónico Colombia

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for FernandoPiDi from gravatar.com FernandoPiDi

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Author: Duvan Fernando Pinto Diaz
  • Tags OpenAPI , OpenAPI-Generator , API Alegra Proveedor Electrónico Colombia
Report project as malware

Project description

alegra-sdk-python

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: 1
  • Package version: 1.0.0
  • Generator version: 7.11.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.8+

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 openapi_client

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 openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://sandbox-api.alegra.com/e-provider/col/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "https://sandbox-api.alegra.com/e-provider/col/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization: auth
configuration = openapi_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.CorreosRecepcinApi(api_client)
    nit = 'nit_example' # str | Nit de la empresa

    try:
        # Endpoint para la consulta del correo electrónico registrado por el facturador para la recepción de facturas electrónicas
        api_response = api_instance.get_reception_emails(nit)
        print("The response of CorreosRecepcinApi->get_reception_emails:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling CorreosRecepcinApi->get_reception_emails: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://sandbox-api.alegra.com/e-provider/col/v1

Class Method HTTP request Description
CorreosRecepcinApi get_reception_emails GET /reception-emails/{nit} Endpoint para la consulta del correo electrónico registrado por el facturador para la recepción de facturas electrónicas
DianApi get_contrat_types GET /dian/contract-types Endpoint para obtener la tabla de la DIAN con los tipos de contratos disponibles
DianApi get_correction_concept_codes_nc GET /dian/correction-concept-codes-nc Endpoint para obtener la tabla de la DIAN con los tipos de concepto de corrección para notas crédito disponibles
DianApi get_correction_concept_codes_nd GET /dian/correction-concept-codes-nd Endpoint para obtener la tabla de la DIAN con los tipos de concepto de corrección para notas débito disponibles
DianApi get_countries GET /dian/countries Endpoint para obtener la tabla de la DIAN con los países disponibles
DianApi get_currencies GET /dian/currencies Endpoint para obtener la tabla de la DIAN con las monedas disponibles
DianApi get_departments GET /dian/departments Endpoint para obtener la tabla de la DIAN con los departamentos disponibles
DianApi get_employee_sub_types GET /dian/employee-sub-types Endpoint para obtener la tabla de la DIAN con los subtipos de empleados disponibles
DianApi get_employee_types GET /dian/employee-types Endpoint para obtener la tabla de la DIAN con los tipos de empleados disponibles
DianApi get_extra_hour_types GET /dian/extra-hour-types Endpoint para obtener la tabla de la DIAN con los tipos de hora extra disponibles
DianApi get_fiscal_responsability_types GET /dian/fiscal-Responsability-types Endpoint para obtener la tabla de la DIAN con los tipos de régimen/responsabilidades fiscales disponibles
DianApi get_health_benefits_plan_types GET /dian/health-benefits-plan-types Endpoint para obtener la tabla de la DIAN con los tipos de cobertura o plan de beneficios (Sector Salud) disponibles
DianApi get_health_identification_types GET /dian/health-identification-types Endpoint para obtener la tabla de la DIAN con los tipos de documento de identificación del usuario (Sector Salud) disponibles
DianApi get_health_payment_methods GET /dian/health-payment-methods Endpoint para obtener la tabla de la DIAN con los tipos de modalidades de pago (Sector Salud) disponibles
DianApi get_health_user_types GET /dian/health-user-types Endpoint para obtener la tabla de la DIAN con los tipos de usuario (Sector Salud) disponibles
DianApi get_identification_types GET /dian/identification-types Endpoint para obtener la tabla de la DIAN con los tipos de identificación disponibles
DianApi get_inhability_types GET /dian/inability-types Endpoint para obtener la tabla de la DIAN con los tipos de incapacidad disponibles
DianApi get_languages GET /dian/languages Endpoint para obtener la tabla de la DIAN con los lenguajes disponibles
DianApi get_municipalities GET /dian/municipalities Endpoint para obtener la tabla de la DIAN con los municipios disponibles
DianApi get_organization_types GET /dian/organization-types Endpoint para obtener la tabla de la DIAN con los tipos de organización jurídica disponibles
DianApi get_payment_forms GET /dian/payment-forms Endpoint para obtener la tabla de la DIAN con las formas de pago disponibles
DianApi get_payment_methods GET /dian/payment-methods Endpoint para obtener la tabla de la DIAN con los métodos de pago disponibles
DianApi get_payroll_periods GET /dian/payroll-periods Endpoint para obtener la tabla de la DIAN con los periodos de nómina disponibles
DianApi get_tax_types GET /dian/tax-types Endpoint para obtener la tabla de la DIAN con los tipos de tributos/impuestos disponibles
DianApi get_unit_codes GET /dian/unit-codes Endpoint para obtener la tabla de la DIAN con los tipos de unidades de cantidad disponibles
DocumentosEquivalentesElectrnicosApi adjustment_note_equivalent_document_file GET /adjustment-note-equivalent-documents/{id}/files/{fileType} Endpoint para obtener un archivo asociado a la nota de ajuste al documento equivalente electrónico
DocumentosEquivalentesElectrnicosApi create_adjustment_note_equivalent_document POST /adjustment-note-equivalent-documents Endpoint para emitir una nota de ajuste al documento equivalente electrónico a la DIAN
DocumentosEquivalentesElectrnicosApi create_equivalent_document_pos POST /equivalent-documents/pos Emisión Documento Equivalente POS a la DIAN
DocumentosEquivalentesElectrnicosApi get_adjustment_note_equivalent_document GET /adjustment-note-equivalent-documents/{id} Endpoint para consultar una nota de ajuste al documento equivalente electrónico
DocumentosEquivalentesElectrnicosApi get_equivalent_document_pos GET /equivalent-documents/{id} Endpoint para consultar un documento equivalente electrónico
DocumentosEquivalentesElectrnicosApi get_equivalent_document_pos_file GET /equivalent-documents/{id}/files/{fileType} Endpoint para obtener un archivo asociado al documento equivalente electrónico
DocumentosSoporteElectrnicosApi adjustment_note_support_document_file GET /adjustment-note-support-documents/{id}/files/{fileType} Endpoint para obtener un archivo asociado a la nota de ajuste al documento soporte electrónico
DocumentosSoporteElectrnicosApi create_adjustment_note_support_document POST /adjustment-note-support-documents Endpoint para emitir una nota de ajuste al documento soporte electrónico a la DIAN
DocumentosSoporteElectrnicosApi create_support_document POST /support-documents Endpoint para emitir un documento soporte electrónico a la DIAN
DocumentosSoporteElectrnicosApi get_adjustment_note_support_document GET /adjustment-note-support-documents/{id} Endpoint para consultar una nota de ajuste al documento soporte electrónico
DocumentosSoporteElectrnicosApi get_support_document GET /support-documents/{id} Endpoint para consultar un documento soporte electrónico
DocumentosSoporteElectrnicosApi get_support_document_file GET /support-documents/{id}/files/{fileType} Endpoint para obtener un archivo asociado al documento soporte electrónico
DocumentosSoporteElectrnicosApi get_support_documents GET /support-documents Endpoint para consultar documentos soporte electrónicos
EmpresasApi create_company POST /companies Endpoint para dar de alta a una empresa
EmpresasApi get_companies GET /companies Endpoint para consultar el listado de empresas
EmpresasApi get_company GET /companies/{id} Endpoint para consultar la información de una empresa
EmpresasApi get_self_company GET /company Endpoint para consultar la información de la empresa asociada al token
EmpresasApi update_company PATCH /companies/{id} Endpoint para actualizar la información de una empresa
EmpresasApi update_self_company PATCH /company Endpoint para actualizar la información de la empresa asociada al token
EnvioCorreoElectrnicoApi send_email_post POST /send-email Endpoint para enviar una notificación de un documento electrónico por correo
EventosElectrnicosApi create_event POST /events Endpoint para emitir un evento relacionado a una factura electrónica
EventosElectrnicosApi create_event_from_xml POST /events/from-xml Endpoint para emitir un evento relacionado a una factura electrónica a partir de su AttachedDocument
EventosElectrnicosApi get_event GET /events/{id} Endpoint para consultar la información de un evento por su id
EventosElectrnicosApi get_event_file GET /events/{id}/files/{fileType} Endpoint para obtener un archivo asociado a un evento electrónico
EventosElectrnicosApi get_invoice_events GET /events/invoice/{cufe} Endpoint para consultar los eventos asociados a una factura hasta la fecha
FacturasDeVentaElectrnicasApi create_invoice POST /invoices Endpoint para emitir una factura electrónica a la DIAN
FacturasDeVentaElectrnicasApi get_invoice GET /invoices/{id} Endpoint para consultar una factura electrónica
FacturasDeVentaElectrnicasApi get_invoice_file GET /invoices/{id}/files/{fileType} Endpoint para obtener un archivo asociado a la factura electrónica
FacturasDeVentaElectrnicasApi get_invoices GET /invoices Endpoint para consultar facturas electrónicas
NminasElectrnicasApi adjust_payroll POST /payrolls/{id}/replace Endpoint para reemplazar/ajustar una nómina electrónica
NminasElectrnicasApi cancel_payroll POST /payrolls/{id}/cancel Endpoint para anular una nómina electrónica
NminasElectrnicasApi create_payroll POST /payrolls Endpoint para emitir una nómina a la DIAN
NminasElectrnicasApi get_payroll GET /payrolls/{id} Endpoint para consultar una nómina electrónica
NminasElectrnicasApi get_payroll_adjustments GET /payroll-adjustments Endpoint para consultar ajustes de nóminas electrónicas
NminasElectrnicasApi get_payroll_cancellations GET /payroll-cancellations Endpoint para consultar cancelaciones de nóminas electrónicas
NminasElectrnicasApi get_payroll_file GET /payrolls/{id}/files/{fileType} Endpoint para obtener un archivo asociado a la nómina electrónica
NminasElectrnicasApi get_payrolls GET /payrolls Endpoint para consultar nóminas electrónicas
NotasCrditoElectrnicasApi create_credit_note POST /credit-notes Endpoint para emitir una nota crédito electrónica a la DIAN
NotasCrditoElectrnicasApi get_credit_note GET /credit-notes/{id} Endpoint para consultar una nota crédito electrónica
NotasCrditoElectrnicasApi get_credit_note_file GET /credit-notes/{id}/files/{fileType} Endpoint para obtener un archivo asociado a la nota crédito electrónica
NotasCrditoElectrnicasApi get_credit_notes GET /credit-notes Endpoint para consultar notas crédito electrónicas
NotasDbitoElectrnicasApi create_debit_note POST /debit-notes Endpoint para emitir una nota débito electrónica a la DIAN
NotasDbitoElectrnicasApi get_debit_note GET /debit-notes/{id} Endpoint para consultar una nota débito electrónica
NotasDbitoElectrnicasApi get_debit_note_file GET /debit-notes/{id}/files/{fileType} Endpoint para obtener un archivo asociado a la nota débito electrónica
NotasDbitoElectrnicasApi get_debit_notes GET /debit-notes Endpoint para consultar notas débito electrónicas
ReportsApi get_daily_document_report GET /reports/daily Endpoint para obtener un reporte de emisiones por día
ResolucionesApi get_resolutions GET /resolutions/{nit} Endpoint para la consulta de Rangos de Numeración registrados en la DIAN (Resoluciones)
SetsDePruebasApi create_test_set POST /test-sets Endpoint para crear un set de pruebas
SetsDePruebasApi get_test_set GET /test-sets/{id} Endpoint para consultar la información de un set de pruebas
SetsDePruebasApi get_test_set_by_government_id GET /test-sets Endpoint para consultar un set de pruebas por governmentId

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

auth

  • Type: Bearer authentication

Author

Project details

Verified details

These details have been verified by PyPI
Maintainers
Avatar for FernandoPiDi from gravatar.com FernandoPiDi

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT
  • Author: Duvan Fernando Pinto Diaz
  • Tags OpenAPI , OpenAPI-Generator , API Alegra Proveedor Electrónico Colombia

Release history Release notifications | RSS feed

This version

1.0.6

1.0.5

1.0.4

1.0.3

1.0.2

1.0.1

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

alegra_sdk_python-1.0.6-py3-none-any.whl (587.0 kB view details)

Uploaded Python 3

File details

Details for the file alegra_sdk_python-1.0.6-py3-none-any.whl.

File metadata

File hashes

Hashes for alegra_sdk_python-1.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 65fe119b03748872ea765ea3c6fe7c92ad32bab95e22bcfa5181dbd98c07b71d
MD5 0ca10bb96ac544a195261e1bcf97d348
BLAKE2b-256 9398f93188fc39a77befc651f1da3d4c147b5147e70edfcecb823b2b80bb93da

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page