Azeez Muibi
95 lines
2.2 KiB
JSON
95 lines
2.2 KiB
JSON
{
|
|
"get": {
|
|
"tags": ["Charges"],
|
|
"summary": "Get all charges with optional filtering",
|
|
"description": "Retrieve charges with various filter options including offer ID, charge code, etc.",
|
|
"operationId": "getCharges",
|
|
"parameters": [
|
|
{
|
|
"name": "offer_id",
|
|
"in": "query",
|
|
"description": "Filter by offer ID",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "SAL30"
|
|
},
|
|
{
|
|
"name": "code",
|
|
"in": "query",
|
|
"description": "Filter by charge code",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string"
|
|
},
|
|
"example": "INTEREST"
|
|
},
|
|
{
|
|
"name": "start_date",
|
|
"in": "query",
|
|
"description": "Filter by start date (ISO format)",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"example": "2023-01-01T00:00:00Z"
|
|
},
|
|
{
|
|
"name": "end_date",
|
|
"in": "query",
|
|
"description": "Filter by end date (ISO format)",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date-time"
|
|
},
|
|
"example": "2023-12-31T23:59:59Z"
|
|
},
|
|
{
|
|
"name": "page",
|
|
"in": "query",
|
|
"description": "Page number for pagination",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 1,
|
|
"minimum": 1
|
|
},
|
|
"example": 1
|
|
},
|
|
{
|
|
"name": "limit",
|
|
"in": "query",
|
|
"description": "Number of items per page (max 100)",
|
|
"required": false,
|
|
"schema": {
|
|
"type": "integer",
|
|
"default": 20,
|
|
"minimum": 1,
|
|
"maximum": 100
|
|
},
|
|
"example": 20
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Successful operation",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "../schemas/ChargesResponse.json"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"400": {
|
|
"description": "Invalid request"
|
|
},
|
|
"500": {
|
|
"description": "Internal server error"
|
|
}
|
|
}
|
|
}
|
|
} |