Mensagens de Estado

As respostas são enviadas em XML CIUS MessageStatus versão 2.1, em que:

• O nome do ficheiro enviado pelo ilink segue a estrutura Response_{UUID_MESSAGE_STATUS}
• O elemento DocumentResponse>DocumentReference>ID contém o número do documento em causa
• O elemento DocumentResponse>DocumentReference>UUID contém o AdditionalDocumentReference>ID[schemeID=AIM] do documento em causa. Se não existir, este elemento não é enviado.

Nota: Se o documento recebido não puder ser lido (ficheiro corrompido, XML inválido), o ilink devolve ao emissor uma mensagem .txt com o título igual ao AS2_MESSAGE_ID do documento em causa, a indicar que não foi possível ler o ficheiro.

Nota: Se o envio do MessageStatus falhar, o ilink repete a tentativa no final do dia e continuará a tentar até o ficheiro ser entregue ao destinatário.

Exemplo de ficheiro de estados:

<?xml version="1.0" encoding="UTF-8"?>
<ubl:DocumentStatus xmlns:cac="urn:oasis:names:specification:ubl:schema:xsd:CommonAggregateComponents-2"
xmlns:cbc="urn:oasis:names:specification:ubl:schema:xsd:CommonBasicComponents-2"
xmlns:ubl="urn:oasis:names:specification:ubl:schema:xsd:DocumentStatus-2">
  <cbc:CustomizationID>urn:feap.gov.pt:MSGSTS_CIUS-PT:2.1</cbc:CustomizationID>
  <cbc:ID>Response_f02866d2-feeb-4f96-9320-d00507c0018a_6e098568-dfde-4835-87e9-28f6ca1b139d</cbc:ID>
  <cbc:IssueDate>2021-04-13</cbc:IssueDate>
  <cbc:IssueTime>09:06:41.0000000+01:00</cbc:IssueTime>
  <cac:SenderParty>
    <cac:PartyName>
      <cbc:Name>ENTIDADE PÚBLICA Nº 156</cbc:Name>
    </cac:PartyName>
    <cac:PostalAddress>
      <cac:Country>
        <cbc:IdentificationCode>PT</cbc:IdentificationCode>
      </cac:Country>
    </cac:PostalAddress>
    <cac:PartyTaxScheme>
      <cbc:CompanyID>PT614054128</cbc:CompanyID>
      <cac:TaxScheme>
        <cbc:ID>VAT</cbc:ID>
      </cac:TaxScheme>
    </cac:PartyTaxScheme>
    <cac:PartyLegalEntity>
      <cbc:RegistrationName>ENTIDADE PÚBLICA Nº 156</cbc:RegistrationName>
    </cac:PartyLegalEntity>
  </cac:SenderParty>
  <cac:ReceiverParty>
    <cac:PartyName>
      <cbc:Name>Serviços de Consultoria, Lda.</cbc:Name>
    </cac:PartyName>
    <cac:PostalAddress>
      <cac:Country>
        <cbc:IdentificationCode>PT</cbc:IdentificationCode>
      </cac:Country>
    </cac:PostalAddress>
    <cac:PartyTaxScheme>
      <cbc:CompanyID>PT547570692</cbc:CompanyID>
      <cac:TaxScheme>
        <cbc:ID>VAT</cbc:ID>
      </cac:TaxScheme>
    </cac:PartyTaxScheme>
    <cac:PartyLegalEntity>
      <cbc:RegistrationName>Serviços de Consultoria, Lda.</cbc:RegistrationName>
    </cac:PartyLegalEntity>
  </cac:ReceiverParty>
  <cac:DocumentResponse>
    <cac:Response>
      <cbc:ResponseCode>11</cbc:ResponseCode>
    </cac:Response>
    <cac:DocumentReference>
      <cbc:ID>ZM 02/7000009232102</cbc:ID>
      <cbc:UUID>f02866d2-feeb-4f96-9320-d00507c0018a</cbc:UUID>
      <cbc:IssueDate>2021-03-10</cbc:IssueDate>
      <cbc:DocumentTypeCode>380</cbc:DocumentTypeCode>
    </cac:DocumentReference>
  </cac:DocumentResponse>
</ubl:DocumentStatus>

Lista de estados

Os MessageStatus do ilink incluem os estados EDI definidos pela eSPap no elemento DocumentResponse>Response>ResponseCode:

Código	Descrição
ACCEPTED	Documento passou pela validação de XML e regras de qualidade, foi integrado no sistema e enviado ao recetor
ERROR	Documento não passou pela validação inicial de qualidade (XML inválido, campos obrigatórios em falta, regras do recetor não cumpridas, etc.)
14	Documento recusado pelo recetor e a aguardar regularização (deve ser retificado e reenviado, ou substituído por nota de crédito/débito)
22	Documento devolvido pelo recetor e deverá ser anulado; deve ser emitido novo documento
33	Documento em pagamento
29	Documento pago
11	Documento processado pelo recetor (aceite)
30	Nota de crédito aceite pelo recetor

Nota: Os estados ERROR, 14 e 22 incluem a descrição do erro em DocumentResponse>Response>Description. Embora os estados 33 e 29 não sejam enviados pelo ilink, estes são recebidos e interpretados corretamente pelo sistema.

Fluxo de estados EDI

Possíveis fluxos que um documento pode seguir:

Descrição	Processo
Documento chegou ao ilink e não passou a validação das regras semânticas do XML ou controlo de qualidade (erro CIUS-PT, campos obrigatórios em falta, ligação inexistente).	ERROR
Documento chegou ao ilink e passou na validação XML, sendo enviado ao recetor.	ACCEPTED
Documento chegou ao ilink, validou corretamente e chegou ao destinatário, mas o recetor não integrou no sistema e pediu regularização (emissão de nota de crédito ou reenvio retificado).	ACCEPTED > 14
Documento chegou ao ilink, validou corretamente e chegou ao destinatário, mas foi devolvido, obrigando à emissão de novo documento.	ACCEPTED > 22
Documento chegou ao ilink, validou corretamente e foi integrado no sistema contabilístico do recetor.	ACCEPTED > 11
Nota de crédito chegou ao ilink, validou corretamente e foi integrada no sistema do recetor para ajuste de caixa.	ACCEPTED > 30

Reenvio de documentos

Um documento só pode ser reenviado após retificação se o último estado for:

• ERROR (erro de validação ou ligação)
• 14 (regularização pedida pelo cliente)

Para os restantes estados, o reenvio não é permitido e o documento será rejeitado pelo sistema.