gov-pay
API лавлагаа

Invoices

Нэхэмжлэл хайх (ТТД / улсын дугаар / татварын дугаар / ref_num)

Нэхэмжлэл хайх

ТТД, улсын дугаар эсвэл татварын дугаараар лавлаж нэхэмжлэлийн жагсаалт буцаана. ttd, vehicle, taxRef-ийн ЯГ НЭГИЙГ өгнө.

GET
/api/v1/invoices
X-API-Key<token>

In: header

Query Parameters

ttd?string

Иргэн/байгууллагын регистр буюу ТТД

vehicle?string

Тээврийн хэрэгслийн улсын дугаар

taxRef?string

Татварын лавлагааны дугаар

Response Body

curl -X GET "https://sandbox-tts.qpay.mn/api/v1/invoices?ttd=%D0%A3%D0%8195051000&vehicle=%D0%A3%D0%91%D0%901234&taxRef=210000123456"
{
  "invoices": [
    {
      "id": "3f0c2e2a-1b2c-4d5e-8f90-abcdef012345",
      "description": "Тээврийн хэрэгслийн татвар 2025",
      "amount": 45000,
      "status": "open",
      "dueDate": "2019-08-24T14:15:22Z",
      "issuedAt": "2019-08-24T14:15:22Z",
      "vehicleNo": "УБА1234",
      "payer": {
        "register": "УЁ95051000",
        "name": "Бат-Эрдэнэ"
      },
      "payee": {
        "id": "7000",
        "name": "Замын цагдаа"
      },
      "year": "2025"
    }
  ],
  "total": 90000
}
Empty

ref_num-аар хайх

ref_num-аар нэхэмжлэл лавлана.

GET
/api/v1/invoices/ref/{refNum}
X-API-Key<token>

In: header

Path Parameters

refNumstring

нэхэмжлэлийн ref_num

Response Body

curl -X GET "https://sandbox-tts.qpay.mn/api/v1/invoices/ref/2100000123456"
{
  "id": "3f0c2e2a-1b2c-4d5e-8f90-abcdef012345",
  "description": "Тээврийн хэрэгслийн татвар 2025",
  "amount": 45000,
  "status": "open",
  "dueDate": "2019-08-24T14:15:22Z",
  "issuedAt": "2019-08-24T14:15:22Z",
  "vehicleNo": "УБА1234",
  "payer": {
    "register": "УЁ95051000",
    "name": "Бат-Эрдэнэ"
  },
  "payee": {
    "id": "7000",
    "name": "Замын цагдаа"
  },
  "year": "2025"
}
Empty

Нэхэмжлэлийг шинэчилж лавлах

gov-pay invoice id → хадгалсан ref_num ШИНЭЭР лавлаж хамгийн сүүлийн төлвийг буцаана.

GET
/api/v1/invoices/{id}/refresh
X-API-Key<token>

In: header

Path Parameters

idstring

gov-pay invoice UUID

Formatuuid

Response Body

curl -X GET "https://sandbox-tts.qpay.mn/api/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08/refresh"
{
  "id": "3f0c2e2a-1b2c-4d5e-8f90-abcdef012345",
  "description": "Тээврийн хэрэгслийн татвар 2025",
  "amount": 45000,
  "status": "open",
  "dueDate": "2019-08-24T14:15:22Z",
  "issuedAt": "2019-08-24T14:15:22Z",
  "vehicleNo": "УБА1234",
  "payer": {
    "register": "УЁ95051000",
    "name": "Бат-Эрдэнэ"
  },
  "payee": {
    "id": "7000",
    "name": "Замын цагдаа"
  },
  "year": "2025"
}
Empty

Нэхэмжлэлийн cache хувь

gov-pay invoice id-аар DB-д хадгалсан хувийг буцаана (MoF дуудалтгүй).

GET
/api/v1/invoices/{id}
X-API-Key<token>

In: header

Path Parameters

idstring

gov-pay invoice UUID

Formatuuid

Response Body

curl -X GET "https://sandbox-tts.qpay.mn/api/v1/invoices/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "id": "3f0c2e2a-1b2c-4d5e-8f90-abcdef012345",
  "description": "Тээврийн хэрэгслийн татвар 2025",
  "amount": 45000,
  "status": "open",
  "dueDate": "2019-08-24T14:15:22Z",
  "issuedAt": "2019-08-24T14:15:22Z",
  "vehicleNo": "УБА1234",
  "payer": {
    "register": "УЁ95051000",
    "name": "Бат-Эрдэнэ"
  },
  "payee": {
    "id": "7000",
    "name": "Замын цагдаа"
  },
  "year": "2025"
}
Empty