Linhas do Documento
As linhas representam os vários lançamentos de artigos e serviços nos documentos de venda.
API - Linhas do Documento:
Apresentamos alguns end-points que permitem lançar, editar e apagar linhas dos documentos.
- Listar Linhas de Documento
- Criar Linha(s) em Documento
- Alterar Linha de Documento
- Apagar Linha de Documento
| Parâmetros | |
|---|---|
| code |
Código string
Identificador do produto a usar na linha. Pode referir-se tanto ao 'código' como ao 'código de barras' de um produto, ou ainda a um 'código alternativo' por este usado.
Preenchimento Obrigatório* |
| description | Descrição string Este valor, se preenchido, vai sobrepor-se à descrição na ficha do produto apenas na presente linha. |
| long_description |
Descrição Alargada string
A utilização deste campo pode estar limitada por opções de configuração do CloudInvoice. Tamanho: 10000 |
| base_qty |
Quantidade decimal
Default: 1 |
| line_discount1 |
Desconto de Linha #1 decimal
Valores: entre 0 e 100 |
| line_discount2 |
Desconto de Linha #2 decimal
Valores: entre 0 e 100 |
| line_unit_value | Preço Unitário decimal O valor fornecido deverá ser o Preço Unitário sem IVA se o documento estiver definido como contendo valores sem IVA. E deverá já incluir IVA no caso contrário. |
Listar Linhas de Documento /sale/<document_id>/details GET
Listar linhas de um documento.
$ curl https://www.cloudinvoice.net/v3/sale/1/details/
{
"has_details": true,
"details": [
{
"id": 1,
"line_number": 1,
"line_subitem": 0,
"code": "PROD1",
"short_description": "Produto Standard 1",
"base_qty": 1.0,
"base_qty_unit": "1.000 UNI",
"measure_unit_id": 1,
"measure_unit__code": "UNI",
"line_unit_value": 100.0,
"line_discount1": 0.0,
"line_discount2": 0.0,
"use_serial_number": false,
"has_lots": false,
"lot_number": "",
"gross_unit_price_currency": 100.0,
"total_net_amount_currency": 100.0,
"total_amount_currency": 123.0,
...
}
]
}
Criar Linha(s) em Documento /sale/<document_id>/details/add POST
Criar linha(s) num documento. A resposta contém também informação actualizada do documento.
$ curl -X POST https://www.cloudinvoice.net/v3/sale/1/detail/add/
-d '{
"details":[
{
"code": "PROD1",
"base_qty": 1
},
{
"code": "PROD2",
"base_qty": 2,
"line_unit_value": 2.20
}
]
}'
{
"has_document": true,
"has_details": true,
"document": {
"id": 1,
"document_key": "FSI A01/-1",
"document_nature": 302,
"document_name": "Factura Simplificada",
"document_status": 1201,
"status_reason": "",
"document_date": "2020-06-20",
"document_time": "12:56:47.205",
"is_valued": true,
"is_tax_included": true,
"line_details_count": 2,
"lines_total_quantity": 3.0,
"total_amount": 127.4,
"total_gross_amount_currency": 127.4,
"total_global_discount_currency": 0.0,
"total_line_discount_currency": 0.0,
"total_net_amount_currency": 103.5772357724,
"total_taxes_amount_currency": 23.8227642276,
"total_amount_currency": 127.4,
"total_document_amount_currency": 127.4,
"total_due_amount_currency": 127.4,
"can_finalize": true,
...
},
"details": [
{
"id": 1,
"line_number": 1,
"line_subitem": 0,
"code": "PROD1",
"short_description": "Produto Standard 1",
"base_qty": 1.0,
"base_qty_unit": "1.000 UNI",
"measure_unit_id": 1,
"measure_unit__code": "UNI",
"line_unit_value": 123.0,
"line_discount1": 0.0,
"line_discount2": 0.0,
"use_serial_number": false,
"has_lots": false,
"lot_number": "",
"gross_unit_price_currency": 123.0,
"total_net_amount_currency": 100.0,
"total_amount_currency": 123.0,
...
},
{
"id": 2,
"line_number": 2,
"line_subitem": 0,
"code": "PROD2",
"short_description": "Produto Standard 2",
"base_qty": 2.0,
"base_qty_unit": "2.000 UNI",
"measure_unit_id": 1,
"measure_unit__code": "UNI",
"line_unit_value": 2.2,
"line_discount1": 0.0,
"line_discount2": 0.0,
"use_serial_number": false,
"has_lots": false,
"lot_number": "",
"gross_unit_price_currency": 2.2,
"total_net_amount_currency": 3.5772357724,
"total_amount_currency": 4.4,
...
}
]
}
Alterar Linha de Documento /sale/<document_id>/details/<id>/update GET
Alterar linha de um documento. A resposta contém também informação actualizada do documento.
curl https://www.cloudinvoice.net/v3/sale/1/detail/2/update/
-d '{
"line_discount1": 5.0
}'
{
"has_document": true,
"has_details": true,
"document": {
"id": 1,
"document_key": "FSI A01/-1",
"document_nature": 302,
"document_name": "Factura Simplificada",
"document_status": 1201,
"status_reason": "",
"document_date": "2020-06-20",
"document_time": "12:56:47.205",
"is_valued": true,
"is_tax_included": true,
"line_details_count": 2,
"lines_total_quantity": 3.0,
"total_amount": 127.18,
"total_gross_amount_currency": 127.18,
"total_global_discount_currency": 0.0,
"total_line_discount_currency": 0.22,
"total_net_amount_currency": 103.3983739837,
"total_taxes_amount_currency": 23.7816260163,
"total_amount_currency": 127.18,
"total_document_amount_currency": 127.18,
"total_due_amount_currency": 127.18,
"can_finalize": true,
...
},
"details": [
{
"id": 1,
"line_number": 1,
"line_subitem": 0,
"code": "PROD1",
"short_description": "Produto Standard 1",
"base_qty": 1.0,
"base_qty_unit": "1.000 UNI",
"measure_unit_id": 1,
"measure_unit__code": "UNI",
"line_unit_value": 123.0,
"line_discount1": 0.0,
"line_discount2": 0.0,
"use_serial_number": false,
"has_lots": false,
"lot_number": "",
"gross_unit_price_currency": 123.0,
"total_net_amount_currency": 100.0,
"total_amount_currency": 123.0,
...
},
{
"id": 2,
"line_number": 2,
"line_subitem": 0,
"code": "PROD2",
"short_description": "Produto Standard 2",
"base_qty": 2.0,
"base_qty_unit": "2.000 UNI",
"measure_unit_id": 1,
"measure_unit__code": "UNI",
"line_unit_value": 2.2,
"line_discount1": 5.0,
"line_discount2": 0.0,
"use_serial_number": false,
"has_lots": false,
"lot_number": "",
"gross_unit_price_currency": 2.2,
"total_net_amount_currency": 3.3983739837,
"total_amount_currency": 4.18,
...
}
]
}
Apagar Linha de Documento /sale/<document_id>/details/<id>/delete POST
Apagar linha de um documento. A resposta contém também informação actualizada do documento.
Se o que pretende é apagar todas as linhas do documento de uma vez,
pode ver em Limpar Linhas do Documento
$ curl https://www.cloudinvoice.net/v3/sale/1/detail/2/delete/
{
"has_document": true,
"has_details": true,
"document": {
"id": 1,
"document_key": "FSI A01/-1",
"document_nature": 302,
"document_name": "Factura Simplificada",
"document_status": 1201,
"status_reason": "",
"document_date": "2020-06-20",
"document_time": "12:56:47.205",
"is_valued": true,
"is_tax_included": true,
"line_details_count": 1,
"lines_total_quantity": 1.0,
"total_amount": 123.0,
"total_gross_amount_currency": 123.0,
"total_global_discount_currency": 0.0,
"total_line_discount_currency": 0.0,
"total_net_amount_currency": 100.0,
"total_taxes_amount_currency": 23.0,
"total_amount_currency": 123.0,
"total_document_amount_currency": 123.0,
"total_due_amount_currency": 123.0,
"can_finalize": true,
...
},
"details": [
{
"id": 1,
"line_number": 1,
"line_subitem": 0,
"code": "PROD1",
"short_description": "Produto Standard 1",
"base_qty": 1.0,
"base_qty_unit": "1.000 UNI",
"measure_unit_id": 1,
"measure_unit__code": "UNI",
"line_unit_value": 123.0,
"line_discount1": 0.0,
"line_discount2": 0.0,
"use_serial_number": false,
"has_lots": false,
"lot_number": "",
"gross_unit_price_currency": 123.0,
"total_net_amount_currency": 100.0,
"total_amount_currency": 123.0,
...
}
]
}