{b% load base_tags %}

Outras Acções

Consulte Vendas, emita recibos, imprima facturas e execute outras tarefas que temos disponíveis para si. Nota: Caso precise de mais funcionalidades, deve consultar o nosso serviço de suporte.

API - Outras Acções sobre os Documentos:

Apresentamos alguns end-points parae executar acções específicas sobre os documentos de venda.

  1. Emitir Documento de Venda
  2. Emitir Recibo
  3. Imprimir Documento

Emitir Documento de Venda /guide/<id>/emit-sale POST

Emitir documento de venda a partir de guia ou encomenda.

Importante:
 Poderá usar, de forma análoga, os end-points:

  • /order/<id>/emit-sale - para emissões é a partir de uma nota de encomenda;

Parâmetros
target_document_nature Natureza do Documento de Destino int
Pode tomar os valores:
  • 301 - Factura
  • 302 - Factura Simplificada
  • 303 - Factura-Recibo

Default: Factura
details Linhas do Documento de Origem a Emitir list
Deverá conter uma lista de objectos, sendo que cada objecto deverá conter o id da linha de origem.
Pode também incluir no objecto valores para os seguintes campos, para emissões parciais:
  • base_qty - não deverá ultrapassar o valor da origem
  • line_unit_value - não deverá ultrapassar o valor da origem
  • line_discount1 - valores entre 0 e 100
  • line_discount2 - valores entre 0 e 100

Preenchimento Obrigatório* 
                    
                        curl -X POST https://www.cloudinvoice.net/v3/guide/1/emit-sale/
    -d '{
        "target_document_nature": 303,
         "details": [
            {
                "id": 1,
                "description": "Produto Exemplo"
            }
        ]
    }'
                    
                  
                    
                        {
    "id": 2
}

Emitir Recibo /sale/<id>/emit-receipt POST

Emitir recibo a partir de documento de venda.
A resposta contém o id do novo documento.

Importante:
 O URL gerado para download do ficheiro em formato PDF não deve ser considerado persistente, isto é, o ficheiro para o qual o URL aponta tem vida limitada.

Parâmetros
total_received_amount Valor a Liquidar decimal
Preenchimento Obrigatório* 
                    
                        curl -X POST https://www.cloudinvoice.net/v3/sale/1/emit-receipt/
    -d '{
        "total_received_amount": 50.0
    }'

                    
                  
                    
                        {
    "id": 1
}

Imprimir Documento /sale/<id>/print POST

Imprimir documento. Entenda-se por 'imprimir' o gerar do documento em formato PDF para impressão.

Parâmetros
print_mode Modo de Impressão string 
                    
                        curl -X POST https://www.cloudinvoice.net/v3/sale/1/print/
    -d '{
        "print_mode": "browser"
    }'
                    
                  
                    
                        {
    "is_document": true,
    "is_receipt": false,
    "filename": "FS__FSI_A01_1__2020_06_22_1592908727.pdf",
    "report_url": "http://www.cloudinvoice.net/downloads/c3c00f37-a7cb-4b42-b631-be03a2b785c8/download_file/?direct=true&compressed=false"
}

Consultar Documentos /sales GET

Consulte todas as vendas e documentos relacionados emitidos na sua empresa.

Importante:
 No exemplo apresentado, usamos documentos de venda, mas poderá usar, de forma análoga, os end-points para outros tipos de documentos:

  • /guides - guias de remessa e transporte;
  • /orders - notas de encomenda;
  • /receipts - recibos;
  • /creditnotes - notas de crédito;

                    
                        $ curl https://www.cloudinvoice.net/v3/sales/
                    
                  
                    
                        {
    "results": [
        {
            "id": 1,
            "description": "Factura-Recibo",
            "document_id": 3,
            "document_code": "FRE",
            "document_name": "Factura-Recibo",
            "document_nature": 303,
            "document_serie_id": 1,
            "document_serie_code": "A01",
            "document_number": 1,
            "doc_key": "FRE A01/1",
            "document_status": 1202,
            "is_valued": 1,
            "is_converted": 0,
            "party_id": 5,
            "party_code": 5,
            "party_fiscal_number": "999999990",
            "party_name": "John DOE",
            "line_details_count": 3,
            "lines_total_quantity": 3.0,
            "total_amount_raw": 61.8,
            "total_amount_currency_raw": 61.8,
            ...
        },
        {
            "id": 2,
            "description": "Factura",
            "document_id": 1,
            "document_code": "FAC",
            "document_name": "Factura",
            "document_nature": 301,
            "document_serie_id": 1,
            "document_serie_code": "A01",
            "document_number": 1,
            "doc_key": "FAC A01/1",
            "document_status": 1202,
            "is_valued": 1,
            "is_converted": 0,
            "party_id": 2,
            "party_code": 2,
            "party_fiscal_number": "503217239",
            "party_name": "Client Demo",
            "line_details_count": 1,
            "lines_total_quantity": 1.0,
            "total_amount_raw": 123.0,
            "total_amount_currency_raw": 123.0,
            ...
        }
    ],
    "count_total": 2
}