---
description: Comunicação de documentos via API
---

# Comunicação de documentos à AT

## Pedir comunicação de documentos <a href="#pedir-comunicacao-de-documentos" id="pedir-comunicacao-de-documentos"></a>

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

<mark style="color:purple;">`PATCH`</mark> `/send_document_at_webservice`

#### Request Body

| Name                                   | Type   | Description |
| -------------------------------------- | ------ | ----------- |
| data<mark style="color:red;">\*</mark> | object |             |

{% tabs %}
{% tab title="200: OK " %}
```javascript
{
  data: {
    type: 'send_document_at_webservice',
    id: '<document_id>',
    attributes: {
      communication_status: <communciation_status>,
      communication_code: <communication_code>,
      communication_message: <communication_message>
    }
  }
}
```
{% endtab %}
{% endtabs %}

```
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:

```
{
  data: {
    type: 'send_document_at_webservice',
    id: '<document_id>',
    attributes: {
      document_type: '<document_type>',
      entity_password: '<at_password_base_64>',
      entity_username: '<at_username>'
    }
  }
}
```

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

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

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).
