latestOpenAPI 3.0.32026-08-101200629.5 KB
2c51a28d0f48
Versões Anteriores
Vendas1
Documentos de Venda1
Obter Documentos de Venda por Id
Obter Documentos de Venda por Id
get/api/commercial_sales_documents/{salesDocumentId}
Response
Sucesso
Example response
{
"data": {
"attributes": {
"apply_retention_when_paid": true,
"communication_code_source": "webservice",
"communication_status": "unsent",
"created_at": "2024-03-05 14:24:53.318028",
"currency_conversion_rate": 1,
"currency_iso_code": "EUR",
"customer_business_name": "Gabriel",
"customer_country": "PT",
"customer_tax_country_region": "PT",
"customer_tax_registration_number": "123456789",
"date": "2023-01-01",
"document_area": "FT",
"document_series_prefix": "2023",
"document_type": "FT",
"due_date": "2023-02-01",
"external_reference": "Referência do documento externo",
"gross_total": 30.39,
"line_settlement_with_tax": 1.02,
"line_settlement_with_tax_unrounded": 1.015983,
"line_settlement_without_tax": 0.9,
"line_settlement_without_tax_unrounded": 0.8991,
"made_available_to": true,
"net_total": 26.89,
"notes": "Notas ao documento",
"operation_country": "PT-MA",
"payment_mechanism": "MO",
"pending_retention_value": 0.67,
"pending_total": 30.39,
"retention": 7.5,
"retention_aware_gross_total": 29.72,
"retention_type": "IRS",
"retention_value": 0.67,
"retention_value_unrounded": 0.6722645625,
"settlement_expression": "7.5",
"settlement_percentage": 7.5,
"settlement_total": 3.08,
"settlement_with_tax": 2.46,
"settlement_with_tax_unrounded": 2.463758775,
"settlement_without_tax": 2.18,
"settlement_without_tax_unrounded": 2.1803175,
"tax_payable": 3.5,
"updated_at": "2024-03-05 14:26:41.652972",
"vat_incidence_int": 26.89,
"vat_incidence_int_unrounded": 26.8905825,
"vat_percentage_int": 13,
"vat_total_int": 3.5,
"vat_total_int_unrounded": 3.495775725
},
"id": "66",
"relationships": {
"commercial_document_series": {
"data": {
"id": "72",
"type": "commercial_document_series"
}
},
"company": {
"data": {
"id": "800000046",
"type": "current_company"
}
},
"currency": {
"data": {
"id": "1",
"type": "currencies"
}
},
"customer": {
"data": {
"id": "2",
"type": "customers"
}
},
"lines": {
"data": [
{
"id": "131",
"type": "commercial_sales_document_lines"
},
{
"id": "132",
"type": "commercial_sales_document_lines"
},
{
"id": "133",
"type": "commercial_sales_document_lines"
},
{
"id": "134",
"type": "commercial_sales_document_lines"
},
{
"id": "136",
"type": "commercial_sales_document_lines"
}
]
},
"user": {
"data": {
"id": "800000863",
"type": "current_company_users"
}
}
},
"type": "commercial_sales_documents"
}
}