Inex API Documentation

დავალიანების შემოწმება

მიმდინარე სერვისით თქვენ შეძლებთ გაიგოთ ამანათის ან მომხმარებლის სრული დავალიანება.

GET /integrators/payments/debts/detail

ფილტრაციის პარამეტრები

აუცილებელია გადასცეთ მინიმუმ ერთი პარამეტრი: ან ოთახის ნომერი (roomNumber), ან თრექინგ კოდი (waybillNumber).

Field	Type	Required	Example	Description
roomNumber	string	Conditional	IG00001 Required if waybillNumber is missing.	მომხმარებლის ოთახის ნომერი.
waybillNumber	string	Conditional	TY7200934421231 Required if roomNumber is missing.	ამანათის თრექინგი Inex-ის სისტემაში.

პასუხის სტრუქტურა 200 OK

Attribute	Type	Example	Description
data.totalDebt	integer	1500	სრული დავალიანება თეთრებში/ცენტებში.
data.currency	string	GEL (ISO 4217)	რა ვალუტაშია დავალიანება.
data.invoices.*.invoiceNumber	string	INV-52446	ინვოისის ნომერი Inex-ის სისტემაში.
data.invoices.*.amount	integer	1000 (10 GEL)	ინვოისის ღირებულება თეთრებში/ცენტებში.
data.invoices.*.earnableBonus	integer	79 (0.79 GEL)	ბონუსი რომელიც დაერიცხება თეთრებში (GEL) .
data.invoices.*.serviceType	string	Transportation	სერვისის ტიპი. შესაძლო ვარიანტები: transportation, homeDelivery, customsDeclaration, insurance, orderStatement

სერვისების აღწერა

transportation	ტრანსპორტირების ღირებულება.
homeDelivery	მიწოდების ღირებულება - საკურიერო სერვისი.
customsDeclaration	სასბაჟო დეკლარაციის ღირებულება.
insurance	ამანათის დაზღვევის ღირებულება.
orderStatement	გამოწერაში დახმარების სერვისის ღირებულება.

შესაძლო პასუხები

Code	Description
200 OK	არსებული დავალიანების შესახებ ინფორმაცია.
404 Not Found	მომხმარებელი ან ამანათი არ მოიძებნა.
403 Forbidden	თქვენ არ გაქვთ ამ ოპერაციის შესრულების უფლება
422 Unprocessable	ვალიდაციის შეცდომა (არასწორი ტიპი ან გამოტოვებული ველი).

cURL Request BASH

curl -X GET https://api-staging.inex.ge/api/v1/integrators/payments/debts/detail \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"roomNumber": "IG00001",
}'

curl -X GET https://api-staging.inex.ge/api/v1/integrators/payments/debts/detail \
-H "Authorization: Bearer {TOKEN}" \
-H "Content-Type: application/json" \
-d '{
"waybillNumber": "TY7200934421231",
}'

Response (200 OK)

JSON Response JSON

{
    "totalDebt": 1500,
    "currency": "GEL",
    "invoices": [
        {
            "invoiceNumber": "INV-52446",
            "amount": 1000,
            "earnableBonus": 79,
            "serviceType": "transportation"
        },
        {
            "invoiceNumber": "INV-52392",
            "amount": 500,
            "earnableBonus": 0,
            "serviceType": "insurance"
        }
    ]
}

Error Response (403)

JSON Response JSON

{
    "errors": {
        "general": [
            "You are not authorized to perform this action. Contact administrator."
        ]
    },
    "message": "error"
}

Error Response (404)

JSON Response JSON

{
    "errors": {
        "general": [
            "Requested customer not found"
        ]
    },
    "message": "error"
}

Error Response (422)

JSON Response JSON

{
    "message": "The room number field is required when waybill number is not present. (and 1 more error)",
    "errors": {
        "roomNumber": [
            "The room number field is required when waybill number is not present."
        ],
        "waybillNumber": [
            "The waybill number field is required when room number is not present."
        ]
    }
}