/kimdis/payments

POST /api/kimdis/payments

Price: 1 credit

Greek public payment order from the KIMDIS registry by its ADAM reference number: paying authority, the paid items with each payee's name, VAT number and invoice number, amounts with and without VAT, commitment codes, funding and the ADAMs of the contract, award and request it pays for.

How to use it

Takes a `PAY` ADAM such as a kimdis/payments/search row `id`. The payee of each paid item is in `line_items[].contractor_name` and `line_items[].contractor_vat_number`.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• id string required — Payment order ADAM reference number (examples: "26PAY019742375"; pattern: ^\d{2}PAY\d{9}$)

Response

• @type string (default: "KimdisPayment")
• id string required
• document_url string nullable
• organization object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• organization_vat_number string nullable
• is_greek_organization_vat_number boolean nullable
• invoicing_code string nullable
• units_operator object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• signer object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• author_email string nullable
• protocol_number string nullable
• signed_date string nullable
• submitted_at integer nullable
• updated_at integer nullable
• is_cancelled boolean nullable
• cancelled_at integer nullable
• cancellation_type string nullable
• cancellation_reason string nullable
• cancellation_ada string nullable
• contract_type object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• additional_contract_types array (default: [])
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• is_mixed_contract boolean nullable
• nuts object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• nuts_regions array (default: [])
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• city string nullable
• postal_code string nullable
• country object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• authority_type object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• public_law_classification object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• authority_activity object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• legal_context object nullable
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• centralized_markets array (default: [])
  • @type string (default: "KimdisCode")
  • code string nullable
  • name string nullable
• is_central_government boolean nullable
• is_reserved_contract boolean nullable
• is_social_contract boolean nullable
• total_cost_with_vat number nullable
• total_cost_without_vat number nullable
• budget number nullable
• commitment_number string nullable
• funding object nullable
  • @type string (default: "KimdisFunding")
  • public_investment_code string nullable
  • public_investment_project_number string nullable
  • public_investment_ops_code string nullable
  • cofunded_program string nullable
  • self_funded_program string nullable
  • espa_program string nullable
  • regular_budget_program string nullable
• line_items array (default: [])
  • @type string (default: "KimdisItem")
  • description string nullable
  • quantity number nullable
  • unit object nullable
    • @type string (default: "KimdisCode")
    • code string nullable
    • name string nullable
  • cost_without_vat number nullable
  • vat_rate number nullable
  • currency string nullable
  • cpvs array (default: [])
    • @type string (default: "KimdisCode")
    • code string nullable
    • name string nullable
  • green_procurement object nullable
    • @type string (default: "KimdisCode")
    • code string nullable
    • name string nullable
  • goods_or_services object nullable
    • @type string (default: "KimdisCode")
    • code string nullable
    • name string nullable
  • budget_code string nullable
  • request_id string nullable
  • delivery_address string nullable
  • delivery_street_number string nullable
  • delivery_postal_code string nullable
  • delivery_city string nullable
  • delivery_country object nullable
    • @type string (default: "KimdisCode")
    • code string nullable
    • name string nullable
  • construction_city object nullable
    • @type string (default: "KimdisCode")
    • code string nullable
    • name string nullable
  • contractor_name string nullable
  • contractor_vat_number string nullable
  • is_greek_contractor_vat_number boolean nullable
  • contractor_country object nullable
    • @type string (default: "KimdisCode")
    • code string nullable
    • name string nullable
  • invoice_number string nullable
  • commitment_code string nullable
• contract_value number nullable
• has_credits boolean nullable
• commitment_code string nullable
• commitment_ada string nullable
• award_id string nullable
• contract_id string nullable
• request_id string nullable

Errors

• 422 — The ADAM is not a payment order reference number (two digits, PAY, nine digits) 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 payment order with that ADAM 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.