DOCUMENTATION

Deleting the document

Name: DocumentoExcluir

This function is intended to exclude documents by informing the reference or passcode of the documents.

Input format:

  • Using reference:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
    <sessao>XXXX</sessao> 
    <documentos>
    <docto_sistema_codigo>10</docto_sistema_codigo><referencia>XX</referencia>
    <docto_sistema_codigo>5</docto_sistema_codigo><referencia>YY</referencia>
    </documentos>
</documentoeletronico>
  • Using passcode:
<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
        <sessao>XXXX</sessao> 
        <documentos>
            <passcode>RKILF-FG4FR-TCDEW-57RFE</passcode>
            <passcode>AKILX-HT4FR-ACDE1-47ZF1</passcode>
        </documentos>
</documentoeletronico>
Parameter Format Required Description
sessao Text Y Registered access key for your company.
documentos Text Y Node for defining documents to be deleted.
docto_sistema_codigo Numeric N Document Type. Possible values:
5 - Electronic Contract
10- Digital Report
Note: if not informed, assume 5.
referencia Text N List of document references.
passcode Text N List of document passcodes.

Output format:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
    <CodErro />
    <MsgErro />
    <documentos>
            <documento docto_sistema_codigo="" docto_referencia="" docto_passcode="" docto_excluido="" />
    </documentos>
</documentoeletronico>
Parameter Format Description
CodErro Numeric Error code (See Error Codes).
MsgErro Text Error message.
docto_sistema_codigo Numeric Document Type. Possible values:
5 - Electronic Contract
10 - Digital Report
docto_referencia Text Document reference.
docto_passcode Text Document passcode.
docto_excluido Text Deletion status of the document Possible values: S (document deleted) or N (not deleted).