Jump to

• Request
• Response

Save uploaded file data received through events

post

/service/v1/saveUploadedFileData

This endpoint is used to save uploaded file data received through events.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
  Application id
• branchCode: string
  Branch Code
• userId: string
  user id

Body ()

File Upload DTO

Root Schema : FileUploadDto

Type: object

File Upload DTO

Show Source

• channel(optional): string
  Channel
• count(optional): number
  Count
• eventType(optional): string
  Event type
• fileName(optional): string
  File Name
• fileRef(optional): string
  File Reference
• fileType(optional): string
  File Type
• invoiceFileId(optional): number
  Invoice File Id
• reasonCode(optional): string
  Reason code
• status(optional): string
  Status
• totalFailedRecords(optional): number
  Total Failed Records
• totalFileUploadValue(optional): string
  Total File Upload Value
• totalSuccessRecords(optional): number
  Total Success Records
• uploadDateAndTime(optional): string
  Upload Date And Time

{
    "description":"File Upload DTO",
    "type":"object",
    "properties":{
        "invoiceFileId":{
            "type":"number",
            "description":"Invoice File Id"
        },
        "channel":{
            "type":"string",
            "description":"Channel"
        },
        "fileType":{
            "type":"string",
            "description":"File Type"
        },
        "fileName":{
            "type":"string",
            "description":"File Name"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "fileRef":{
            "type":"string",
            "description":"File Reference"
        },
        "uploadDateAndTime":{
            "type":"string",
            "description":"Upload Date And Time"
        },
        "count":{
            "type":"number",
            "description":"Count"
        },
        "totalSuccessRecords":{
            "type":"number",
            "description":"Total Success Records"
        },
        "totalFailedRecords":{
            "type":"number",
            "description":"Total Failed Records"
        },
        "reasonCode":{
            "type":"string",
            "description":"Reason code"
        },
        "totalFileUploadValue":{
            "type":"string",
            "description":"Total File Upload Value"
        },
        "eventType":{
            "type":"string",
            "description":"Event type"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Successfully received file upload details

Body ()

Root Schema : schema

Type: boolean

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