Versões Anteriores
Compras1
Documentos de Compra1

Finalizar Documentos de Compra

Finalizar Documentos de Compra

patch/api/v1/commercial_purchases_documents/{id}/finalize

Request

Request body

object required

Response

Finalizar Documentos de Compra

acts_as_shipment_documentunknown
apply_retention_when_paidunknown
base_currency_gross_totalunknown
base_currency_net_totalunknown
base_currency_pending_totalunknown
base_currency_retention_totalunknown
base_currency_settlement_totalunknown
base_currency_vat_incidence_intunknown
base_currency_vat_incidence_iseunknown
base_currency_vat_incidence_norunknown
base_currency_vat_incidence_redunknown
base_currency_vat_total_intunknown
base_currency_vat_total_norunknown
base_currency_vat_total_redunknown
cashed_vatunknown
child_documents_idsunknown
communication_codeunknown
communication_code_sourceunknown
communication_statusunknown
company_idnumber
created_atstring
currency_conversion_ratenumber
currency_idnumber
currency_iso_codestring
datestring
document_areastring
document_hash_sumunknown
document_nostring
document_series_idnumber
document_series_prefixstring
document_typestring
due_datestring
emailedunknown
external_referencestring
gross_totalnumber
hash_controlunknown
idnumber
is_third_partyunknown
line_settlement_with_taxnumber
line_settlement_with_tax_unroundednumber
line_settlement_without_taxnumber
line_settlement_without_tax_unroundednumber
net_totalnumber
notesstring
operation_countryunknown
parent_document_areaunknown
parent_documents_idsunknown
payments_idsunknown
pending_retention_valuenumber
pending_totalnumber
printedunknown
public_linkstring
retentionunknown
retention_typeunknown
retention_valuenumber
retention_value_unroundednumber
settlement_expressionunknown
settlement_percentagenumber
settlement_totalnumber
settlement_with_taxnumber
settlement_with_tax_unroundednumber
settlement_without_taxnumber
settlement_without_tax_unroundednumber
shipment_countryunknown
shipment_loading_address_detailunknown
shipment_loading_cityunknown
shipment_loading_countryunknown
shipment_loading_postcodeunknown
shipment_loading_timeunknown
shipment_unloading_address_detailunknown
shipment_unloading_cityunknown
shipment_unloading_countryunknown
shipment_unloading_postcodeunknown
shipment_unloading_timeunknown
statusnumber
supplier_address_detailstring
supplier_business_namestring
supplier_citystring
supplier_countrystring
supplier_idnumber
supplier_postcodestring
supplier_tax_country_regionstring
supplier_tax_registration_numberstring
system_entry_datestring
tax_payablenumber
third_party_typeunknown
total_pending_quantityunknown
updated_atstring
user_idnumber
vat_incidence_intnumber
vat_incidence_int_unroundednumber
vat_incidence_isenumber
vat_incidence_ise_unroundednumber
vat_incidence_nornumber
vat_incidence_nor_unroundednumber
vat_incidence_rednumber
vat_incidence_red_unroundednumber
vat_included_pricesboolean
vat_percentage_intunknown
vat_percentage_nornumber
vat_percentage_redunknown
vat_total_intnumber
vat_total_int_unroundednumber
vat_total_nornumber
vat_total_nor_unroundednumber
vat_total_rednumber
vat_total_red_unroundednumber
vehicle_registrationunknown
voided_reasonunknown

Example response

{
  "company_id": 800000046,
  "created_at": "2024-03-06 10:52:52.637757",
  "currency_conversion_rate": 1,
  "currency_id": 1,
  "currency_iso_code": "EUR",
  "date": "2024-03-06",
  "document_area": "FC",
  "document_no": "FC 2023/4",
  "document_series_id": 125,
  "document_series_prefix": "2023",
  "document_type": "FC",
  "due_date": "2024-03-06",
  "id": 41,
  "lines": [
    {
      "amount": 0,
      "amount_with_header_settlement": 0,
      "base_currency_amount": null,
      "base_currency_net_amount": null,
      "base_currency_net_unit_price": null,
      "base_currency_settlement_with_tax": null,
      "base_currency_settlement_without_tax": null,
      "base_currency_tax_amount": null,
      "base_currency_unit_price": null,
      "created_at": "2024-03-06 11:05:50.019855",
      "date": null,
      "description": "Impostos Sobre o Rendimento",
      "document_id": 41,
      "expense_category_id": 2,
      "id": 41,
      "imported_quantity": null,
      "item_code": "241",
      "item_id": 2,
      "item_type": "Purchases::ExpenseCategory",
      "item_unit_price_includes_vat": false,
      "net_amount": 0,
      "net_amount_with_header_settlement": 0,
      "net_unit_price": 0,
      "original_document_no": null,
      "pending_quantity": null,
      "pending_retention_value": null,
      "pending_total": null,
      "quantity": null,
      "retention_value": null,
      "settlement_amount": null,
      "settlement_expression": null,
      "settlement_percentage": 0,
      "settlement_with_tax": 0,
      "settlement_without_tax": 0,
      "tax_amount": 0,
      "tax_code": "NOR",
      "tax_country_region": "PT",
      "tax_id": 1,
      "tax_percentage": 23,
      "unit_of_measure_id": 2,
      "unit_price": 0,
      "updated_at": "2024-03-06 11:05:50.019855"
    }
  ],
  "status": 1,
  "supplier_business_name": "Fornecedor Indiferenciado",
  "supplier_country": "PT",
  "supplier_id": 9,
  "supplier_tax_country_region": "PT",
  "supplier_tax_registration_number": "999999990",
  "system_entry_date": "2024-03-06 11:06:17.132657",
  "updated_at": "2024-03-06 11:06:17.132657",
  "user_id": 800000863,
  "vat_percentage_nor": 23
}

Changes

No recorded changes to this operation across all 1 revision of this API.