Jump to

• Request
• Response

Get all valid accountstructures by customer

get

/service/accountstructures/getByCustomer

This endpoints will be used to Get all valid account structures maintenance records based on customer number.

Request

Supported Media Types

• application/json

Query Parameters

• accountGroupId(optional): string
  Virtual Multi-Currency Account Number
• accountLinkage(optional): string
  Type of real account number to be linked. Account or group level.
• limit(optional): integer
  limit is maximum no of records to be fetched
• offset(optional): integer
  offset is starting point of records to be fetched
• realAccountBrn(optional): string
  Branch Code of the Real Account Number
• realAccountNo(optional): string
  Real Account No of a VAM customer which is mapped to Structure code.
• realCustomerNo(optional): string
  Real Customer No for which Account Structure is maintained
• status(optional): string
  Record Status of the Virtual Account Structure
• structureCode(optional): string
  Account Structure Code of VAM customer
• structureDesc(optional): string
  Account Structure Code Description of VAM customer
• virtualMainAcc(optional): string
  Virtual Main Account no of a Structure Code.

Back to Top

Response

Supported Media Types

• application/json

201 Response

Returns message of succes or failure

Headers

• Location: string

Body ()

Root Schema : AccountMapViewCollection

Type: object

Collection of accmap.

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object AccountMapViewDTO

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : AccountMapViewDTO

Type: object

Show Source

• accountGroupId(optional): string
  Virtual Multi-Currency Account Number
• accountLinkage(optional): string
  Type of real account number to be linked. Account or group level.
• balance(optional): number
  Effective balance of header account
• count(optional): integer
  no of child account in structure
• creationDate(optional): string
  Structure creation date
• id(optional): string
  id of a account structure
• realAccountBrn(optional): string
  Branch code of the Real Account Number
• realAccountNo(optional): string
  Real Account Number for which the VA Structure is mapped
• realCustomerName(optional): string
  Real Customer name for which Virtual Account Structure is maintained
• realCustomerNo(optional): string
  Real Customer Number for which Virtual Account Structure is maintained
• status(optional): string
  Record Status of the Virtual Account Structure
• structureCode(optional): string
  Code to identify Virtual Account Structure
• structureDesc(optional): string
  Description of Virtual Account Structure
• virtualMainAcc(optional): string
  Virtual Main/Header Account
• virtualMainAccCcy(optional): string
  Currency of Virtual Main Account

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of a account structure"
        },
        "realCustomerNo":{
            "type":"string",
            "description":"Real Customer Number for which Virtual Account Structure is maintained"
        },
        "realCustomerName":{
            "type":"string",
            "description":"Real Customer name for which Virtual Account Structure is maintained"
        },
        "structureCode":{
            "type":"string",
            "description":"Code to identify Virtual Account Structure"
        },
        "structureDesc":{
            "type":"string",
            "description":"Description of Virtual Account Structure"
        },
        "virtualMainAcc":{
            "type":"string",
            "description":"Virtual Main/Header Account"
        },
        "accountLinkage":{
            "type":"string",
            "description":"Type of real account number to be linked. Account or group level."
        },
        "realAccountNo":{
            "type":"string",
            "description":"Real Account Number for which the VA Structure is mapped"
        },
        "realAccountBrn":{
            "type":"string",
            "description":"Branch code of the Real Account Number"
        },
        "accountGroupId":{
            "type":"string",
            "description":"Virtual Multi-Currency Account Number"
        },
        "creationDate":{
            "type":"string",
            "description":"Structure creation date"
        },
        "status":{
            "type":"string",
            "description":"Record Status of the Virtual Account Structure"
        },
        "virtualMainAccCcy":{
            "type":"string",
            "description":"Currency of Virtual Main Account"
        },
        "count":{
            "type":"integer",
            "description":"no of child account in structure"
        },
        "balance":{
            "type":"number",
            "description":"Effective balance of header account"
        }
    }
}

400 Response

Bad request error, the server is unable to process the request

401 Response

Unauthorized request error, invalid credentials

403 Response

Request denied, no permission to access the request.

405 Response

Request denied, invalid input.

500 Response

Internal server error.

Back to Top