Jump to

• Request
• Response

Batches the selected Invoice files

post

/service/v1/initiateInvoiceFinance

This endpoint is used to batche the selected Invoice files.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
• branchCode: string
• userId: string
  user id for SMS

Body ()

Request Body that contains data required for creating new Finance.

Root Schema : InvoiceRefCollection

Type: object

Collection of Invoice Reference Numbers.

Show Source

• disbursementCcy(optional): string
• docRefNo(optional): string
• financeAmt(optional): number
• financeRefNo(optional): string
• invoiceReferenceNoList(optional): array invoiceReferenceNoList
• isProgramLinked: string
• maxFinancePercentage(optional): number
• programCode(optional): string
• sourceTxnId(optional): string
• transactionRefNo(optional): string

{
    "description":"Collection of Invoice Reference Numbers.",
    "type":"object",
    "properties":{
        "invoiceReferenceNoList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "disbursementCcy":{
            "type":"string"
        },
        "maxFinancePercentage":{
            "type":"number"
        },
        "financeAmt":{
            "type":"number"
        },
        "programCode":{
            "type":"string"
        },
        "isProgramLinked":{
            "type":"string"
        },
        "sourceTxnId":{
            "type":"string"
        },
        "transactionRefNo":{
            "type":"string"
        },
        "financeRefNo":{
            "type":"string"
        },
        "docRefNo":{
            "type":"string"
        }
    },
    "required":[
        "isProgramLinked"
    ]
}

Nested Schema : invoiceReferenceNoList

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns the Id of the newly created Finance

Body ()

Root Schema : schema

Type: object

400 Response

Bad Request

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Collection of ResponseDto and ResponseResourceSupport

Show Source

• data(optional): object ResponseResourceSupport
  Response DTO which extends RepresentationModel of Spring HATEOAS
• messages(optional): object ResponseDto
  ResponseDto stores the response status and code.

{
    "description":"Collection of ResponseDto and ResponseResourceSupport",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Response DTO which extends RepresentationModel of Spring HATEOAS

Nested Schema : ResponseDto

Type: object

ResponseDto stores the response status and code.

Show Source

• codes(optional): array codes
• id(optional): string
• requestId(optional): string
• status(optional): string

{
    "description":"ResponseDto stores the response status and code.",
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ResponseCode
  ResponseCode stores the response details.

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

Nested Schema : ResponseCode

Type: object

ResponseCode stores the response details.

Show Source

• arg(optional): string
• args(optional): array args
• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "description":"ResponseCode stores the response details.",
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        },
        "args":{
            "type":"array",
            "items":{
                "type":"object"
            }
        },
        "arg":{
            "type":"string"
        }
    }
}

Nested Schema : args

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

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