latestOpenAPI 3.0.32026-08-101200629.5 KB

2c51a28d0f48

Versões Anteriores

Compras1

Documentos de Compra1

Finalizar Documentos de Compra

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

Request body

object required

Response

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:acts_as_shipment_document","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:apply_retention_when_paid","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_gross_total","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_net_total","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_pending_total","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_retention_total","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_settlement_total","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_vat_incidence_int","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_vat_incidence_ise","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_vat_incidence_nor","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_vat_incidence_red","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_vat_total_int","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_vat_total_nor","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:base_currency_vat_total_red","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:cashed_vat","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:child_documents_ids","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:communication_code","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:communication_code_source","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:communication_status","oasType":"schema","type":"unknown","example":null,"nullable":true}

company_idnumber

created_atstring

currency_conversion_ratenumber

currency_idnumber

currency_iso_codestring

datestring

document_areastring

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:document_hash_sum","oasType":"schema","type":"unknown","example":null,"nullable":true}

document_nostring

document_series_idnumber

document_series_prefixstring

document_typestring

due_datestring

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:emailed","oasType":"schema","type":"unknown","example":null,"nullable":true}

external_referencestring

gross_totalnumber

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:hash_control","oasType":"schema","type":"unknown","example":null,"nullable":true}

idnumber

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:is_third_party","oasType":"schema","type":"unknown","example":null,"nullable":true}

line_settlement_with_taxnumber

line_settlement_with_tax_unroundednumber

line_settlement_without_taxnumber

line_settlement_without_tax_unroundednumber

net_totalnumber

notesstring

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:operation_country","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:parent_document_area","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:parent_documents_ids","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:payments_ids","oasType":"schema","type":"unknown","example":null,"nullable":true}

pending_retention_valuenumber

pending_totalnumber

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:printed","oasType":"schema","type":"unknown","example":null,"nullable":true}

public_linkstring

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:retention","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:retention_type","oasType":"schema","type":"unknown","example":null,"nullable":true}

retention_valuenumber

retention_value_unroundednumber

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:settlement_expression","oasType":"schema","type":"unknown","example":null,"nullable":true}

settlement_percentagenumber

settlement_totalnumber

settlement_with_taxnumber

settlement_with_tax_unroundednumber

settlement_without_taxnumber

settlement_without_tax_unroundednumber

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_country","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_loading_address_detail","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_loading_city","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_loading_country","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_loading_postcode","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_loading_time","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_unloading_address_detail","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_unloading_city","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_unloading_country","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_unloading_postcode","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:shipment_unloading_time","oasType":"schema","type":"unknown","example":null,"nullable":true}

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

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:third_party_type","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:total_pending_quantity","oasType":"schema","type":"unknown","example":null,"nullable":true}

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

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:vat_percentage_int","oasType":"schema","type":"unknown","example":null,"nullable":true}

vat_percentage_nornumber

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:vat_percentage_red","oasType":"schema","type":"unknown","example":null,"nullable":true}

vat_total_intnumber

vat_total_int_unroundednumber

vat_total_nornumber

vat_total_nor_unroundednumber

vat_total_rednumber

vat_total_red_unroundednumber

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:vehicle_registration","oasType":"schema","type":"unknown","example":null,"nullable":true}

{"stackTrail":"paths:/api/v1/commercial_purchases_documents/{id}/finalize:patch:responses:200:content:application/json:schema:properties:voided_reason","oasType":"schema","type":"unknown","example":null,"nullable":true}

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
}