Jump to

• Request
• Response

Retrieves the Invoice Finance Info for a particular Invoice

get

/service/v1/finances/{invoiceRefNo}

This endpoint is used to get the Invoice Finance Info for a particular Invoice.

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• invoiceRefNo: string
  ReferenceNumber for which data needs to be fetched

Query Parameters

• requestId: string
  Request Id

Header Parameters

• appId: string
• branchCode: string
• tenantId(optional): string
• userId: string
  user id for SMS

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successful performs the operation

Body ()

Root Schema : InvoiceFinanceModelCollection

Type: object

Collection of InvoiceFinanceModel.

Show Source

• invoiceFinanceModelList(optional): array invoiceFinanceModelList

{
    "description":"Collection of InvoiceFinanceModel.",
    "type":"object",
    "properties":{
        "invoiceFinanceModelList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/InvoiceFinanceModel"
            }
        }
    }
}

Nested Schema : invoiceFinanceModelList

Type: array

Show Source

• Array of: object InvoiceFinanceModel
  Invoice Finance Transaction Model

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

Nested Schema : InvoiceFinanceModel

Type: object

Invoice Finance Transaction Model

Show Source

• amtContriTwdsFin(optional): number
• appropriatedPaidAmt(optional): number
• appropriationSeq(optional): string
• buyerId(optional): string
• buyerName(optional): string
• disbursementMarginCalc(optional): number
• financeReferenceNo(optional): string
• finCcy(optional): string
• finMaturityDate(optional): string
• finTxnStatus(optional): string
• interestAmortized(optional): number
• interestOSAmt(optional): number
• interestPaidFinCcy(optional): number
• interestPaidInvCcy(optional): number
• interestType(optional): string
• invCcy(optional): string
• invoiceDueDate(optional): string
• invoiceNumber(optional): string
• invoiceRefNo(optional): string
• marginAmt(optional): number
• marginRefNo(optional): string
• overdueInterestOSAmt(optional): number
• overdueInterestPaidFinCcy(optional): number
• overdueInterestPaidInvCcy(optional): number
• pctContriTwdsFin(optional): number
• penaltyInterestOSAmt(optional): number
• penaltyInterestPaidFinCcy(optional): number
• penaltyInterestPaidInvCcy(optional): number
• principalOSAmt(optional): number
• principalPaidFinCcy(optional): number
• principalPaidInvCcy(optional): number
• productCode(optional): string
• programCode(optional): string
• requestId(optional): string
• scfInvoiceFinanceId(optional): integer(int64)
• status(optional): string
• supplierId(optional): string
• supplierName(optional): string
• totalPaidAmt(optional): number

{
    "description":"Invoice Finance Transaction Model",
    "type":"object",
    "properties":{
        "scfInvoiceFinanceId":{
            "type":"integer",
            "format":"int64"
        },
        "requestId":{
            "type":"string"
        },
        "financeReferenceNo":{
            "type":"string"
        },
        "invoiceNumber":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "invoiceRefNo":{
            "type":"string"
        },
        "finTxnStatus":{
            "type":"string"
        },
        "principalOSAmt":{
            "type":"number"
        },
        "interestOSAmt":{
            "type":"number"
        },
        "overdueInterestOSAmt":{
            "type":"number"
        },
        "penaltyInterestOSAmt":{
            "type":"number"
        },
        "pctContriTwdsFin":{
            "type":"number"
        },
        "amtContriTwdsFin":{
            "type":"number"
        },
        "interestAmortized":{
            "type":"number"
        },
        "interestPaidInvCcy":{
            "type":"number"
        },
        "marginAmt":{
            "type":"number"
        },
        "principalPaidInvCcy":{
            "type":"number"
        },
        "overdueInterestPaidInvCcy":{
            "type":"number"
        },
        "penaltyInterestPaidInvCcy":{
            "type":"number"
        },
        "marginRefNo":{
            "type":"string"
        },
        "finMaturityDate":{
            "type":"string"
        },
        "interestPaidFinCcy":{
            "type":"number"
        },
        "principalPaidFinCcy":{
            "type":"number"
        },
        "overdueInterestPaidFinCcy":{
            "type":"number"
        },
        "penaltyInterestPaidFinCcy":{
            "type":"number"
        },
        "invCcy":{
            "type":"string"
        },
        "totalPaidAmt":{
            "type":"number"
        },
        "productCode":{
            "type":"string"
        },
        "programCode":{
            "type":"string"
        },
        "buyerId":{
            "type":"string"
        },
        "buyerName":{
            "type":"string"
        },
        "supplierId":{
            "type":"string"
        },
        "supplierName":{
            "type":"string"
        },
        "finCcy":{
            "type":"string"
        },
        "appropriationSeq":{
            "type":"string"
        },
        "disbursementMarginCalc":{
            "type":"number"
        },
        "interestType":{
            "type":"string"
        },
        "appropriatedPaidAmt":{
            "type":"number"
        },
        "invoiceDueDate":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top