Documentação API
Search…
Comunicação de documentos à AT
Comunicação de documentos via API
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
patch
/send_document_at_webservice
Comunicação de documentos
1
curl -v -X POST -H 'Content-Type: application/vnd.api+json'\
2
-H 'Accept: application/json'\
3
-H 'Authorization: Bearer <access_token>'\
4
-d '<payload JSON>' '<API_URL>/send_document_at_webservice'
Copied!
O payload a utilizar para a comunicação é o seguinte:
1
{
2
data: {
3
type: 'send_document_at_webservice',
4
id: '<document_id>',
5
attributes: {
6
document_type: '<document_type>',
7
entity_password: '<at_password_base_64>',
8
entity_username: '<at_username>'
9
}
10
}
11
}
Copied!
A resposta ao pedido trará informação sobre o sucesso/insucesso da operação no seguinte formato:
1
{
2
data: {
3
type: 'send_document_at_webservice',
4
id: '<document_id>',
5
attributes: {
6
communication_status: <communciation_status>,
7
communication_code: <communication_code>,
8
communication_message: <communication_message>
9
}
10
}
11
}
Copied!
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).
Last modified 10d ago
Copy link