DOCUMENTATION

Searching documents by reference

Page Content
Introduction
Input format
Output format

Name: ListarDocPorReferencia

This function is intended to consult the registered documents by the reference.

There is a limitation on the number of queries allowed per hour. By exceeding this amount, webservices returns error 192 - Query number per hour exceeded.

Input format:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
    <sessao>XXXX</sessao> 
    <documentos>
            <referencia>XXXX</referencia>
            <referencia>YYYY</referencia>
            <referencia>ZZZZ</referencia>
    </documentos>
</documentoeletronico>

Parameter	Format	Required	Description
sessao	Text	Y	Registered access key for your company.
documentos	Text	Y	Node for defining documents to be inserted.
referencia	Text	Y	Reference of a document or a list of document references. NOTE: If you use a list of document references, it must contain a maximum of 50 references per call, so that there is no timeout in the consultation.

Output format:

<?xml version="1.0" encoding="ISO-8859-1" ?>
<documentoeletronico>
    <CodErro />
    <MsgErro />
        <documentos>
        <documento docto_referencia="" docto_status="" docto_validade="" />
        <documento docto_referencia="" docto_status="" docto_validade="" />
        </documentos>
</documentoeletronico>

Parameter	Format	Description
CodErro	Numeric	Error code (See Error Codes).
MsgErro	Text	Error message.
docto_referencia	Text	Document reference.
docto_status	Text	Document status. Possible values: A - In force/Active; B - Blocked; C - Canceled; D - Defining Roles; E - Error in closing a party; It can occur in two situations: 1 - A party was without a representative to make a signature. Example: It was defined that a representative signs two different parties with the same CNPJ. At the time the representative signs the first part, it is automatically removed from the second part, the latter party being without a representative. The contract will enter status "E", error, warning that a party is without a representative; 2 - Insufficient number of signatures in the party. Example: Client uses minimum signatures for party closure. A minimum quantity of two signatures was defined for a particular relationship, but in the contract only one representative was included in the party. At the moment the representative makes the signature, the contract will enter the status "E", error, warning that this part can not be closed due to the minimum amount of requested signature. G - Waiting for activation of another contract; P - Pending signature/approval/acceptance; R - Refused; T - Waiting for Time Stamp; V - Expired.
docto_validade	Text	Expiring date of the document.

Back to Searching relationship of the document Canceling the document