O Extrato de Serviço consolida uma ou mais ordens de serviço do mesmo cliente em um relatório que pode ser enviado como uma forma de prestar contas pelos serviços realizados.

Com o serviço web SOAP (Simple Object Access Protocol), é possível integrar o seu ERP ao Procedo e realizar operações de modo automático. Este recurso é utilizado para fazer integração e/ou automatização de processos de qualquer sistema com o Procedo.

Nome: extratoservicoservice

Tecnologia: Webservice SOAP

URL WSDL: https://app.procedo.com.br/api/extratoservicoservice?wsdl

Objetivo: Webservice que realiza operações vinculadas ao Extrato de Serviço.

Observação: solicite seu token de segurança para utilizar os métodos do webservice [email protected]

Métodos

Método: listaExtratoServico

Descrição: método responsável por retornar uma relação de extratos de serviços.

Parâmetro  Obrigatório Formato Descrição
token sim String Identificado único da empresa para uso do método.
situação sim Int 1=Retorna todos os registros pendentes de integração

2=Retorna registros com situação “Paga” e pendentes de integração

Retorno

A tabela abaixo indica os possíveis retornos de erros ou confirmação para o método listaExtratoServico. Esse retorno está visível no nível 5 do XML.

Código Retorno
0 Token inválido, neste caso, é necessário entrar em contato novamente para obter o código de acesso
1 Ok
2 Situação inválida, somente 1 ou 2
9 Nenhum registro encontrado
35 Empresa sem acesso a funcionalidade solicitada

Exemplo

Exemplo de requisição para obter todos os Extratos de Serviços pendentes de integração:

<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:SOAPServerWSDL">
    <x:Header/>
    <x:Body>
        <urn:listaExtratoServico>
            <urn:token>[token fornecido]</urn:token>
            <urn:situacao>1</urn:situacao>
        </urn:listaExtratoServico>
    </x:Body>
</x:Envelope>

Agora, o exemplo de retorno com sucesso:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://localhost.procedo.com.br/api/extratoservicoservice?wsdl">
    <SOAP-ENV:Body>
        <ns1:listaExtratoServicoResponse xmlns:ns1="urn:SOAPServerWSDL">
            <return xsi:type="xsd:string">1</return>
            <mensagem xsi:type="xsd:int">OK</mensagem>
            <resultados xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:ExtratoServico[1]">
                <item xsi:type="tns:ExtratoServico">
                    <codigo xsi:type="xsd:string">5</codigo>
                    <cod_emitente xsi:type="xsd:string">4780</cod_emitente>
                    <dtcadastro xsi:type="xsd:string">2018-01-09</dtcadastro>
                    <valor_parcelas xsi:type="xsd:string">7000.00</valor_parcelas>
                    <valor_apontamentos xsi:type="xsd:string">0.00</valor_apontamentos>
                    <valor_despesas xsi:type="xsd:string">0.00</valor_despesas>
                    <valor_total xsi:type="xsd:string">7000.00</valor_total>
                    <parcelas xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Parcela[2]">
                        <item xsi:type="tns:Parcela">
                            <cod_projeto xsi:type="xsd:string">236</cod_projeto>
                            <nome_projeto xsi:type="xsd:string">A55AB7A1</nome_projeto>
                            <dtvencimento xsi:type="xsd:string">2017-08-15</dtvencimento>
                            <valor xsi:type="xsd:string">3500.00</valor>
                        </item>
                        <item xsi:type="tns:Parcela">
                            <cod_projeto xsi:type="xsd:string">236</cod_projeto>
                            <nome_projeto xsi:type="xsd:string">QQ7R5559A</nome_projeto>
                            <dtvencimento xsi:type="xsd:string">2017-09-15</dtvencimento>
                            <valor xsi:type="xsd:string">3500.00</valor>
                        </item>
                    </parcelas>
                    <ordens xsi:type="SOAP-ENC:Array" SOAP-ENC:arrayType="tns:Ordem[1]">
                        <item xsi:type="tns:Ordem">
                            <cod_os xsi:type="xsd:string">7</cod_os>
                            <cod_projeto xsi:type="xsd:string">236</cod_projeto>
                            <data xsi:type="xsd:string">2018-01-09</data>
                            <horas xsi:type="xsd:string">1.00</horas>
                            <despesas xsi:nil="true" xsi:type="xsd:string"/>
                        </item>
                    </ordens>
                </item>
            </resultados>
        </ns1:listaExtratoServicoResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Cada nó “item” do tipo “ExtratoServico” é um extrato retornado. Cada linha nesse nó faz parte dos dados do extrato.

Método: gravaRetExtrato

Descrição: método responsável por “marcar” o extrato de serviço como integrado. Esse método fará com que o registro do Extrato de Serviço no Procedo não seja integrado novamente pelo método listaExtratoServico.

Parâmetro  Obrigatório Formato Descrição
token sim String Identificado único da empresa para uso do método
codigo sim Int Código do Extrato no Procedo
nota_fiscal não String Código da nota fiscal para ser integrado no Proceodo
mensagem não String
Informa ao sistema Procedo que não foi possível gravar no sistema externo o cliente correspondente
O campo “mensagem” só deverá ser preenchido caso ocorra algum erro.  Os erros serão gravados em “Log de integração” e os usuários marcados como “Responsável técnico” receberão uma notificação por e-mail sobre o erro. Os registros com erros  não sairão mais no método listaOportunidade enquanto estiver no “Log de integração”.

Retorno

Código Retorno
0 Token inválido, neste caso, é necessário entrar em contato novamente para obter o código de acesso
1 Ok, o registro foi inserido ou atualizado
9 Extrato de Serviço não encontrado no Procedo
99 Erro ao atualizar o Extrato de Serviço
35 Empresa sem acesso a funcionalidade solicitada

Exemplo

<x:Envelope xmlns:x="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:SOAPServerWSDL">
    <x:Header/>
    <x:Body>
        <urn:gravaRetExtrato>
            <urn:token>[token]</urn:token>
            <urn:codigo_extrato>200</urn:codigo_extrato>            
        </urn:gravaRetExtrato>
    </x:Body>
</x:Envelope>

Retorno com sucesso:

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:SOAP-ENC="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:gravaRetExtratoServicoResponse xmlns:ns1="urn:SOAPServerWSDL">
            <return xsi:type="xsd:string">1</return>
            <mensagem xsi:type="xsd:string">Registro inserido/atualizado com sucesso</mensagem>
        </ns1:gravaRetExtratoServicoResponse>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

 

Deixe uma resposta

O seu endereço de e-mail não será publicado. Campos obrigatórios são marcados com *