# Emitir Nota de Crédito

## Emitir Nota de Crédito

{% hint style="danger" %}
**Este endpoint deverá ser usado apenas para emissão de Notas de Crédito de Venda.**

As Notas de Crédito a Fornecedor, não tendo a necessidade de fazer referência a um documento de origem, deverão ser criadas recorrendo ao habitual endpoint [Create](/documentacao-api/documentos/create.md).
{% endhint %}

## Emite uma Nota de Crédito, com origem no Documento de Venda com o ID fornecido.

<mark style="color:green;">`POST`</mark> `https://api.cloudinvoice.net/documents/:id/emit_credit_note/`

#### Path Parameters

| Name                                 | Type    | Description               |
| ------------------------------------ | ------- | ------------------------- |
| id<mark style="color:red;">\*</mark> | integer | ID do Documento de Origem |

#### Request Body

| Name                                               | Type    | Description                                                                                                                                                                                                                                                               |
| -------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| details<mark style="color:red;">\*</mark>          | array   | <p>Linhas do Documento de Origem.</p><p></p><p>Poderá conter uma lista de objectos, sendo que cada objecto deverá conter os parâmetros de uma Linha de Origem conforme descritos no <a href="/pages/BdlvhGZBoKlBoSmsSOiC#linhas-do-documento-de-origem">Apêndice</a>.</p> |
| print                                              | boolean | <p>Imprimir Documento após emissão. </p><p>Apenas pode imprimir documentos finalizados.</p><p></p><p>Consulte os parâmetros disponíveis para impressão no <a href="/pages/BdlvhGZBoKlBoSmsSOiC#impressao-do-documento">Apêndice</a>.</p>                                  |
| email                                              | boolean | <p>Enviar por E-mail após a emissão.</p><p>Apenas pode enviar por e-mail documentos finalizados.</p><p></p><p>Consulte os parâmetros disponíveis para impressão no <a href="/pages/BdlvhGZBoKlBoSmsSOiC#envio-por-e-mail-do-documento">Apêndice</a>.</p>                  |
| emission\_reason<mark style="color:red;">\*</mark> | string  | Motivo de Emissão.                                                                                                                                                                                                                                                        |
| force\_communication                               | boolean | <p>Força comunicação do documento à AT.</p><p>Caso não indique, o documento será comunicado em automático se assim for necessário.</p>                                                                                                                                    |
| payment\_method\_id                                | integer | <p>Método de Pagamento.</p><p></p><p>Poderá ser necessário definir um Método de Pagamento no caso de se tratar de uma Nota de Crédito de devolução.</p>                                                                                                                   |
| finalize                                           | boolean | Finalizar o Documento após a emissão.                                                                                                                                                                                                                                     |

{% tabs %}
{% tab title="Exemplo de Pedido" %}

```shell
curl -X POST https://api.cloudinvoice.net/documents/1470/emit_credit_note/
    -d '{
        "emission_reason": "Devolução",
        "details": [
            {
                "id": 1122,
                "base_qty": 1
            },
            {
                "id": 1123
            }
        ],
        "finalize": true
    }'
```

{% endtab %}

{% tab title="Exemplo de Resposta" %}

```json
{
  "id": 1,
  "doc_key": "NCR A01/1",
  "document_date": "2023-08-01",
  "document_time": "15:50:29",
  "document_number": 4,
  "document_reference": "",
  "our_reference": "",
  "module_origin": 1,
  "party_id": 2,
  "party": {
    "class": 1601,
    "code": 2,
    "name": "Cliente Demo",
    "commercial_name": "",
    "fiscal_number": "123456789",
    "street1": "Desconhecido",
    "street2": "",
    "zip_code": "0000-000",
    "zip_locale": "Desconhecido"
  },
  "line_details_count": 2,
  "lines_total_quantity": 2.0,
  "is_valued": true,
  "is_tax_included": false,
  "total_gross_amount": 6.07,
  "global_discount1": 0.0,
  "total_global_discount": 0.0,
  "total_line_discount": 0.0,
  "total_net_amount": 6.07,
  "total_taxes_amount": 0.9361,
  "total_amount": 7.01,
  "total_document_amount": 7.01,
  "total_round_amount": 0.0,
  "total_due_amount": 7.01,
  "due_date": "2023-08-01",
  "is_converted": false,
  "header_text": "",
  "footer_text": "",
  "number_of_prints": 0,
  "is_transport_document": false,
  "obs": "",
  "has_withholding": false,
  "document_nature_id": 305,
  "document_nature": {
    "code": "NC",
    "description": "Nota de Crédito"
  },
  "document_id": 5,
  "document": {
    "code": "NCR",
    "document_name": "Nota de Crédito",
    "ask_payment_onclose": false
  },
  "document_serie_id": 1,
  "document_serie": {
    "code": "A01",
    "description": "Série A01"
  },
  "document_status_id": 1202,
  "document_status": {
    "code": "F",
    "description": "Finalizado"
  },
  "warehouse_id": 1,
  "warehouse": {
    "code": 1,
    "description": "Armazém 1"
  },
  "salesman_id": 2,
  "salesman": {
    "code": 2,
    "salesman_name": "Vendedor 2"
  },
  "payment_term_id": 1,
  "payment_term": {
    "code": 1,
    "description": "Pronto Pagamento"
  },
  "payment_method_id": null,
  "payment_method": null,
  "origin_document_header_id": 1470,
  "origin_document_header": {
    "doc_key": "FAC A01/1",
    "document_name": "Factura"
  }
}
```

{% endtab %}
{% endtabs %}

Para ver exemplos de pedidos nas várias linguagens, consulte a página[ Exemplos de Pedidos.](/introducao/exemplos-de-pedidos.md)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.cloudinvoice.net/documentacao-api/documentos/acoes/emitir-nota-de-credito.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.