Jump to

• Request
• Response

Fetch the reconciliation categories for a specific language

get

/service/v1/reconCategories

This endpoint fetches reconciliation categories for a specific language.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• language(optional): string
  Language

Header Parameters

• appId: string
  App Id
• branchCode: string
  Branch Code
• userId: string
  User Id

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Body ()

Root Schema : ReconCategoriesResponseDto

Type: object

Show Source

• categories(optional): array categories

{
    "type":"object",
    "properties":{
        "categories":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconCategoryDto"
            }
        }
    }
}

Nested Schema : categories

Type: array

Show Source

• Array of: object ReconCategoryDto

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReconCategoryDto"
    }
}

Nested Schema : ReconCategoryDto

Type: object

Show Source

• allocationRequired(optional): string
  Allocation Required
• categoryDesc(optional): string
  Category Description
• categoryName(optional): string
  Category Name
• entities(optional): array entities

{
    "type":"object",
    "properties":{
        "categoryName":{
            "type":"string",
            "description":"Category Name"
        },
        "categoryDesc":{
            "type":"string",
            "description":"Category Description"
        },
        "allocationRequired":{
            "type":"string",
            "description":"Allocation Required"
        },
        "entities":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconEntityDto"
            }
        }
    }
}

Nested Schema : entities

Type: array

Show Source

• Array of: object ReconEntityDto

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/ReconEntityDto"
    }
}

Nested Schema : ReconEntityDto

Type: object

Show Source

• entityDesc(optional): string
  Entity Description
• entityName(optional): string
  Entity Name
• entityType(optional): string
  Entity Type

{
    "type":"object",
    "properties":{
        "entityName":{
            "type":"string",
            "description":"Entity Name"
        },
        "entityDesc":{
            "type":"string",
            "description":"Entity Description"
        },
        "entityType":{
            "type":"string",
            "description":"Entity Type"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

405 Response

Invalid input

500 Response

Internal error

Back to Top