Tax Authority Plug-in Interface Definition

Note:

To access the LATAM E-Document Certification SuiteApp documentation in Brazilian Portuguese (Português do Brasil), see LATAM E-Document Certification.

The plug-in interface includes the following interface functions and interface objects:

Interface Function

Containing Interface Objects

buildMessage(context)

buildMessageContext, MessageResult

shouldRetryRequest(context)

shouldRetryRequestContext

readResponse(context)

readResponseContext, ClientResponse, DocumentResponseResult

getNextRequest(context)

getNextRequestContext, DocumentResponseResult, NextRequestResult

postProcess(context)

postProcessContext, DocumentResponseResult, PostProcessResult

getDocumentNumberAndSeries(context)

GetDocumentNumberAndSeriesResult

modifyDocumentXmlBeforeSign(context)

modifyDocumentXmlBeforeSignContext

modifyReqPropertiesBeforeSend(context)

modifyReqPropertiesBeforeSendContext, modifyReqPropertiesBeforeSendResult

getTagsToRemoveFromLog()

-

generateTaxAuthPDF(context)

generateTaxAuthPDFContext, generateTaxAuthPDFResult, generatedPDFDetail

modifyDocumentXmlAfterSign(context)

modifyDocumentXmlAfterSignContext, SignedTag

checkWsAvailability(context)

checkWsAvailabilityContext, WsAvailabilityResult

The tax authority plug-in is invoked when you send an e-document for certification.

The following diagram shows the workflow for the certification process:

                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     

General Notices