API di eliminazione documento a seguito scarto o presa visione scarto

Questa API permette va richiamata a seguito di uno scarto del documento emesso. Lo scarto può avvenire nei seguenti casi:

  • in fase di elaborazione da parte della piattaforma (per un errore formale sul formato del documento)
  • a seguito di uno scarto da parte del sistema di interscambio SDI 
  • da parte della pubblica amministrazione destinataria (rifiuto da parte della PA).

Nel caso di scarto, se si desidera rimandare il documento con stessa data e numero, è necessario preventivamente chiamare l'API di eliminazione, per non incorrere nell'errore di "documento duplicato già presente".

A seguito della chiamata a questa API il documento viene automaticamente posto prima "in corso eliminazione" e poi in stato "eliminato". Sin da subito (stato in corso eliminazione) è già possibile rimandare il documento.

L'eliminazione del documento può essere di tipo logico o fisico e viene automaticamente gestita dal sistema. L'eliminaizione fisica avviene solo se il documento non è già passato da SDI. Infatti se il documento è già transitato per il sistema di interscambio ed è stato scartato da SDI oppure della pubblica amministrazione, il documento non viene fisicamente eliminato ma viene posto in conservazione in stato scartato.

Parametri della richiesta

Url: [base url]/webservices/DeleteDocument.svc

Wsdl: [base url]/webservices/DeleteDocument.svc?wsdl

 

username   username dall'azienda
password   password dell'azienda
identificativiInternoDocumento   un array degli identificativi documento da eliminare. Uno o più di uno. Gli identificativi possono essere recuperati tramite API Interrogazione stato di un documento emesso
     
Esempio richiesta
<soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:tem="http://tempuri.org/" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soap:Header xmlns:wsa="http://www.w3.org/2005/08/addressing"><wsa:Action>http://tempuri.org/IDeleteDocument/Delete</wsa:Action><wsa:To>https://hubfatturazione.it/webservices/DeleteDocument.svc</wsa:To></soap:Header>
     <soap:Body>
      <tem:Delete>
         <tem:username>aaaaa</tem:username>
         <tem:password>bbbbb</tem:password>
         <tem:identificativiInternoDocumento>
            <!--Zero or more repetitions:-->
            <arr:string>?</arr:string>
         </tem:identificativiInternoDocumento>
      </tem:Delete>
   </soap:Body>
</soap:Envelope>
Esempio risposta
<s:Envelope xmlns:s="http://www.w3.org/2003/05/soap-envelope" xmlns:a="http://www.w3.org/2005/08/addressing">
   <s:Header>
      <a:Action s:mustUnderstand="1">http://tempuri.org/IDeleteDocument/DeleteResponse</a:Action>
   </s:Header>
   <s:Body>
      <DeleteResponse xmlns="http://tempuri.org/">
         <DeleteResult xmlns:b="http://schemas.datacontract.org/2004/07/WT.FEHub.Common.Models" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <b:Message></b:Message>
            <b:ResultCode>200</b:ResultCode>
            <b:Success>true</b:Success>
         </DeleteResult>
      </DeleteResponse>
   </s:Body>
</s:Envelope>

Parametri risposta:

Success: true operazione eseguita correttamente / false errore (vedere Message)