Previous Next JavaScript must be enabled to correctly display this content

## Get all valid contribution

get

/service/lms/contribution

This endpoint is used to get all valid contribution maintenance records.

### 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

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 : LmsTbContributionServiceCollection
Type: `object`
Collection of Contribution.
Show Source

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

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

Nested Schema : data
Type: `array`
Show Source

- Array of: object LmsTbContributionDTO

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

Nested Schema : PagingDto
Type: `object`
Show Source

- totalResults(optional): integer

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

Nested Schema : LmsTbContributionDTO
Type: `object`
Match All
Show Source

- allOf GenericDto
- object LmsTbContributionDTO-allOf[1]

    {
        "type":"object",
        "allOf":[
            {
                "$ref":"#/definitions/GenericDto"
            },
            {
                "type":"object",
                "properties":{
                    "executionId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[a-zA-Z0-9]{1,20}"
                    },
                    "structureId":{
                        "type":"string",
                        "description":"",
                        "pattern":"[0-9a-fA-Z-]{1,36}"
                    },
                    "toAccountNumber":{
                        "type":"string",
                        "description":"",
                        "maxLength":35
                    },
                    "toAccountBranch":{
                        "type":"string",
                        "description":"",
                        "maxLength":4
                    },
                    "toAccountCurrency":{
                        "type":"string",
                        "description":"",
                        "maxLength":3
                    },
                    "fromAccountNumber":{
                        "type":"string",
                        "description":"",
                        "maxLength":35
                    },
                    "fromAccountBranch":{
                        "type":"string",
                        "description":"",
                        "maxLength":4
                    },
                    "fromAccountCurrency":{
                        "type":"string",
                        "description":"",
                        "maxLength":3
                    },
                    "contributionAmount":{
                        "type":"number",
                        "description":""
                    },
                    "fromCurrencyAmount":{
                        "type":"number",
                        "description":""
                    },
                    "valueDate":{
                        "type":"string",
                        "description":""
                    },
                    "fxrate":{
                        "type":"number",
                        "description":""
                    },
                    "status":{
                        "type":"string",
                        "description":""
                    }
                }
            }
        ]
    }

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 : LmsTbContributionDTO-allOf[1]
Type: `object`
Show Source

- contributionAmount(optional): number
- executionId(optional): string
  Pattern: `[a-zA-Z0-9]{1,20}`
- fromAccountBranch(optional): string
  Maximum Length: `4`
- fromAccountCurrency(optional): string
  Maximum Length: `3`
- fromAccountNumber(optional): string
  Maximum Length: `35`
- fromCurrencyAmount(optional): number
- fxrate(optional): number
- status(optional): string
- structureId(optional): string
  Pattern: `[0-9a-fA-Z-]{1,36}`
- toAccountBranch(optional): string
  Maximum Length: `4`
- toAccountCurrency(optional): string
  Maximum Length: `3`
- toAccountNumber(optional): string
  Maximum Length: `35`
- valueDate(optional): string

    {
        "type":"object",
        "properties":{
            "executionId":{
                "type":"string",
                "description":"",
                "pattern":"[a-zA-Z0-9]{1,20}"
            },
            "structureId":{
                "type":"string",
                "description":"",
                "pattern":"[0-9a-fA-Z-]{1,36}"
            },
            "toAccountNumber":{
                "type":"string",
                "description":"",
                "maxLength":35
            },
            "toAccountBranch":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "toAccountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "fromAccountNumber":{
                "type":"string",
                "description":"",
                "maxLength":35
            },
            "fromAccountBranch":{
                "type":"string",
                "description":"",
                "maxLength":4
            },
            "fromAccountCurrency":{
                "type":"string",
                "description":"",
                "maxLength":3
            },
            "contributionAmount":{
                "type":"number",
                "description":""
            },
            "fromCurrencyAmount":{
                "type":"number",
                "description":""
            },
            "valueDate":{
                "type":"string",
                "description":""
            },
            "fxrate":{
                "type":"number",
                "description":""
            },
            "status":{
                "type":"string",
                "description":""
            }
        }
    }

#### 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