/vneps/contracts

POST /api/vneps/contracts

Price: 10 credits

Vietnam public contract from muasamcong.mpi.gov.vn by contract code: investor, contractor, the signed e-contract with prices before and after VAT, type, effective date, goods and the bill of work items, the performance reports with completion progress and value, and the reports of goods delivered.

How to use it

Takes the `id` of a vneps/contracts/search row. `econtract` stays empty for contracts that were not signed through the portal's e-contract module.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Contract code (examples: "HD2500202334")

Response

• @type string (default: "VnepsContract")
• id string required
• record_id string nullable
• contract_version string nullable
• record_number string nullable
• record_version string nullable
• contract_number string nullable
• contract_name string nullable
• project_name string nullable
• package_name string nullable
• notify_number string nullable
• notify_version string nullable
• result_version string nullable
• invest_field string nullable
• source string nullable
• perform_type string nullable
• investor object nullable
  • @type string (default: "VnepsParty")
  • code string nullable
  • name string nullable
• contractor object nullable
  • @type string (default: "VnepsParty")
  • code string nullable
  • name string nullable
• contractor_tax_code string nullable
• joint_venture object nullable
  • @type string (default: "VnepsParty")
  • code string nullable
  • name string nullable
• publisher_role string nullable
• published_by string nullable
• status string nullable
• performance_status string nullable
• quality string nullable
• termination string nullable
• violation string nullable
• sign_date string nullable
• planned_completion_date string nullable
• actual_completion_date string nullable
• contract_published_at integer nullable
• published_at integer nullable
• created_at integer nullable
• updated_at integer nullable
• signed_price number nullable
• econtract object nullable
  • @type string (default: "VnepsEContract")
  • id string nullable
  • contract_type string nullable
  • status string nullable
  • price_before_tax number nullable
  • price_before_tax_currency string nullable
  • tax number nullable
  • tax_currency string nullable
  • price_after_tax number nullable
  • price_after_tax_currency string nullable
  • effective_date string nullable
  • contract_period_text string nullable
  • contract_period_unit string nullable
  • selection_duration integer nullable
  • selection_duration_unit string nullable
  • selection_method string nullable
  • bid_mode string nullable
  • procedure string nullable
  • investor_address string nullable
  • contractor_address string nullable
  • project_name_new string nullable
  • main_contract_id string nullable
  • main_contract_version string nullable
  • result_id string nullable
  • result_version string nullable
  • medical_type integer nullable
  • is_medicine boolean nullable
  • is_multi_lot boolean nullable
  • form_codes array (default: [])
  • scope_file object nullable
    • @type string (default: "VnepsFile")
    • id string nullable
    • name string nullable
    • kind string nullable
  • goods_file object nullable
    • @type string (default: "VnepsFile")
    • id string nullable
    • name string nullable
    • kind string nullable
  • goods array (default: [])
    • @type string (default: "VnepsGoodsItem")
    • name string nullable
    • code string nullable
    • brand string nullable
    • manufacturer string nullable
    • origin string nullable
    • manufacture_year string nullable
    • hs_code string nullable
    • unit string nullable
    • quantity number nullable
    • unit_price number nullable
    • amount number nullable
    • specification string nullable
    • delivery_place string nullable
    • delivery_period string nullable
    • note string nullable
    • lot_number string nullable
    • lot_name string nullable
    • contractor_code string nullable
  • scope_of_work array (default: [])
    • @type string (default: "VnepsWorkItem")
    • id string nullable
    • position string nullable
    • parent_id string nullable
    • description string nullable
    • unit string nullable
    • quantity number nullable
    • is_group boolean nullable
    • form_title string nullable
    • requirement string nullable
  • published_at integer nullable
  • versions array (default: [])
• performance_reports array (default: [])
  • @type string (default: "VnepsPerformanceReport")
  • id string required
  • record_id string nullable
  • contract_version string nullable
  • record_number string nullable
  • record_version string nullable
  • contract_number string nullable
  • contract_name string nullable
  • project_name string nullable
  • package_name string nullable
  • notify_number string nullable
  • notify_version string nullable
  • result_version string nullable
  • invest_field string nullable
  • source string nullable
  • perform_type string nullable
  • investor object nullable
    • @type string (default: "VnepsParty")
    • code string nullable
    • name string nullable
  • contractor object nullable
    • @type string (default: "VnepsParty")
    • code string nullable
    • name string nullable
  • contractor_tax_code string nullable
  • joint_venture object nullable
    • @type string (default: "VnepsParty")
    • code string nullable
    • name string nullable
  • publisher_role string nullable
  • published_by string nullable
  • status string nullable
  • performance_status string nullable
  • quality string nullable
  • termination string nullable
  • violation string nullable
  • sign_date string nullable
  • planned_completion_date string nullable
  • actual_completion_date string nullable
  • contract_published_at integer nullable
  • published_at integer nullable
  • created_at integer nullable
  • updated_at integer nullable
  • notify_id string nullable
  • result_id string nullable
  • completion_percent number nullable
  • completed_value number nullable
  • adjusted_completion_date string nullable
  • completion_delay_days integer nullable
  • is_complete boolean nullable
  • is_signed_in_system boolean nullable
  • contract_created_at integer nullable
• used_goods_reports array (default: [])
  • @type string (default: "VnepsUsedGoodsReport")
  • id string nullable
  • report_number string nullable
  • status string nullable
  • version string nullable
  • published_by string nullable
  • published_at integer nullable
  • is_online boolean nullable
  • is_medicine boolean nullable
  • goods array (default: [])
    • @type string (default: "VnepsGoodsItem")
    • name string nullable
    • code string nullable
    • brand string nullable
    • manufacturer string nullable
    • origin string nullable
    • manufacture_year string nullable
    • hs_code string nullable
    • unit string nullable
    • quantity number nullable
    • unit_price number nullable
    • amount number nullable
    • specification string nullable
    • delivery_place string nullable
    • delivery_period string nullable
    • note string nullable
    • lot_number string nullable
    • lot_name string nullable
    • contractor_code string nullable

Errors

• 422 — The value is not a contract code like HD2500202334 Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — No contract with that code in the performance registry Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.