Jump to

• Request
• Response

Fetch the reconciliation transaction detail

get

/service/v1/getReconTmData

This endpoint fetches authorized reconciliation transaction detail.

Request

Supported Media Types

• application/json
• application/xml

Query Parameters

• reconTxnRefNo: string
  Request parameter

Header Parameters

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

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Successfully received invoicesPayments details

Body ()

Root Schema : ReconTxnDto

Type: object

each recon txn deatail

Show Source

• allocBasis(optional): string
• allocPayReconDtoList(optional): array allocPayReconDtoList
• authDtStamp(optional): string
• authId(optional): string
• branchCode(optional): string
• corporateId(optional): string
• expDrCrPayReconDtoList(optional): array expDrCrPayReconDtoList
• finPayReconDtoList(optional): array finPayReconDtoList
• id(optional): number
• lhsEntity(optional): string
• makerDtStamp(optional): string
• makerId(optional): string
• obReconInvCnTxnTwDtoList(optional): array obReconInvCnTxnTwDtoList
• obReconInvPmtTxnTwDtoList(optional): array obReconInvPmtTxnTwDtoList
• reconAction(optional): string
• reconCategory(optional): string
• reconDate(optional): string
• reconRule(optional): string
• reconRuleDefinitionDTO(optional): object ReconRuleDefinitionDTO
• reconRuleType(optional): string
• reconRuleVersion(optional): number
• reconTxnRefNo(optional): string
• reconType(optional): string
• rhsEntity(optional): string
• stage(optional): string
• totalAllocatedAmt(optional): number
• transactionStatus(optional): string

{
    "description":"each recon txn deatail",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "reconTxnRefNo":{
            "type":"string"
        },
        "reconCategory":{
            "type":"string"
        },
        "reconDate":{
            "type":"string"
        },
        "branchCode":{
            "type":"string"
        },
        "reconType":{
            "type":"string"
        },
        "reconRuleType":{
            "type":"string"
        },
        "reconRule":{
            "type":"string"
        },
        "reconRuleVersion":{
            "type":"number"
        },
        "lhsEntity":{
            "type":"string"
        },
        "rhsEntity":{
            "type":"string"
        },
        "makerId":{
            "type":"string"
        },
        "makerDtStamp":{
            "type":"string"
        },
        "authId":{
            "type":"string"
        },
        "authDtStamp":{
            "type":"string"
        },
        "transactionStatus":{
            "type":"string"
        },
        "reconAction":{
            "type":"string"
        },
        "stage":{
            "type":"string"
        },
        "corporateId":{
            "type":"string"
        },
        "allocBasis":{
            "type":"string"
        },
        "totalAllocatedAmt":{
            "type":"number"
        },
        "obReconInvPmtTxnTwDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconInvPmtDto"
            }
        },
        "obReconInvCnTxnTwDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconInvCnDto"
            }
        },
        "finPayReconDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/FinPayReconDto"
            }
        },
        "expDrCrPayReconDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExpDrCrPayReconDto"
            }
        },
        "allocPayReconDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllocPayReconDto"
            }
        },
        "reconRuleDefinitionDTO":{
            "$ref":"#/definitions/ReconRuleDefinitionDTO"
        }
    }
}

Nested Schema : allocPayReconDtoList

Type: array

Show Source

• Array of: object AllocPayReconDto
  Object for Allocation Payment

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

Nested Schema : expDrCrPayReconDtoList

Type: array

Show Source

• Array of: object ExpDrCrPayReconDto
  Object for ExpectedDebitCredit Payment Recon.

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

Nested Schema : finPayReconDtoList

Type: array

Show Source

• Array of: object FinPayReconDto
  Object for Finance Payment Recon.

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

Nested Schema : obReconInvCnTxnTwDtoList

Type: array

Show Source

• Array of: object ReconInvCnDto
  invoice and credit note detail

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

Nested Schema : obReconInvPmtTxnTwDtoList

Type: array

Show Source

• Array of: object ReconInvPmtDto
  invoice and payment detail

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

Nested Schema : ReconRuleDefinitionDTO

Type: object

Show Source

• allocationBasis(optional): string
  Allocation Basis
• approverRemarks(optional): string
  Approver Remarks
• authStatus(optional): string
  Authorization Status
• baseEntity(optional): string
  Base Entity
• baseOnAttr(optional): string
  Base on attribute
• checkerDateStamp(optional): string(date)
  Checker Date Stamp
• checkerId(optional): string
  Checker Id
• corporateId(optional): string
• doerRemarks(optional): string
  Doer Remarks
• genericCriteria(optional): string
  Generic Criteria
• groupsAndConditions(optional): array groupsAndConditions
• keyId(optional): string
  Key Id
• makerDateStamp(optional): string(date)
  Maker Date Stamp
• makerId(optional): string
  Maker Id
• modNo(optional): number
  Mod Number
• onceAuth(optional): string
  Once Auth
• reconAllocationDTO(optional): array reconAllocationDTO
• reconCategory(optional): string
  Recon Category
• reconType(optional): string
  Recon Type
• recordStatus(optional): string
  Record Status
• ruleDescription(optional): string
  Rule Description
• ruleId(optional): string
  Rule Id
• txnControllerRefNo(optional): string
  Transaction Controller Reference Number

{
    "type":"object",
    "properties":{
        "allocationBasis":{
            "type":"string",
            "description":"Allocation Basis"
        },
        "baseEntity":{
            "type":"string",
            "description":"Base Entity"
        },
        "baseOnAttr":{
            "type":"string",
            "description":"Base on attribute"
        },
        "genericCriteria":{
            "type":"string",
            "description":"Generic Criteria"
        },
        "reconCategory":{
            "type":"string",
            "description":"Recon Category"
        },
        "reconType":{
            "type":"string",
            "description":"Recon Type"
        },
        "ruleDescription":{
            "type":"string",
            "description":"Rule Description"
        },
        "ruleId":{
            "type":"string",
            "description":"Rule Id"
        },
        "txnControllerRefNo":{
            "type":"string",
            "description":"Transaction Controller Reference Number"
        },
        "keyId":{
            "type":"string",
            "description":"Key Id"
        },
        "modNo":{
            "type":"number",
            "description":"Mod Number"
        },
        "recordStatus":{
            "type":"string",
            "description":"Record Status"
        },
        "authStatus":{
            "type":"string",
            "description":"Authorization Status"
        },
        "onceAuth":{
            "type":"string",
            "description":"Once Auth"
        },
        "doerRemarks":{
            "type":"string",
            "description":"Doer Remarks"
        },
        "approverRemarks":{
            "type":"string",
            "description":"Approver Remarks"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker Id"
        },
        "makerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Maker Date Stamp"
        },
        "checkerDateStamp":{
            "type":"string",
            "format":"date",
            "description":"Checker Date Stamp"
        },
        "corporateId":{
            "type":"string"
        },
        "groupsAndConditions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RuleElementsDTO"
            }
        },
        "reconAllocationDTO":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ReconAllocationDTO"
            }
        }
    }
}

Nested Schema : AllocPayReconDto

Type: object

Object for Allocation Payment

Show Source

• accOwner(optional): string
• allocatedAmt(optional): number
• allocationPct(optional): number
• allocAttributes(optional): string
• allocBasis(optional): string
• allocEntity(optional): string
• allocStatus(optional): string
• allocVirtualAccNo(optional): string
• beneCode(optional): string
• beneficiaryCode(optional): string
• beneficiaryId(optional): string
• beneficiaryName(optional): string
• beneVirtualAccNo(optional): string
• corporateId(optional): string
• corporateName(optional): string
• counterpartyCode(optional): string
• counterpartyId(optional): string
• counterpartyName(optional): string
• creditAccNo(optional): string
• dcIndicator(optional): string
• extPmtRefNo(optional): string
• flag(optional): string
• id(optional): number
• isPmtAccVA(optional): string
• obdxRefNo(optional): string
• obvamRefNo(optional): string
• partyPaymentCode(optional): string
• paymentAmount(optional): number
• paymentBusinessDate(optional): string
• paymentCcy(optional): string
• paymentDate(optional): string
• paymentMode(optional): string
• paymentPartyId(optional): string
• paymentPartyName(optional): string
• paymentRefNo(optional): string
• paySeqNo(optional): integer(int64)
• pmtAllocatedAmt(optional): number
• pmtAllocationStatus(optional): string
• pmtReconStatus(optional): string
• pmtUnallocatedAmt(optional): number
• pmtUnmatchedAmt(optional): number
• programCode(optional): string
• reconAction(optional): string
• reconciledPmtAmt(optional): number
• reconDate(optional): string
• reconId(optional): string
• reconTxnRefNo(optional): string
• reconType(optional): string
• relationshipCode(optional): string
• remarks(optional): string
• remitterAccNo(optional): string

{
    "description":"Object for Allocation Payment ",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "reconType":{
            "type":"string"
        },
        "reconTxnRefNo":{
            "type":"string"
        },
        "allocVirtualAccNo":{
            "type":"string"
        },
        "allocEntity":{
            "type":"string"
        },
        "allocAttributes":{
            "type":"string"
        },
        "allocStatus":{
            "type":"string"
        },
        "allocatedAmt":{
            "type":"number"
        },
        "allocationPct":{
            "type":"number"
        },
        "pmtAllocatedAmt":{
            "type":"number"
        },
        "obvamRefNo":{
            "type":"string"
        },
        "corporateId":{
            "type":"string"
        },
        "corporateName":{
            "type":"string"
        },
        "counterpartyId":{
            "type":"string"
        },
        "counterpartyName":{
            "type":"string"
        },
        "obdxRefNo":{
            "type":"string"
        },
        "beneficiaryId":{
            "type":"string"
        },
        "beneficiaryName":{
            "type":"string"
        },
        "paymentPartyId":{
            "type":"string"
        },
        "paymentDate":{
            "type":"string"
        },
        "paymentMode":{
            "type":"string"
        },
        "beneCode":{
            "type":"string"
        },
        "paymentAmount":{
            "type":"number"
        },
        "paymentCcy":{
            "type":"string"
        },
        "reconciledPmtAmt":{
            "type":"number"
        },
        "beneVirtualAccNo":{
            "type":"string"
        },
        "pmtReconStatus":{
            "type":"string"
        },
        "pmtAllocationStatus":{
            "type":"string"
        },
        "reconAction":{
            "type":"string"
        },
        "reconDate":{
            "type":"string"
        },
        "extPmtRefNo":{
            "type":"string"
        },
        "paymentRefNo":{
            "type":"string"
        },
        "remitterAccNo":{
            "type":"string"
        },
        "creditAccNo":{
            "type":"string"
        },
        "dcIndicator":{
            "type":"string"
        },
        "reconId":{
            "type":"string"
        },
        "isPmtAccVA":{
            "type":"string"
        },
        "counterpartyCode":{
            "type":"string"
        },
        "partyPaymentCode":{
            "type":"string"
        },
        "beneficiaryCode":{
            "type":"string"
        },
        "accOwner":{
            "type":"string"
        },
        "allocBasis":{
            "type":"string"
        },
        "paymentPartyName":{
            "type":"string"
        },
        "remarks":{
            "type":"string"
        },
        "relationshipCode":{
            "type":"string"
        },
        "programCode":{
            "type":"string"
        },
        "paySeqNo":{
            "type":"integer",
            "format":"int64"
        },
        "pmtUnallocatedAmt":{
            "type":"number"
        },
        "pmtUnmatchedAmt":{
            "type":"number"
        },
        "paymentBusinessDate":{
            "type":"string"
        },
        "flag":{
            "type":"string"
        }
    }
}

Nested Schema : ExpDrCrPayReconDto

Type: object

Object for ExpectedDebitCredit Payment Recon.

Show Source

• accOwner(optional): string
• actualDate(optional): string
• allocationRequired(optional): string
• allocPayReconDtoList(optional): array allocPayReconDtoList
• amtMatched(optional): number
• applicationName(optional): string
• beneCode(optional): string
• beneficiaryId(optional): string
• beneName(optional): string
• beneVirtualAccNo(optional): string
• cashflowType(optional): string
• channel(optional): string
• corporateId(optional): string
• corporateName(optional): string
• counterpartyId(optional): string
• counterpartyName(optional): string
• customerRefNo(optional): string
• dcIndicator(optional): string
• exchRate(optional): number
• expDrcrAmt(optional): number
• expDrcrBankAccNumber(optional): string
• expDrcrCcy(optional): string
• expDrcrCode(optional): string
• expDrcrCodeDesc(optional): string
• expDrcrDate(optional): string
• expDrcrIndicator(optional): string
• expDrcrNarration(optional): string
• expDrcrRefNo(optional): string
• expDrcrVirtualAccNo(optional): string
• expectedNetInvAmt(optional): number
• externalAccNo(optional): string
• externalDrcrRefNo(optional): string
• externalPmtRefNo(optional): string
• extSysRefNo(optional): string
• flag(optional): string
• id(optional): number
• isPmtAccVA(optional): string
• matchSeqNo(optional): string
• partyName(optional): string
• partyPaymentCode(optional): string
• payCounterpartyCode(optional): string
• payCounterpartyId(optional): string
• payCounterpartyName(optional): string
• paymentAmount(optional): number
• paymentBusinessDate(optional): string
• paymentCcy(optional): string
• paymentDate(optional): string
• paymentMode(optional): string
• paymentPartyId(optional): string
• paymentPartyName(optional): string
• paymentRefNo(optional): string
• paySeqNo(optional): integer(int64)
• pmtProgramCode(optional): string
• pmtRelationshipCode(optional): string
• pmtStatus(optional): string
• reconciledPmtAmt(optional): number
• reconDate(optional): string
• reconStatus(optional): string
• reconTxnRefNo(optional): string
• reconType(optional): string
• remarks(optional): string
• remitterAccNo(optional): string
• revisedDrcrDate(optional): string
• udfTxt1(optional): string
• udfTxt10(optional): string
• udfTxt2(optional): string
• udfTxt3(optional): string
• udfTxt4(optional): string
• udfTxt5(optional): string
• udfTxt6(optional): string
• udfTxt7(optional): string
• udfTxt8(optional): string
• udfTxt9(optional): string

{
    "description":"Object for ExpectedDebitCredit Payment Recon.",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "reconTxnRefNo":{
            "type":"string"
        },
        "matchSeqNo":{
            "type":"string"
        },
        "expDrcrCcy":{
            "type":"string"
        },
        "expDrcrVirtualAccNo":{
            "type":"string"
        },
        "amtMatched":{
            "type":"number"
        },
        "payCounterpartyId":{
            "type":"string"
        },
        "payCounterpartyName":{
            "type":"string"
        },
        "paymentPartyId":{
            "type":"string"
        },
        "paymentPartyName":{
            "type":"string"
        },
        "paymentMode":{
            "type":"string"
        },
        "beneCode":{
            "type":"string"
        },
        "beneName":{
            "type":"string"
        },
        "paymentCcy":{
            "type":"string"
        },
        "exchRate":{
            "type":"number"
        },
        "reconciledPmtAmt":{
            "type":"number"
        },
        "beneVirtualAccNo":{
            "type":"string"
        },
        "pmtStatus":{
            "type":"string"
        },
        "reconStatus":{
            "type":"string"
        },
        "reconDate":{
            "type":"string"
        },
        "expDrcrCodeDesc":{
            "type":"string"
        },
        "expDrcrIndicator":{
            "type":"string"
        },
        "expDrcrBankAccNumber":{
            "type":"string"
        },
        "expDrcrNarration":{
            "type":"string"
        },
        "expDrcrAmt":{
            "type":"number"
        },
        "expectedNetInvAmt":{
            "type":"number"
        },
        "expDrcrDate":{
            "type":"string"
        },
        "revisedDrcrDate":{
            "type":"string"
        },
        "paymentDate":{
            "type":"string"
        },
        "paymentAmount":{
            "type":"number"
        },
        "expDrcrCode":{
            "type":"string"
        },
        "externalAccNo":{
            "type":"string"
        },
        "expDrcrRefNo":{
            "type":"string"
        },
        "paymentRefNo":{
            "type":"string"
        },
        "externalPmtRefNo":{
            "type":"string"
        },
        "externalDrcrRefNo":{
            "type":"string"
        },
        "corporateId":{
            "type":"string"
        },
        "corporateName":{
            "type":"string"
        },
        "counterpartyId":{
            "type":"string"
        },
        "counterpartyName":{
            "type":"string"
        },
        "extSysRefNo":{
            "type":"string"
        },
        "cashflowType":{
            "type":"string"
        },
        "actualDate":{
            "type":"string"
        },
        "channel":{
            "type":"string"
        },
        "applicationName":{
            "type":"string"
        },
        "udfTxt1":{
            "type":"string"
        },
        "udfTxt2":{
            "type":"string"
        },
        "udfTxt3":{
            "type":"string"
        },
        "udfTxt4":{
            "type":"string"
        },
        "udfTxt5":{
            "type":"string"
        },
        "udfTxt6":{
            "type":"string"
        },
        "udfTxt7":{
            "type":"string"
        },
        "udfTxt8":{
            "type":"string"
        },
        "udfTxt9":{
            "type":"string"
        },
        "udfTxt10":{
            "type":"string"
        },
        "remitterAccNo":{
            "type":"string"
        },
        "dcIndicator":{
            "type":"string"
        },
        "accOwner":{
            "type":"string"
        },
        "isPmtAccVA":{
            "type":"string"
        },
        "partyName":{
            "type":"string"
        },
        "customerRefNo":{
            "type":"string"
        },
        "remarks":{
            "type":"string"
        },
        "reconType":{
            "type":"string"
        },
        "allocationRequired":{
            "type":"string"
        },
        "beneficiaryId":{
            "type":"string"
        },
        "payCounterpartyCode":{
            "type":"string"
        },
        "partyPaymentCode":{
            "type":"string"
        },
        "pmtRelationshipCode":{
            "type":"string"
        },
        "pmtProgramCode":{
            "type":"string"
        },
        "paymentBusinessDate":{
            "type":"string"
        },
        "flag":{
            "type":"string"
        },
        "allocPayReconDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllocPayReconDto"
            }
        },
        "paySeqNo":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : allocPayReconDtoList

Type: array

Show Source

• Array of: object AllocPayReconDto
  Object for Allocation Payment

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

Nested Schema : FinPayReconDto

Type: object

Object for Finance Payment Recon.

Show Source

• allocationRequired(optional): string
  Allocation Required
• allocationStatus(optional): boolean
  Allocation Status
• allocPayReconDtoList(optional): array allocPayReconDtoList
• amtMatched(optional): number
• anchorId(optional): string
• anchorName(optional): string
• beneCode(optional): string
• beneName(optional): string
• beneVirtualAccNo(optional): string
• counterpartyId(optional): string
• counterpartyName(optional): string
• exchRate(optional): number
• finAmt(optional): number
• finBuyerId(optional): string
• finBuyerName(optional): string
• finCcy(optional): string
• finEndDt(optional): string
• finOsAmt(optional): number
• finPastDueDt(optional): string
• finProgramCode(optional): string
• finRefNo(optional): string
• finSeqNo(optional): string
• finStartDt(optional): string
• finSupplierId(optional): string
• finSupplierName(optional): string
• id(optional): number
• intOsAmt(optional): number
• matchSeqNo(optional): string
• overdueIntOsAmt(optional): number
• paymentAmount(optional): number
• paymentCcy(optional): string
• paymentDate(optional): string
• paymentMode(optional): string
• paymentPartyId(optional): string
• paymentPartyName(optional): string
• paymentRefNo(optional): string
• paySeqNo(optional): integer(int64)
• penIntOsAmt(optional): number
• pmtProgramCode(optional): string
• pmtStatus(optional): string
• reconcileBy(optional): string
• reconciledPmtAmt(optional): number
• reconDate(optional): string
• reconStatus(optional): string
• reconTxnRefNo(optional): string
• totIntOsAmt(optional): number

{
    "description":"Object for Finance Payment Recon.",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "reconTxnRefNo":{
            "type":"string"
        },
        "matchSeqNo":{
            "type":"string"
        },
        "finBuyerId":{
            "type":"string"
        },
        "finSupplierId":{
            "type":"string"
        },
        "finBuyerName":{
            "type":"string"
        },
        "finSupplierName":{
            "type":"string"
        },
        "finProgramCode":{
            "type":"string"
        },
        "finRefNo":{
            "type":"string"
        },
        "finSeqNo":{
            "type":"string"
        },
        "finStartDt":{
            "type":"string"
        },
        "finEndDt":{
            "type":"string"
        },
        "finPastDueDt":{
            "type":"string"
        },
        "finCcy":{
            "type":"string"
        },
        "finAmt":{
            "type":"number"
        },
        "finOsAmt":{
            "type":"number"
        },
        "intOsAmt":{
            "type":"number"
        },
        "penIntOsAmt":{
            "type":"number"
        },
        "overdueIntOsAmt":{
            "type":"number"
        },
        "totIntOsAmt":{
            "type":"number"
        },
        "amtMatched":{
            "type":"number"
        },
        "paymentRefNo":{
            "type":"string"
        },
        "paymentPartyId":{
            "type":"string"
        },
        "paymentPartyName":{
            "type":"string"
        },
        "paymentDate":{
            "type":"string"
        },
        "paymentMode":{
            "type":"string"
        },
        "beneCode":{
            "type":"string"
        },
        "beneName":{
            "type":"string"
        },
        "paymentAmount":{
            "type":"number"
        },
        "paymentCcy":{
            "type":"string"
        },
        "exchRate":{
            "type":"number"
        },
        "reconciledPmtAmt":{
            "type":"number"
        },
        "beneVirtualAccNo":{
            "type":"string"
        },
        "pmtStatus":{
            "type":"string"
        },
        "reconStatus":{
            "type":"string"
        },
        "reconDate":{
            "type":"string"
        },
        "reconcileBy":{
            "type":"string"
        },
        "paySeqNo":{
            "type":"integer",
            "format":"int64"
        },
        "anchorId":{
            "type":"string"
        },
        "anchorName":{
            "type":"string"
        },
        "counterpartyId":{
            "type":"string"
        },
        "counterpartyName":{
            "type":"string"
        },
        "allocationStatus":{
            "type":"boolean",
            "description":"Allocation Status"
        },
        "allocationRequired":{
            "type":"string",
            "description":"Allocation Required"
        },
        "allocPayReconDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllocPayReconDto"
            }
        },
        "pmtProgramCode":{
            "type":"string"
        }
    }
}

Nested Schema : allocPayReconDtoList

Type: array

Show Source

• Array of: object AllocPayReconDto
  Object for Allocation Payment

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

Nested Schema : ReconInvCnDto

Type: object

invoice and credit note detail

Show Source

• accountNumber(optional): string
• accountOwner(optional): string
• amtMatched(optional): number
• cnBaseAmount(optional): number
• cnBuyerCode(optional): string
• cnBuyerDivCode(optional): string
• cnBuyerId(optional): string
• cnBuyerName(optional): string
• cnCurrency(optional): string
• cnDate(optional): string
• cnExpiryDate(optional): string
• cnInternalId(optional): string
• cnNumber(optional): string
• cnProgramCode(optional): string
• cnReconStatus(optional): string
• cnRelationCode(optional): string
• cnSeqNo(optional): integer(int64)
• cnSupplierCode(optional): string
• cnSupplierDivCode(optional): string
• cnSupplierId(optional): string
• cnSupplierName(optional): string
• corporateId(optional): string
• deReconFlag(optional): string
• exchRate(optional): number
• extInvRefNo(optional): string
• extSysRefNo(optional): string
• filler1(optional): string
• filler10(optional): string
• filler2(optional): string
• filler3(optional): string
• filler4(optional): string
• filler5(optional): string
• filler6(optional): string
• filler7(optional): string
• filler8(optional): string
• filler9(optional): string
• id(optional): number
• importFactorId(optional): string
• importFactorName(optional): string
• insuranceCoId(optional): string
• insuranceCoName(optional): string
• intInvRefNo(optional): string
• invBaseAmt(optional): number
• invBuyerId(optional): string
• invBuyerName(optional): string
• invCcy(optional): string
• invDate(optional): string
• invDueDate(optional): string
• invFinanced(optional): string
• invOsAmt(optional): number
• invProgramCode(optional): string
• invRelationCode(optional): string
• invSeqNo(optional): integer(int64)
• invSupplierId(optional): string
• invSupplierName(optional): string
• invVirtualAccNo(optional): string
• isCnAccVa(optional): string
• isInvAccVa(optional): string
• linkedDeReconTxnRef(optional): string
• netCnAmount(optional): number
• netInvAmt(optional): number
• paymentDueDate(optional): string
• paymentParty(optional): string
• procBranchCode(optional): string
• procBranchDate(optional): string
• reconciledCnAmt(optional): number
• reconDate(optional): string
• reconStatus(optional): string
• reconTxnRefNo(optional): string
• reconType(optional): string
• remarks(optional): string
• remitterAccNo(optional): string
• seqNo(optional): number
• varianceAmount(optional): number

{
    "description":"invoice and credit note detail",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "seqNo":{
            "type":"number"
        },
        "reconType":{
            "type":"string"
        },
        "cnNumber":{
            "type":"string"
        },
        "cnDate":{
            "type":"string"
        },
        "cnExpiryDate":{
            "type":"string"
        },
        "cnRelationCode":{
            "type":"string"
        },
        "cnBuyerCode":{
            "type":"string"
        },
        "cnBuyerId":{
            "type":"string"
        },
        "cnSupplierCode":{
            "type":"string"
        },
        "cnSupplierId":{
            "type":"string"
        },
        "cnBuyerDivCode":{
            "type":"string"
        },
        "cnSupplierDivCode":{
            "type":"string"
        },
        "cnSupplierName":{
            "type":"string"
        },
        "cnBuyerName":{
            "type":"string"
        },
        "cnCurrency":{
            "type":"string"
        },
        "cnBaseAmount":{
            "type":"number"
        },
        "netCnAmount":{
            "type":"number"
        },
        "cnProgramCode":{
            "type":"string"
        },
        "cnReconStatus":{
            "type":"string"
        },
        "procBranchCode":{
            "type":"string"
        },
        "procBranchDate":{
            "type":"string"
        },
        "cnInternalId":{
            "type":"string"
        },
        "remarks":{
            "type":"string"
        },
        "filler1":{
            "type":"string"
        },
        "filler2":{
            "type":"string"
        },
        "filler3":{
            "type":"string"
        },
        "filler4":{
            "type":"string"
        },
        "filler5":{
            "type":"string"
        },
        "filler6":{
            "type":"string"
        },
        "filler7":{
            "type":"string"
        },
        "filler8":{
            "type":"string"
        },
        "filler9":{
            "type":"string"
        },
        "filler10":{
            "type":"string"
        },
        "intInvRefNo":{
            "type":"string"
        },
        "invBuyerId":{
            "type":"string"
        },
        "invBuyerName":{
            "type":"string"
        },
        "invCcy":{
            "type":"string"
        },
        "invDate":{
            "type":"string"
        },
        "invDueDate":{
            "type":"string"
        },
        "invFinanced":{
            "type":"string"
        },
        "invOsAmt":{
            "type":"number"
        },
        "invProgramCode":{
            "type":"string"
        },
        "invRelationCode":{
            "type":"string"
        },
        "invSupplierId":{
            "type":"string"
        },
        "extInvRefNo":{
            "type":"string"
        },
        "invSupplierName":{
            "type":"string"
        },
        "invVirtualAccNo":{
            "type":"string"
        },
        "netInvAmt":{
            "type":"number"
        },
        "varianceAmount":{
            "type":"number"
        },
        "accountNumber":{
            "type":"string"
        },
        "accountOwner":{
            "type":"string"
        },
        "amtMatched":{
            "type":"number"
        },
        "corporateId":{
            "type":"string"
        },
        "deReconFlag":{
            "type":"string"
        },
        "exchRate":{
            "type":"number"
        },
        "importFactorId":{
            "type":"string"
        },
        "importFactorName":{
            "type":"string"
        },
        "insuranceCoId":{
            "type":"string"
        },
        "insuranceCoName":{
            "type":"string"
        },
        "extSysRefNo":{
            "type":"string"
        },
        "isInvAccVa":{
            "type":"string"
        },
        "isCnAccVa":{
            "type":"string"
        },
        "linkedDeReconTxnRef":{
            "type":"string"
        },
        "reconciledCnAmt":{
            "type":"number"
        },
        "reconDate":{
            "type":"string"
        },
        "reconStatus":{
            "type":"string"
        },
        "reconTxnRefNo":{
            "type":"string"
        },
        "remitterAccNo":{
            "type":"string"
        },
        "invSeqNo":{
            "type":"integer",
            "format":"int64"
        },
        "cnSeqNo":{
            "type":"integer",
            "format":"int64"
        },
        "paymentParty":{
            "type":"string"
        },
        "invBaseAmt":{
            "type":"number"
        },
        "paymentDueDate":{
            "type":"string"
        }
    }
}

Nested Schema : ReconInvPmtDto

Type: object

invoice and payment detail

Show Source

• accountNo(optional): string
• accOwner(optional): string
• allocationRequired(optional): string
• allocPayReconDtoList(optional): array allocPayReconDtoList
• amtMatched(optional): number
• beneCode(optional): string
• beneficiaryId(optional): string
• beneName(optional): string
• beneVirtualAccNo(optional): string
• corporateId(optional): string
• counterpartyCode(optional): string
• dateReferenceBasis(optional): string
• dcIndicator(optional): string
• exchRate(optional): number
• extInvRefNo(optional): string
• extPmtRefNo(optional): string
• extSysRefNo(optional): string
• flag(optional): string
• id(optional): number
• importFactorId(optional): string
• importFactorName(optional): string
• indicator(optional): string
• insuranceCoId(optional): string
• insuranceCoName(optional): string
• intInvRefNo(optional): string
• invBaseAmt(optional): number
• invBuyerId(optional): string
• invBuyerName(optional): string
• invCcy(optional): string
• invDate(optional): string
• invDueDate(optional): string
• invFinanced(optional): string
• invOsAmt(optional): number
• invProgramCode(optional): string
• invRelationCode(optional): string
• invSeqNo(optional): integer(int64)
• invSupplierId(optional): string
• invSupplierName(optional): string
• invVirtualAccNo(optional): string
• isIndirectPayment(optional): string
• isInvAccVa(optional): string
• isPmtAccVA(optional): string
• isPUA(optional): string
• matchSeqNo(optional): string
• netInvAmt(optional): number
• paidAmount(optional): number
• partyPaymentCode(optional): string
• payCounterpartyId(optional): string
• payCounterpartyName(optional): string
• paymentAmount(optional): number
• paymentBusinessDate(optional): string
• paymentCcy(optional): string
• paymentDate(optional): string
• paymentDueDate(optional): string
• paymentMode(optional): string
• paymentParty(optional): string
• paymentPartyId(optional): string
• paymentPartyName(optional): string
• paymentRefNo(optional): string
• paySeqNo(optional): integer(int64)
• pmtProgramCode(optional): string
• pmtRelationshipCode(optional): string
• pmtStatus(optional): string
• reconcileBy(optional): string
• reconciledPmtAmt(optional): number
• reconDate(optional): string
• reconPmtAmount(optional): number
• reconPmtAmountCcy(optional): string
• reconStatus(optional): string
• reconTxnRefNo(optional): string
• reconType(optional): string
• remarks(optional): string
• remitterAccNo(optional): string
• varianceAmount(optional): number

{
    "description":"invoice and payment detail",
    "type":"object",
    "properties":{
        "id":{
            "type":"number"
        },
        "reconTxnRefNo":{
            "type":"string"
        },
        "matchSeqNo":{
            "type":"string"
        },
        "invBuyerId":{
            "type":"string"
        },
        "invSupplierId":{
            "type":"string"
        },
        "invBuyerName":{
            "type":"string"
        },
        "invSupplierName":{
            "type":"string"
        },
        "invRelationCode":{
            "type":"string"
        },
        "extInvRefNo":{
            "type":"string"
        },
        "intInvRefNo":{
            "type":"string"
        },
        "invDate":{
            "type":"string"
        },
        "invDueDate":{
            "type":"string"
        },
        "netInvAmt":{
            "type":"number"
        },
        "invCcy":{
            "type":"string"
        },
        "invVirtualAccNo":{
            "type":"string"
        },
        "invOsAmt":{
            "type":"number"
        },
        "invFinanced":{
            "type":"string"
        },
        "amtMatched":{
            "type":"number"
        },
        "paymentRefNo":{
            "type":"string"
        },
        "paymentPartyId":{
            "type":"string"
        },
        "paymentPartyName":{
            "type":"string"
        },
        "paymentDate":{
            "type":"string"
        },
        "paymentMode":{
            "type":"string"
        },
        "beneCode":{
            "type":"string"
        },
        "beneName":{
            "type":"string"
        },
        "paymentAmount":{
            "type":"number"
        },
        "paymentCcy":{
            "type":"string"
        },
        "exchRate":{
            "type":"number"
        },
        "reconciledPmtAmt":{
            "type":"number"
        },
        "beneVirtualAccNo":{
            "type":"string"
        },
        "pmtStatus":{
            "type":"string"
        },
        "reconStatus":{
            "type":"string"
        },
        "reconDate":{
            "type":"string"
        },
        "reconcileBy":{
            "type":"string"
        },
        "extPmtRefNo":{
            "type":"string"
        },
        "extSysRefNo":{
            "type":"string"
        },
        "accountNo":{
            "type":"string"
        },
        "beneficiaryId":{
            "type":"string"
        },
        "payCounterpartyId":{
            "type":"string"
        },
        "payCounterpartyName":{
            "type":"string"
        },
        "remitterAccNo":{
            "type":"string"
        },
        "dateReferenceBasis":{
            "type":"string"
        },
        "dcIndicator":{
            "type":"string"
        },
        "remarks":{
            "type":"string"
        },
        "pmtProgramCode":{
            "type":"string"
        },
        "pmtRelationshipCode":{
            "type":"string"
        },
        "invProgramCode":{
            "type":"string"
        },
        "accOwner":{
            "type":"string"
        },
        "isInvAccVa":{
            "type":"string"
        },
        "isPmtAccVA":{
            "type":"string"
        },
        "partyPaymentCode":{
            "type":"string"
        },
        "counterpartyCode":{
            "type":"string"
        },
        "allocationRequired":{
            "type":"string"
        },
        "paymentDueDate":{
            "type":"string"
        },
        "reconType":{
            "type":"string"
        },
        "paidAmount":{
            "type":"number"
        },
        "isPUA":{
            "type":"string"
        },
        "isIndirectPayment":{
            "type":"string"
        },
        "paymentParty":{
            "type":"string"
        },
        "importFactorId":{
            "type":"string"
        },
        "importFactorName":{
            "type":"string"
        },
        "insuranceCoId":{
            "type":"string"
        },
        "insuranceCoName":{
            "type":"string"
        },
        "reconPmtAmount":{
            "type":"number"
        },
        "reconPmtAmountCcy":{
            "type":"string"
        },
        "varianceAmount":{
            "type":"number"
        },
        "corporateId":{
            "type":"string"
        },
        "invBaseAmt":{
            "type":"number"
        },
        "paymentBusinessDate":{
            "type":"string"
        },
        "flag":{
            "type":"string"
        },
        "indicator":{
            "type":"string"
        },
        "allocPayReconDtoList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AllocPayReconDto"
            }
        },
        "invSeqNo":{
            "type":"integer",
            "format":"int64"
        },
        "paySeqNo":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : allocPayReconDtoList

Type: array

Show Source

• Array of: object AllocPayReconDto
  Object for Allocation Payment

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

Nested Schema : groupsAndConditions

Type: array

Show Source

• Array of: object RuleElementsDTO

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

Nested Schema : reconAllocationDTO

Type: array

Show Source

• Array of: object ReconAllocationDTO

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

Nested Schema : RuleElementsDTO

Type: object

Show Source

• connectingOperator(optional): string
  Logical Operator applied between all groups, this is the connecting operator
• groupsAndConditions(optional): array groupsAndConditions
• id(optional): string
  Unique identifier for a group or condition
• isGroup(optional): boolean
  Boolean value to identify whether this child is a group or condition
• level(optional): number
  This helps to identify the nesting level.
• matchingCriteria(optional): string
  Matching Criteria
• patternTypeLHS(optional): object PatternTypeDTO
• patternTypeRHS(optional): object PatternTypeDTO
• reconEntityAttribLHS(optional): string
  Will be provided if Single entity is LHS entity or if single entity is N. Attribute which user wants to use for recon
• reconEntityAttribRHS(optional): string
  Will be provided if Single entity is RHS entity or if single entity is N. Attribute which user wants to use for recon
• reconEntityLHS(optional): string
  Should be null or not present if isGroup is true
• reconEntityRHS(optional): string
  Should be null or not present if isGroup is true

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Unique identifier for a group or condition"
        },
        "isGroup":{
            "type":"boolean",
            "description":"Boolean value to identify whether this child is a group or condition"
        },
        "connectingOperator":{
            "type":"string",
            "description":"Logical Operator applied between all groups, this is the connecting operator"
        },
        "level":{
            "type":"number",
            "description":"This helps to identify the nesting level."
        },
        "matchingCriteria":{
            "type":"string",
            "description":"Matching Criteria"
        },
        "reconEntityLHS":{
            "type":"string",
            "description":"Should be null or not present if isGroup is true"
        },
        "reconEntityAttribLHS":{
            "type":"string",
            "description":"Will be provided if Single entity is LHS entity or if single entity is N. Attribute which user wants to use for recon"
        },
        "reconEntityRHS":{
            "type":"string",
            "description":"Should be null or not present if isGroup is true"
        },
        "reconEntityAttribRHS":{
            "type":"string",
            "description":"Will be provided if Single entity is RHS entity or if single entity is N. Attribute which user wants to use for recon"
        },
        "patternTypeLHS":{
            "$ref":"#/definitions/PatternTypeDTO"
        },
        "patternTypeRHS":{
            "$ref":"#/definitions/PatternTypeDTO"
        },
        "groupsAndConditions":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RuleElementsDTO"
            }
        }
    }
}

Nested Schema : groupsAndConditions

Type: array

Show Source

• Array of: object RuleElementsDTO

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

Nested Schema : PatternTypeDTO

Type: object

Show Source

• inputValue1(optional): string
  Input Value1
• inputValue2(optional): string
  Input Value2
• type(optional): string
  Type

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"Type"
        },
        "inputValue1":{
            "type":"string",
            "description":"Input Value1"
        },
        "inputValue2":{
            "type":"string",
            "description":"Input Value2"
        }
    }
}

Nested Schema : ReconAllocationDTO

Type: object

Show Source

• action(optional): string
  Action
• allocationParameter(optional): string
  Allocation Parameter
• customerId(optional): string
• id(optional): string
  Id
• percentage(optional): number
  Percentage
• reconRuleDefinitionId(optional): string
  Recon Rule Definition Id

{
    "type":"object",
    "properties":{
        "action":{
            "type":"string",
            "description":"Action"
        },
        "allocationParameter":{
            "type":"string",
            "description":"Allocation Parameter"
        },
        "id":{
            "type":"string",
            "description":"Id"
        },
        "percentage":{
            "type":"number",
            "description":"Percentage"
        },
        "reconRuleDefinitionId":{
            "type":"string",
            "description":"Recon Rule Definition Id"
        },
        "customerId":{
            "type":"string"
        }
    }
}

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