Go API client for ecuapi

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

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

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

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import ecuapi "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value ecuapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), ecuapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value ecuapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), ecuapi.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using ecuapi.ContextOperationServerIndices and ecuapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), ecuapi.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), ecuapi.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
CertificatesAPI	ListCertificates	Get /v1/certificates	List certificates
CertificatesAPI	UploadCertificate	Post /v1/certificates/upload	Upload P12 certificate
HealthAPI	GetApiInfo	Get /health	Basic health check
HealthAPI	GetApiInfo_0	Get /v1/health	Basic health check
HealthAPI	GetDetailedHealth	Get /health/health	Detailed health check
HealthAPI	GetDetailedHealth_0	Get /v1/health/health	Detailed health check
InvoicesAPI	AuthorizeInvoice	Post /v1/invoices/{id}/authorize	Authorize invoice
InvoicesAPI	CreateInvoice	Post /v1/invoices	Create invoice
InvoicesAPI	GetInvoice	Get /v1/invoices/{id}	Get invoice by ID
InvoicesAPI	GetInvoicePdf	Get /v1/invoices/{id}/pdf	Download RIDE PDF
InvoicesAPI	GetInvoiceXml	Get /v1/invoices/{id}/xml	Download signed XML
InvoicesAPI	ListInvoices	Get /v1/invoices	List invoices
InvoicesAPI	SendInvoice	Post /v1/invoices/{id}/send	Send invoice to SRI
InvoicesAPI	VoidInvoice	Delete /v1/invoices/{id}	Void invoice

Documentation For Models

• AuthorizeInvoiceResponse
• AuthorizeInvoiceResponseData
• Certificate
• CertificateError
• CertificateErrorError
• CertificateListResponse
• CertificateUploadResponse
• CertificateUploadResponseData
• CertificateUploadResponseMeta
• CreateInvoiceRequest
• CreateInvoiceResponse
• CreateInvoiceResponseData
• Customer
• Error
• ErrorError
• HealthResponse
• HealthResponseChecks
• Invoice
• InvoiceDetailResponse
• InvoiceItem
• InvoiceListResponse
• Meta
• SendInvoiceResponse
• SendInvoiceResponseData

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

• PtrBool
• PtrInt
• PtrInt32
• PtrInt64
• PtrFloat
• PtrFloat32
• PtrFloat64
• PtrString
• PtrTime

Author

support@ecuabyte.lat