Jump to

• Request
• Response

Get all valid withholding Tax

get

/withholdingtax

This endpoint is used to get all valid withholding tax maintenance records.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• authStat(optional): string
• headerAc(optional): string
  filter using pool header account
• includecloseandunauth(optional): boolean
  includecloseandunauth need to be set to fetch summary record, defult value is false
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting no of records to be fetched
• recordStat(optional): string
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

  filter using structureId

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : LmxTmInterestmapCollection

Type: object

Collection of interestmap.

Show Source

• data(optional): array data
• paging(optional): object PagingDto

{
    "description":"Collection of interestmap.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterestmapDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object LmxTmInterestmapDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : LmxTmInterestmapDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object LmxTmInterestmapDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "headerAc":{
                    "type":"string",
                    "description":"",
                    "maxLength":20
                },
                "headerAcIcgrp":{
                    "type":"string",
                    "description":"",
                    "maxLength":5
                },
                "internalIcgrp":{
                    "type":"string",
                    "description":"",
                    "maxLength":5
                },
                "structureId":{
                    "type":"string",
                    "description":"",
                    "pattern":"[A-Z0-9]{1,30}"
                },
                "LmxTmInterestmapDetDTO":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/LmxTmInterestmapDetDTO"
                    }
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : LmxTmInterestmapDTO-allOf[1]

Type: object

Show Source

• headerAc(optional): string
  Maximum Length: 20
• headerAcIcgrp(optional): string
  Maximum Length: 5
• internalIcgrp(optional): string
  Maximum Length: 5
• LmxTmInterestmapDetDTO(optional): array LmxTmInterestmapDetDTO
• structureId(optional): string
  Pattern: [A-Z0-9]{1,30}

{
    "type":"object",
    "properties":{
        "headerAc":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "headerAcIcgrp":{
            "type":"string",
            "description":"",
            "maxLength":5
        },
        "internalIcgrp":{
            "type":"string",
            "description":"",
            "maxLength":5
        },
        "structureId":{
            "type":"string",
            "description":"",
            "pattern":"[A-Z0-9]{1,30}"
        },
        "LmxTmInterestmapDetDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LmxTmInterestmapDetDTO"
            }
        }
    }
}

Nested Schema : LmxTmInterestmapDetDTO

Type: array

Show Source

• Array of: object LmxTmInterestmapDetDTO

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

Nested Schema : LmxTmInterestmapDetDTO

Type: object

Show Source

• childAccountNo(optional): string
  Maximum Length: 20
• childAcIcprd(optional): string
  Maximum Length: 5
• childFormulaNo(optional): number
• drcr(optional): string
  Maximum Length: 5
• headerAcIcprd(optional): string
  Maximum Length: 20
• headerFormulaNo(optional): number
• id(optional): string
  Maximum Length: 36
• interestmapMasterId(optional): string
  Maximum Length: 36

{
    "type":"object",
    "properties":{
        "childAcIcprd":{
            "type":"string",
            "description":"",
            "maxLength":5
        },
        "childFormulaNo":{
            "type":"number",
            "description":""
        },
        "drcr":{
            "type":"string",
            "description":"",
            "maxLength":5
        },
        "headerAcIcprd":{
            "type":"string",
            "description":"",
            "maxLength":20
        },
        "headerFormulaNo":{
            "type":"number",
            "description":""
        },
        "id":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "interestmapMasterId":{
            "type":"string",
            "description":"",
            "maxLength":36
        },
        "childAccountNo":{
            "type":"string",
            "description":"",
            "maxLength":20
        }
    }
}

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