Initiate invoice finance
post
/service/v1/initiateInvoiceFinance
This endpoint is used to intitiate invoice finance.
Request
Supported Media Types
- application/json
- application/xml
Header Parameters
-
appId: string
-
branchCode: string
-
userId: string
user id for SMS
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
Response
Supported Media Types
- application/json
- application/xml
201 Response
Returns the Id of the newly created Finance
Root Schema : schema
Type:
object
400 Response
Bad Request
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.
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
Nested Schema : codes
Type:
Show Source
array
-
Array of:
object ResponseCode
ResponseCode stores the response details.
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