Jump to

• Request
• Response

Get all accounting numbers

post

/service/v1/poolingAccountNumber

This endpoint is used to get all accounting entries with their details based on filter(query param) criterias.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• 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

Header Parameters

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

Body ()

Request Body that contains data required for creating a new accentrycode

Root Schema : GenericObscfCmAccountDTO

Type: object

Show Source

• applicationName(optional): string
  Application Name
• otherDetails(optional): object otherDetails
  Additional Properties Allowed: additionalProperties
• recordStat(optional): string
  Record Status
• refNo(optional): string
  Reference Number
• seqNo(optional): integer(int64)
  Sequence Number

{
    "type":"object",
    "required":[
        "applicationType"
    ],
    "properties":{
        "refNo":{
            "type":"string",
            "description":"Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"Sequence Number"
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name"
        },
        "recordStat":{
            "type":"string",
            "description":"Record Status"
        },
        "otherDetails":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        }
    }
}

Nested Schema : otherDetails

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of success or failure

Body ()

Root Schema : PoolingAccountCollection

Type: object

Collection of PoolingAccountResponse

Show Source

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

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

Nested Schema : data

Type: array

Show Source

• Array of: object PoolingAccountResponse
  Details of account no and currency

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

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

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

Nested Schema : PoolingAccountResponse

Type: object

Details of account no and currency

Show Source

• accountCcy(optional): string
  category of the param
• accountNumber(optional): string
  category of the param

{
    "description":"Details of account no and currency",
    "type":"object",
    "properties":{
        "accountNumber":{
            "description":"category of the param",
            "type":"string"
        },
        "accountCcy":{
            "description":"category of the param",
            "type":"string"
        }
    }
}

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