Comunicação de documentos à AT

Pedir comunicação de documentos

Pode enviar 3 tipos de documentos à Autoridade Tributária:

• sales_document: documentos de venda

• shipment_document: guias

• purchases_shipment_document: guias de devolução a fornecedor

De modo a comunicar um documento, deverá realizar um pedido POST, para o endpoint: send_document_at_webservice

Comunicação de documentos

PATCH /send_document_at_webservice

Request Body

Name	Type	Description
data*	object

200: OK

{
  data: {
    type: 'send_document_at_webservice',
    id: '<document_id>',
    attributes: {
      communication_status: <communciation_status>,
      communication_code: <communication_code>,
      communication_message: <communication_message>
    }
  }
}

curl -v -X POST -H 'Content-Type: application/vnd.api+json'\
-H 'Accept: application/json'\
-H 'Authorization: Bearer <access_token>'\
-d '<payload JSON>' '<API_URL>/send_document_at_webservice'

O payload a utilizar para a comunicação é o seguinte:

Payload

{
  "data": {
    "type": "send_document_at_webservice",
    "id": 2,
    "attributes": {
      "document_type": "<document_type>",
       "entity_username": "<at_username>",
       "entity_password": "<at_password_base_64>"
    }
  }
}

"entity_username" -> Nome de utilizador usado para acesso ao Portal das finanças. "entity_password" -> Palavra-passe usada para acesso ao Portal das Finanças.

A resposta ao pedido trará informação sobre o sucesso/insucesso da operação no seguinte formato:

Response

{
    "data": {
        "id": "<document_id>",
        "type": "send_document_at_webservice",
        "attributes": {
            "communication_message": "<communication_message>",
            "communication_code": "<communication_code>",
            "communication_status": "<communciation_status>",
        }
    }
}

O campo communication_code terá o código de comunicação à Autoridade Tributária no caso do documento comunicado ter sido uma guia (vendas ou compras).