bcs-utilities-management-api-services

API INFORMATION

Title: Utilities-Management-Api-Services

Version: 1.0.0

Protocols: HTTPS

URI Sandbox: https://utilities-management-api-services-dev.us-e1.cloudhub.io/

URI QA: https://utilities-management-api-services-qa.us-e1.cloudhub.io/

URI Live:

DOWLOAD RAML

DESCRIPTION

This service allows management of agreements, allowing the following operations to be carried out:

Summary

- EntprAgreement

Path:

GET

/entpr-agreement-management/v1/entpr-agreement:

Headers

X-Invoker-Channel: Channel of origin of consumption

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Query Parameters:

initialRecord: Indicates the pagination page number

recordsXPage: Indicates the number of records per page

Response information:

resultsPagesGeneric: Pagination Information

totalRecords: Total Number of Records
recordsXPage: Number of Records Returned

entprAgreementList: Contains the agreement with the following information

govIssueIdent: Contains identification data

govIssueIdentType: ID Type

identSerialNum: Identification number

entprAgreementList:

entprAgreement: Contains agreement information

entprId: Agreement identifier

entprDesc: Description of the agreement

postAddr: Contains the field "addr1" which indicates the address

phoneNum: Contains the "phone" field which indicates the contact number

branchId: Office identifier

cityId: City ​​identifier

Example of Body to Response Successfull

{
  "resultsPagesGeneric": {
"totalRecords": "50",
"recordsXPage": "10"
  },
  "entprAgreementList": [
{
  "govIssueIdent": {
"govIssueIdentType": "NI",
"identSerialNum": "8160079163"
  },
      "entprAgreement": {
        "entprId": "1121302",
        "entprDesc": "AMV SA ASOCIADOS MARIN VALENCIA SA",
        "postAddr": {
            "addr1": "KR 29 45 45 PISO 15"
          },
        "phoneNum": {
          "phone": "6970307"
        },
        "branchId": "0502",
        "cityId": "68001"
      }
    }
  ]
}

Errors Code.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00502",
      "errorDesc": "CUENTA NO EXISTE.",
       "errorType": "DBA"
   }
}

Diagrama Of Sequence.

- Loan Agreement

Path:

GET

/utilities-management/v1/loan-agreement:

Headers

X-Invoker-Channel: Channel of origin of consumption

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Query Parameters:

govIssueIdentType: Type of customer identification

identSerialNum: Customer Identification Number

Response information:

govIssueIdent: Person Information

govIssueIdentType: Type of customer identification

identSerialNum: Customer Identification Number

entprAgreementList: Contains the agreement with the following information

entprAgreement: Contains agreement information

improvementAmt: Progress Improvement

entprId: Company ID

status: Status Agreement

issueDt: Creation Date

statusDt: Status Date

improvementDt: Improvement Date

entprGuid: GUID Loan Agreement

updateDt: Modification Date

entprDesc: Description of the agreement

scvIdent: Agreement Number

refNumber: Radication ID

desc: Observations

reasonStatus: Reason Status

flagAgreementsOtherEntpr: Has Agreements with Other Entities

entprAgrmntType: Agreement Type

listProperty: Property List

 - name: Parameter
 - value: Value

listContact: Contact List

 - contactInfo: Contact Informacion
   - businessActivity: Business Activity
     - businessGrade: Grade
   - entprGuid: GUID Agreement
   - contactId: Contact ID
   - govIssueIdent: Identification Given By The Local Government
     - identSerialNum: Number customer Identification
     - govIssueIdentType: Type of customer identification
   - refNumber: Radication ID
   - contactType: Contact Type

Example of Body to Response Successfull

{
    "govIssueIdent": {
        "identSerialNum": "80202750",
        "govIssueIdentType": "CC"
    },
    "listVinculate": [
        {
            "listVinculateItem": [
                {
                    "depAcctStmtRec": {
                        "depAcctId": {
                            "acctId": "00000123"
                        },
                        "disbursement": {
                            "amt": "100000000",
                            "quota": "350000",
                            "rate": "12,25",
                            "status": "Vigente",
                            "statusDate": "28/02/2023",
                            "agreementNumber": "11010905"
                        },
                        "indebtedness": {
                            "term": "30"
                        },
                        "cardAcctId": {
                            "numAsignInstallments": "48"
                        },
                        "expenses": {
                            "suggestedPmtAmt": "400000"
                        },
                        "loanInfoCommon": {
                            "completedPmtCount": "5",
                            "lastPmtDt": "28/01/2023"
                        },
                        "product": {
                            "productType": "01"
                        },
                        "entprAgreement": {
                            "entprDesc": "GRUPO_85_02"
                        }
                    }
                }
            ]
        }
    ],
    "product": {
        "productId": null
    }
}

Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.

{
    "ResponseType": {
        "value": "ER"
    },
    "ResponseDetail": {
        "ErrorCode": "19",
        "ErrorDesc": "NO EXISTEN RESULTADOS DE BÚSQUEDA CON LOS CRITERIOS SELECCIONADOS",
        "ErrorType": "SCO"
    }
}

Diagrama Of Sequence.

- Simulate Mortgage Credit Plan

Path:

POST

/utilities-management/v1/simulate-mortgage:

Headers

X-Invoker-Channel: Channel of origin of consumption

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Body :

indebtedness: Indebtedness

flagStoreAudit: Stores Audit.
flagApplyBenefit: Apply Benefit.

businessActivity: Business Activity

certCode1: Insured Activity Code 1.
certCode2: Insured Activity Code 2.

postAddr: Contains information about the city code

cityId: City Code.
cityIdProperty: Property City Code.

mortagageInfo: Contains the mortgage information in the fields

socialClass: Social Class.
value: Property Value.
flagHousingVis: Vis.

personInfo: Contains information about the person

birthDt1: Date of Birth Insured 1.
birthDt2: Date of Birth Insured 2.
gender1: Gender Insured 1.
gender2: Gender Insured 2.

productInfo: Contains information about the product

numberInsured: Number of Insured.
term: Term.
result: Result.
rate: Rate.
amortizationSystem: Amortization Type.

product: Contains information about the product

productType: Credit Type.
vlrCredit: Credit value.

Example of Body

{
  "indebtedness": {
    "flagStoreAudit": "false",
    "flagApplyBenefit": "false"
  },
  "businessActivity": {
    "certCode1": "0",
    "certCode2": "0"
  },
  "postAddr": {
    "cityId": "114",
    "cityIdProperty": "114"
  },
  "mortagageInfo": {
    "socialClass": "1",
    "value": "100000000",
    "flagHousingVis": "false"
  },
  "personInfo": {
    "birthDt1": "2013-02-22T08:22:54",
    "birthDt2": "2013-02-22T08:22:54",
    "gender1": "F",
    "gender2": "M"
  },
  "productInfo": {
    "numberInsured": "1",
    "term": "120",
    "result": "0",
    "rate": "12",
    "amortizationSystem": "CUOTA_FIJA"
  },
  "product": {
    "productType": "CREDITO_HIPOTECARIO_CUOTA_FIJA_PESOS",
    "vlrCredit": "70000000"
  }
}

Response information:

indebtedness: Indebtedness

flagApplyBenefit: Apply Benefit.
flagApplyUnemployment: Unemployment applies.
discountInterest: Discount interest

insuranceInfo: Insurance Info

factorLifeInsurance: Factor For Life Insurance.
factorBonusUnemploymentInsuranceITT: Unemployment Insurance Premium Factor ITT.
idSimulatePerformed: Id Simulation carried out.
benefitPoint: Benefit points.
grossYield: Gross yield.

mortagageInfo: Contains the mortgage information in the fields

vlrAppraisal: Appraisal value.
vlrQuotaUnemploymentInsuranceFrech: Quota Value With Unemployment Insurance With Frech.
vlrQuotaUnemploymentInsuranceWithoutFrech: Amount Quota With Unemployment Insurance Without Frech.
vlrEstudyCredit: Credit Study Value.
vlrBonusInsuranceUnemploymentITT: Unemployment Insurance Premium Value ITT.
vlrFirstQuotaFrech: Value First Installment With Frech.
vlrFirstQuotaWithoutFrech: Value First Installment Without Frech.
vlrBillWithHolding: Retesource Value.
vlrInsuranceFire: Fire Insurance Value.
vlrInsuranceEarthquake: Earthquake Insurance Value.
vlrInsuranceLife: Life Insurance Value.
vlrTotalFirstQuotaFrech: Total Value First Installment With Frech.
vlrTotalFirstQuotaWithoutFrech: Total Value First Installment Without Frech.
vlrTotalCapitalPayment: Total Value Capital Payment.
vlrTotalInterest: Total Value Interest.
vlrTotalInsurances: Total Value Insurance.
vlrTotalUnified: Unified Total Value.
vlrTotalUnifiedPercentage: Unified Total Value Percentage.

detailLegalizationExpensesLis: Contains list detail legalization expenses

billBenevolentTradingAmt: Expenses Charity Sale.
billBenevolentMortgageAmt: Mortgage Charity Expenses.
billBenevolentTotalAmt: Expenditures Total Charity.
billStudyTitlesAmt: Title Study Expenses.
billNotariesBuySellAmt: Notary Expenses Sale.
billNotariesMortgageAmt: Mortgage Notary Expenses.
billNotariesTotalAmt: Notary Expenses Total.
billRegisterBuySellAmt: Sales Registration Expenses.
billRegisterMortgageAmt: Mortgage Registration Expenses.
billRegisterTotalAmt: Expenses Registration Total.
billWithHoldingAmt: Retefuente Expenses.
billTotalAmt: Expenses Total.

tablePesos: Contains list table pesos

numberQuota: Numbers Quota.
balancePrincipalPesos: Principal Balance Pesos.
balancePaymentPrincipalPesos: Principal Payment Balance Pesos.
vlrQuotaPesos: Quota Value Pesos.
vlrQuotaPesosInsurance: Quota Value Pesos.
vlrQuotaPesosInsuranceWithoutBenefitFrech: Quota Value Pesos Insurance Without Benefit Frech.
vlrQuotaPesosInsuranceBenefitFrech: Quota Value Pesos Benefit Frech.
vlrInterestsPesos: Value Interest Pesos.

Example of Body to Response Successfull

{
  "indebtedness": {
    "flagApplyBenefit": "false",
    "flagApplyUnemployment": "1",
    "discountInterest": "0"
  },
  "insuranceInfo": {
    "factorLifeInsurance": "0",
    "factorBonusUnemploymentInsuranceITT": "00544",
    "idSimulatePerformed": "0",
    "benefitPoint": "0",
    "grossYield": "979630217074251"
  },
  "mortagageInfo": {
    "vlrAppraisal": "11900000",
    "vlrQuotaUnemploymentInsuranceFrech": "899850038088392544",
    "vlrQuotaUnemploymentInsuranceWithoutFrech": "10696152208830902544",
    "vlrEstudyCredit": "96280",
    "vlrBonusInsuranceUnemploymentITT": "551850038088392544",
    "vlrFirstQuotaFrech": "0",
    "vlrFirstQuotaWithoutFrech": "979630217074251",
    "vlrBillWithHolding": "0",
    "vlrInsuranceFire": "12600000",
    "vlrInsuranceEarthquake": "22200000",
    "vlrInsuranceLife": "0",
    "vlrTotalFirstQuotaFrech": "34800000",
    "vlrTotalFirstQuotaWithoutFrech": "1014430217074251",
    "vlrTotalCapitalPayment": "70000000000000006",
    "vlrTotalInterest": "47555626048910126",
    "vlrTotalInsurances": "10798200457060712",
    "vlrTotalUnified": "12835382650597072",
    "vlrTotalUnifiedPercentage": "1446763931001529"
  },
  "detailLegalizationExpensesLis": [
    {
      "billSummAmt": {
        "billBenevolentTradingAmt": "10500000000",
        "billBenevolentMortgageAmt": "0",
        "billBenevolentTotalAmt": "10500000000",
        "billStudyTitlesAmt": "131000",
        "billNotariesBuySellAmt": "251801700000000",
        "billNotariesMortgageAmt": "39182340000000",
        "billNotariesTotalAmt": "643625100000000",
        "billRegisterBuySellAmt": "500000000",
        "billRegisterMortgageAmt": "366840000",
        "billRegisterTotalAmt": "866840000",
        "billWithHoldingAmt": "0",
        "billTotalAmt": "2691465100000000"
      },
      "personInfo": {
        "personType": "COMPRADOR"
      }
    }
  ],
  "tablePesos": [
    {
      "regPmtCurAmt": {
        "numberQuota": "1"
      },
      "mortagageInfo": {
        "balancePrincipalPesos": "69684585",
        "balancePaymentPrincipalPesos": "315415",
        "vlrQuotaPesos": "979630",
        "vlrQuotaPesosInsurance": "1069615",
        "vlrQuotaPesosInsuranceWithoutBenefitFrech": "1069615",
        "vlrQuotaPesosInsuranceBenefitFrech": "979630",
        "vlrInterestsPesos": "664216"
      }
    }
  ]
}

-Simulate Rates Mortgage

Path:

GET

/utilities-management/v1/simulate-rates-mortgage:

Headers

X-Invoker-Channel: Channel of origin of consumption

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Body :

productInfo: Contains the product information described in the fields

productId: contains "legerCode", "subLegerCode" y "groupCode" fields which indicate the product identification code.
amt: Indicates the amount.
term: Indicates the term.
rangeFM: Range FM
profile: profile.
productLine: product line
amortisationSystem: amortization system
score: Score

mortgageInfo: Contains the mortgage information in the fields

govPrg: Government plan
flagHousingVis: Indicates house vis
propertyType: Property type
flagHousing: Flag housing
vlrAppraisal: Valor appraisal
opcBuying: Sale purchase option
indRenewalUrb: Indicates urban renewal
indHousing: Indicates housing
flagExternalAppraisal: Indicates external appraisal
flagFNG: Fng indicator
lineCreditGuarantorEntities: Line credit guarantor entities
fngProductCod: Fng product code
guaranteeType: Guarantee type

entpr: Contains the fields

entprId: Code
estrategyId: Estrategy code

campaign: Contains campaign information

campaignId: Campaign code

offer: Contains the fields

executionLine: Execution line
processStage: Process stage

projectData: Project data

projectType: Project type
builderType: Builder type

indebtedness:Contains the fields

flagSessionPortfolio: indicates active session in the portfolio

bussinesInfo: Contains the fields

segment: Segment
flagOldClient: Indicates former client
flagEmployeeFS: Indicates employee social role

personInfo: Person information

incomeAmt: Salary

Example of Body

{
  "productInfo":{
    "productId":{
      "legerCode": "30",
      "subLegerCode": "01",
      "groupCode": "21"
    },
    "amt": "500000",
    "term": "60",
    "rangeFM": "1",
    "profile": "A",
    "productLine": "1",
    "amortisationSystem": "1",
    "score": "1"

  },
  "mortagageInfo":{
    "govPrg": "1",
    "flagHousingVis": "1",
    "propertyType": "1",
    "flagHousing": "1",
    "vlrAppraisal": "1",
    "opcBuying": "1",
    "indRenewalUrb": "1",
    "indHousing": "1",
    "flagExternalAppraisal": "1",
    "flagFNG": "Y",
    "lineCreditGuarantorEntities": "1",
    "fngProductCod": "11",
    "guaranteeType": "1"
  },
  "entpr":{
    "entprId": "1",
    "estrategyId": "1"
  },
  "campaign": {
    "campaignId": "1"
  },
  "offer": {
    "executionLine": "C",
    "processStage": "1"
  },
  "projectData":{
    "projectType": "1",
    "builderType": "1"
  },
  "indebtedness": {
    "flagSessionPortfolio": "Y"
  },
  "bussinesInfo": {
    "segment": "1",
    "flagOldClient": "Y",
    "flagEmployeeFS": "Y"
  },
  "personInfo": {
    "incomeAmt": "1"
  }
}

Response information:

productInfo: Contains the information of the products in the fields

productId: contains "legerCode", "subLegerCode" y "groupCode" fields which indicate the product identification code.
productLine: Product Line
rate: Rate
bestRate: Best rate
factorDiscountGovernmentPlan:
amortisationSystem: Amortisation System

entpr: Contains the fields

entprId: Convention code
strategyId: Strategy code

Example of Body to Response Successfull

{
    "productInfo": [
        {
            "productId": {
                "legerCode": "30",
                "subLegerCode": "01",
                "groupCode": "21"
            },
            "productLine": "1",
            "rate": "22.9",
            "bestRate": "22.9",
            "factorDiscountGovernmentPlan": "",
            "amortisationSystem": "1"
        }
    ],
    "entpr": [
        {
            "entprId": "1",
            "strategyId": "1"
        }
    ]
}

Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.

{
    "ResponseType": {
        "value": "ER"
    },
    "ResponseDetail": {
        "ErrorCode": "000",
        "ErrorDesc": "Error en consultar tasas",
        "ErrorType": "BDA"
    }
}

-Payroll Rates

Path:

POST

/utilities-management/v1/payroll-rates:

Headers

X-Invoker-Channel: Channel of origin of consumption

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered.

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

X-Security-Token: Used to send a valid OAuth 2 access token

Body :

productInfo: Contains the product information described in the fields

productId: contains "legerCode", "subLegerCode" y "groupCode" fields which indicate the product identification code.
amt: Indicates the amount.
term: Indicates the term.
rangeFM: Range FM
profile: profile.
productLine: product line
amortisationSystem: amortization system
score: Score

mortgageInfo: Contains the mortgage information in the fields

govPrg: Government plan
flagHousingVis: Indicates house vis
propertyType: Property type
flagHousing: Flag housing
vlrAppraisal: Valor appraisal
opcBuying: Sale purchase option
indRenewalUrb: Indicates urban renewal
indHousing: Indicates housing
flagExternalAppraisal: Indicates external appraisal
flagFNG: Fng indicator
lineCreditGuarantorEntities: Line credit guarantor entities
fngProductCod: Fng product code
guaranteeType: Guarantee type

entpr: Contains the fields

entprId: Code
estrategyId: Estrategy code

campaign: Contains campaign information

campaignId: Campaign code

offer: Contains the fields

executionLine: Execution line
processStage: Process stage

projectData: Project data

projectType: Project type
builderType: Builder type

indebtedness:Contains the fields

flagSessionPortfolio: indicates active session in the portfolio

bussinesInfo: Contains the fields

segment: Segment
flagOldClient: Indicates former client
flagEmployeeFS: Indicates employee social role

personInfo: Person information

incomeAmt: Salary

Example of Body

{
  "productInfo":{
    "productId":{
      "legerCode": "00",
      "subLegerCode": "00",
      "groupCode": "00"
    },
    "amt": "1",
    "term": "1",
    "rangeFM": "1",
    "profile": "1",
    "productLine": "1",
    "amortisationSystem": "1",
    "score": "1"

  },
  "mortagageInfo":{
    "govPrg": "1",
    "flagHousingVis": "1",
    "propertyType": "1",
    "flagHousing": "1",
    "vlrAppraisal": "1",
    "opcBuying": "1",
    "indRenewalUrb": "1",
    "indHousing": "1",
    "flagExternalAppraisal": "1",
    "flagFNG": "Y",
    "lineCreditGuarantorEntities": "1",
    "fngProductCod": "11",
    "guaranteeType": "1"
  },
  "entpr":{
    "entprId": "1",
    "estrategyId": "1"
  },
  "campaign": {
    "campaignId": "1"
  },
  "offer": {
    "executionLine": "1",
    "processStage": "1"
  },
  "projectData":{
    "projectType": "1",
    "builderType": "1"
  },
  "indebtedness": {
    "flagSessionPortfolio": "Y"
  },
  "bussinesInfo": {
    "segment": "1",
    "flagOldClient": "Y",
    "flagEmployeeFS": "Y"
  },
  "personInfo": {
    "incomeAmt": "1"
  }
}

Response information:

productInfo: Contains the information of the products in the fields

productId: contains "legerCode", "subLegerCode" y "groupCode" fields which indicate the product identification code.
productLine: Product Line
rate: Rate
bestRate: Best rate
factorDiscountGovernmentPlan:
amortisationSystem: Amortisation System

entpr: Contains the fields

entprId: Convention code
strategyId: Strategy code

Example of Body to Response Successfull

{
  "productInfo":{
    "productId":{
      "legerCode": "00",
      "subLegerCode": "00",
      "groupCode": "00"
    },
    "productLine": "1",
    "rate": "1",
    "bestRate": "1",
    "factorDiscountGovemmentPlan": "1",
    "amortisationSystem": "1"
    },
    "entpr": {
      "entprId": "1",
      "strategyId": "1"
    }
}

Errors Code.

Additional the error code of APIKit this resource it has some custom errors code or bussines errors and all errors used the following structure.

{
    "ResponseType": {
        "value": "ER"
    },
    "ResponseDetail": {
        "ErrorCode": "000",
        "ErrorDesc": "Error en consultar tasas",
        "ErrorType": "BDA"
    }
}

Diagrama Of Sequence.

##################################

- Config Aggrement**

GET

Path: /utilities-management/v1/agreement/config

/utilities-management/v1/agreement/config

Headers

X-Invoker-Channel: Channel of origin of consumption (required true)

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered. (required true)

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

authentication: Used to send a valid OAuth 2 access token

Query Parameters:

scvIdent: Aggrement
Code eanCode: Barcode

Response information:

responseType: Response type

value: Error object only with value.

entprAgreement:

flagRefManual: Indicates that the collection is in the form of Manual reading
name: Agreement Name
nextPmtDt: NextPmtDt
flagAllowModValue: Indicates whether the value can be modified
pmtCodServ: Aggrement number
pmtType: It is a field that contains the payment methods enabled
identReadMethod[]:
    identReadMethod:
         eanCode: EAN code
         pmtRefId: Reference 1
         pmtRefId2: Reference 2
         dueDt: Due date
         curAmt: CurAmt
           amt: Value
refInfo[]:
    amt: Number of references that the agreement has configured
    pmtRefId: Reference name 1
    pmtRefId2: Reference name 2
    pmtRefId3: Reference name 3
pmtReferences[]:
    required: Information if you request another reference for electronic payment
    pmtRefId: Name of the other reference requested
acctHelpMsg[]:
    pmtRefId: Reference 1 Help Message
    pmtRefId2: Reference 2 Help Message
    pmtRefId3: Reference 3 Help Message
    pmtRefId4: Reference 4 Help Message

Example of Body to Response Successfull

{
    "responseType": {
        "value": "OK"
    },
    "entprAgreement": {
        "identReadMethod": {
            "eanCode": "",
            "pmtRefId": "",
            "pmtRefId2": "",
            "curAmt": {
                "amt": 0.00
            },
            "dueDt": ""
        },
        "entprAgrmntType": "05",
        "flagRefManual": true,
        "name": "AGUAS DE BARRANCABERMEJA SA",
        "nextPmtDt": false,
        "flagAllowModValue": false,
        "pmtCodServ": "15583555",
        "pmtType": "   160",
        "refInfo": {
            "amt": 1,
            "pmtRefId": "Numero de La Factura",
            "pmtRefId2": "",
            "pmtRefId3": ""
        },
        "pmtReferences": {
            "required": false,
            "pmtRefId": "   160"
        },
        "acctHelpMsg": {
            "pmtRefId": "Ingrese Numero de La Factura",
            "pmtRefId2": "",
            "pmtRefId3": "",
            "pmtRefId4": ""
        }
    }
}

Errors Code.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00502",
      "errorDesc": "CUENTA NO EXISTE.",
       "errorType": "DBA"
   }
}

Diagrama Of Sequence.

###

###

- Aggrement Category**

GET

Path: /utilities-management/v1/agreement/category

/utilities-management/v1/agreement/category

Headers

X-Invoker-Channel: Channel of origin of consumption (required true)

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered. (required true)

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

authentication: Used to send a valid OAuth 2 access token

Response information:

responseType: Response type

value: Error object only with value.

entprAgreement[]: Aggrements Catagory

categCode: Category code
desc: Description

Example of Body to Response Successfull

{
    "responseType": {
        "value": "OK"
    },
    "entprAgreement": [
        {
            "categCode": "01",
            "desc": "SERVICIOS PUBLICOS"
        },
        {
            "categCode": "02",
            "desc": "CELULARES, INTERNET Y TELEVISION"
        }
    ]
}

Errors Code.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00502",
      "errorDesc": "CUENTA NO EXISTE.",
       "errorType": "DBA"
   }
}

Diagrama Of Sequence.

###

- Aggrement by criteria**

GET

Path: /utilities-management/v1/agreement/category

/utilities-management/v1/agreement/category

Headers

X-Invoker-Channel: Channel of origin of consumption (required true)

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered. (required true)

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

authentication: Used to send a valid OAuth 2 access token

Response information:

responseType: Response type

value: Error object only with value.

resultsPagesGeneric: ResultsPagesPagination

totalRecords: Total Number of Records
recordsXPage: Number of Records Returned

entprAgreement[]: List of aggrements

scvIdent: Agreement code
name: Agreement Name
categCode: Category code
desc: Category description
cityId: City code
city: City name
neighborhood: Neighborhood
address: Address
pseTrnCode: ACH service code
certCode: CIIU Code of the Client's Economic Activity
identReadMethod:
    eanCode: EAN code
govIssueIdent:
    identSerialNum: IdentSerialNum
    govIssueIdentType: Identification number.

Example of Body to Response Successfull

{
    "responseType": {
        "value": "OK"
    },
    "resultsPagesGeneric": {
        "totalRecords": "145",
        "recordsXPage": "10"
    },
    "entprAgreement": [
        {
            "scvIdent": "15000304",
            "name": "TELECOM",
            "categCode": "01",
            "desc": "SERVICIOS PUBLICOS",
            "cityId": "11001",
            "city": "BOGOTA",
            "neighborhood": "CAMINO",
            "address": "KR 21 NO 32 98 OF 30",
            "pseTrnCode": "00030",
            "certCode": "8011",
            "identReadMethod": {
                "eanCode": ""
            },
            "govIssueIdent": {
                "identSerialNum": "NI",
                "govIssueIdentType": "8600135703"
            }
        },
        {
            "scvIdent": "15061845",
            "name": "CONJ RES BOSQUES DE MARIA",
            "categCode": "01",
            "desc": "SERVICIOS PUBLICOS",
            "cityId": "08001",
            "city": "BARRANQUILLA",
            "neighborhood": "SANTA TERESITA",
            "address": "CL 45 16 96",
            "pseTrnCode": "00030",
            "certCode": "9199",
            "identReadMethod": {
                "eanCode": ""
            },
            "govIssueIdent": {
                "identSerialNum": "NI",
                "govIssueIdentType": "8301160981"
            }
        }
    ]
}

Errors Code.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00502",
      "errorDesc": "CUENTA NO EXISTE.",
       "errorType": "DBA"
   }
}

Diagrama Of Sequence.

###

- Consult PQR**

GET

Path: /utilities-management/v1/pqr

/utilities-management/v1/pqr

QueryParams

clientapp: External System code

startDt: Start date (required: true)

endDt: End date (required: true)

Headers

X-Invoker-Channel: Channel of origin of consumption (required true)

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered. (required true)

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

authentication: Used to send a valid OAuth 2 access token

Response information:

responseType: Response type

value: Error object only with value.

transaction[]: Contains list of PQRs

refType: Classification

cspRefId: External Entity Complaint Code

trnRqUID: Request Number

type: type

requestType: Request Type

cancelJust: Reason Cancellation

createdDt: Date Received Entity

favorability: Customer Favorability

flagExpComplaint: Express Complaint

flagLgbtiq: BCS SF LGBTIQ Flag

descReplica: Replica argument

flagTutelage: guardianship

channel: Medium Answer

relationshipType: Link Type

flagReplica: replica

clientApp: External SystemFS

daysCycle: Days Solution Case

closedDt: Solution Date

dueDt: Expiration date

desc: description

establishDt: Filing Date

relationshipId: Linked Case

flagRecommend: Recommend Case

requestNumber: Generic request

additionalStatus:

statusCode:** substate

status:

**statusCode:** Status

**rowStatus:** Row Status

segmentation:

**value:** Radical Area

**valueTwo:** SubType

depAcctId:

**acctId:** Account

**digitalProduct:** Digital products

justification:

**memo:** Justification Cancellation

**closeJust:** Justification Closing

**extensionJust:** Justification Extension

**solutionJust:** Justification Solution

**devolutionJust:** Justification Return

trnSrcInfo:

**trnSrc:** Reception Point

**channel:** Reception channel

adviser:

**personInfo:** PersonInfo

  **city:**  City User

**user:** User

personInfo:

**personType:** Type Person

**gender:** Gender

notification:

**channel:** Medium Answer

orgInfo:

**orgIdNum:** Control Entity

contactInfo:

**phone:** Phone

**emailAddr:** EmailAddr

**postAddr:**

  **country:** Country

  **stateProv:** StateProv

  **addrOne:** addrOne

conditionInfo:

**condition:** Marking

typology:

**code:** codeTypologySIF

**type:** SIF typology

postAddr:

**stateProv:** User Department

administrationOffice:

**branchName:** Branch Name

productId:

**groupCode:** Group

**ledgerCode:** ledger

**subledgerCode:** subledger

**productIdent:** Main Product Id

businessPerson:

**govIssueIdent:**

  **identSerialNum:** Legal entity identification number

  **govIssueIdentType:** Type of legal entity identification

govIssueIdent:

**identSerialNum:** Natural person identification number

**govIssueIdentType:** User Identification Type

personName:

**firstName:** First name

**middleName:** middleName

**lastName:** lastName

**secondLastName:** secondLastName

selRangeDt:

**startDt:** Date Problem

listActivities

  **idItem** Activity Id

  **desc** Description

  **categCode**Cateory

  **nickname** Displaynname

  **user** Designated User

  **status** Old State Row

  **type** Type

listAccounts

  **idItem** Record Id

  **nickname** Name Alias

  **acctId** Product ID

  **name** Name

  **type** Type

listMovements

  **moreInformation** Additional Information

  **flagDelete** Allow Delete

  **desc** description

  **chkNum** document

  **identConditions** Brand Fraud

  fraudType**Fraud Type**

flagSelected Select Tx Flag

sequence Sequence Id

originResources origin

numAsignInstallments Term

amt Amt

establishDt Date

trnType Transaction Type

idItem Record Id

type Type

delinqAging DelinqAging

amt principal in arrears

entpr

entprId establishment

administrationOffice

branchId branchId

branchName branchName

intRateInfo

rate Rate

curRate Interest rate

indebtedness

termOriginal Term

amt Outstanding balance

numberOfPmtInstallments Outstanding Fees

extAcctBal

amt** Remaining Capital

logBooks

  **idItem** Registration Identification

  **flagAutom** automatic

  **desc** description

  **type** Type

  **requestNumber** Identification request

listOrders

  **idItem** requested number

  **curCode** "Currency Code 2"

  **type** Order Type

  **requestVersion** Version Order

  **status** Status

  **listAccounts**

        **groupCode** Group

        **ledgerCode** Ledger

        **subledgerCode** SubLedger

        **productClass** Product Class

        **acctCur** "Code Currency2"

        **resolvePendingDt** "exchange date"

        **itemOne** Order Item 1

        **itemTwo** Order Item 2

        **order** Order Id

        **acctId** Product Id

        **acctType** Product Type

        **amt** Requested amount

listAccountsTwo

  **desc** Product Description

  **productIdent** Product ID

  **name** Name other product

  **acctId** Product Number

  **acctType** Product Type

  **nickname** name 2

  **type** Type

  **entpr**

      **csPrefId** supplier

      **zone** Location Provider

Example of Body to Response Successfull

{
  "responseType": {
    "value": "OK"
  },
  "transaction": [
    {
      "refType": "Requirement",
      "cspRefId": "",
      "trnRqUID": "1-528877703",
      "type": "P1-INF CREDITO LIBRE DESTINO",
      "requestType": "BENEFICIOS Y CARACTERISTICAS OPORTUNIDAD DE VENTA",
      "cancelJust": "",
      "createdDt": "",
      "favorability": "",
      "flagExpComplaint": false,
      "flagLgbtiq": false,
      "descReplica": "",
      "flagTutelage": false,
      "channel": "",
      "relationshipType": "",
      "flagReplica": false,
      "clientApp": "",
      "daysCycle": "1",
      "closedDt": "",
      "dueDt": "04/14/2023 18:00:00",
      "desc": "",
      "establishDt": "04/04/2023 11:16:12",
      "relationshipId": "",
      "flagRecommend": true,
      "requestNumber": "N",
      "additionalStatus": {
        "statusCode": "01"
      },
      "status": {
        "statusCode": "02",
        "rowStatus": "N"
      },
      "segmentation": {
        "value": "6",
        "valueTwo": "P1_0006_0001"
      },
      "depAcctId": {
        "acctId": "",
        "digitalProduct": "N"
      },
      "justification": {
        "memo": "",
        "closeJust": "",
        "extensionJust": "",
        "solutionJust": "",
        "devolutionJust": ""
      },
      "trnSrcInfo": {
        "trnSrc": "",
        "channel": "1"
      },
      "adviser": {
        "personInfo": {
          "city": ""
        },
        "user": "SADMIN"
      },
      "personInfo": {
        "personType": "N",
        "gender": ""
      },
      "notification": {
        "channel": ""
      },
      "orgInfo": {
        "orgIdNum": ""
      },
      "contactInfo": {
        "phone": "3331112220",
        "emailAddr": "n0p6f9o1@bancocajasocial.com",
        "postAddr": {
          "country": "",
          "stateProv": "",
          "addrOne": ""
        }
      },
      "conditionInfo": {
        "condition": ""
      },
      "typology": {
        "code": "",
        "type": ""
      },
      "postAddr": {
        "stateProv": ""
      },
      "administrationOffice": {
        "branchName": "0002"
      },
      "productId": {
        "groupCode": "",
        "ledgerCode": "",
        "subledgerCode": "",
        "productIdent": ""
      },
      "businessPerson": {
        "govIssueIdent": {
          "identSerialNum": "",
          "govIssueIdentType": ""
        }
      },
      "govIssueIdent": {
        "identSerialNum": "8662518",
        "govIssueIdentType": "CC"
      },
      "personName": {
        "firstName": "RAMON",
        "middleName": "",
        "lastName": "CHAVEZ",
        "secondLastName": ""
      },
      "selRangeDt": {
        "startDt": ""
      },
      "listActivities": [

      ],
      "listAccounts": [

      ],
      "listMovements": [

      ],
      "logBooks": [
        {
          "idItem": "",
          "flagAutom": true,
          "desc": "El usuario GIC_LCHAVEZ ha procedido a solucionar la PQR número 1-528877703",
          "type": "15",
          "requestNumber": "1-8QVONB"
        }
      ],
      "listOrders": [

      ],
      "listAccountsTwo": [

      ]
    },
    {
      "refType": "Complaint",
      "cspRefId": "",
      "trnRqUID": "1-529768445",
      "type": "R2_0001",
      "requestType": "DEBITÓ Y NO PAGÓ O ENTREGA PARCIAL DE EFECTIVO – SERVIBANCA",
      "cancelJust": "",
      "createdDt": "",
      "favorability": "",
      "flagExpComplaint": false,
      "flagLgbtiq": false,
      "descReplica": "",
      "flagTutelage": false,
      "channel": "7",
      "relationshipType": "03",
      "flagReplica": false,
      "clientApp": "",
      "daysCycle": "5",
      "closedDt": "",
      "dueDt": "04/18/2023 18:00:00",
      "desc": "CLIENTE INFORMA QUE REALIZÓ TRANSACCIÓN EN UN CAJERO AUTOMÁTICO DE SERVIBANCA  Y NO FUE DISPENSADO SU EFECTIVO DE FORMA TOTAL O PARCIAL POR LO QUE SOLICITA  REINTEGRO DEL DINERO.",
      "establishDt": "04/14/2023 12:37:45",
      "relationshipId": "1-528136889",
      "flagRecommend": true,
      "requestNumber": "N",
      "additionalStatus": {
        "statusCode": ""
      },
      "status": {
        "statusCode": "10",
        "rowStatus": "N"
      },
      "segmentation": {
        "value": "6",
        "valueTwo": "R2_0001_0001"
      },
      "depAcctId": {
        "acctId": "",
        "digitalProduct": "N"
      },
      "justification": {
        "memo": "",
        "closeJust": "",
        "extensionJust": "",
        "solutionJust": "",
        "devolutionJust": ""
      },
      "trnSrcInfo": {
        "trnSrc": "102",
        "channel": "1"
      },
      "adviser": {
        "personInfo": {
          "city": ""
        },
        "user": "SADMIN"
      },
      "personInfo": {
        "personType": "N",
        "gender": "F"
      },
      "notification": {
        "channel": "2"
      },
      "orgInfo": {
        "orgIdNum": "2"
      },
      "contactInfo": {
        "phone": "3500000005",
        "emailAddr": "prueba24@fs.net",
        "postAddr": {
          "country": "036",
          "stateProv": "",
          "addrOne": ""
        }
      },
      "conditionInfo": {
        "condition": ""
      },
      "typology": {
        "code": "219",
        "type": "COBRO POR OPERACIONES FALLIDAS EN CAJEROS ELECTRONICOS"
      },
      "postAddr": {
        "stateProv": ""
      },
      "administrationOffice": {
        "branchName": "9998"
      },
      "productId": {
        "groupCode": "00",
        "ledgerCode": "24",
        "subledgerCode": "11",
        "productIdent": "241100"
      },
      "businessPerson": {
        "govIssueIdent": {
          "identSerialNum": "",
          "govIssueIdentType": ""
        }
      },
      "govIssueIdent": {
        "identSerialNum": "35195450",
        "govIssueIdentType": "CC"
      },
      "personName": {
        "firstName": "PORFIRIO",
        "middleName": "HEBERTO",
        "lastName": "BANDERA",
        "secondLastName": "ARNEDO"
      },
      "selRangeDt": {
        "startDt": "04/01/2023"
      },
      "listActivities": [

      ],
      "listAccounts": [

      ],
      "listMovements": [

      ],
      "logBooks": [
        {
          "idItem": "",
          "flagAutom": true,
          "desc": "User GIC_ANLT_ATN escalated SR 1-529768445",
          "type": "11",
          "requestNumber": "1-8RERY5"
        },
        {
          "idItem": "",
          "flagAutom": true,
          "desc": "El usuario VASC1V7E ha procedido a radicar la PQR número 1-529768445",
          "type": "10",
          "requestNumber": "1-8RERY5"
        }
      ],
      "listOrders": [

      ],
      "listAccountsTwo": [

      ]
    }
  ]
}

Errors Code.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "00502",
      "errorDesc": "CUENTA NO EXISTE.",
       "errorType": "DBA"
   }
}

- Catalogue **

GET

Path: /utilities-management/v1/catalogue/{categcode}

Path: /utilities-management/v1/catalogue/{categcode}

Headers

X-Invoker-Channel: Channel of origin of consumption (required true)

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered. (required true)

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

authentication: Used to send a valid OAuth 2 access token

URI Parameters:

categcode: Catalogue code (CCMC=Cancel Reasons, CCOR=Origin of the resources, COUNTRIES=Countries)

Response information - code CCMC (Cancel reasons)

reason: Array of cancel reasons
  code: Item code
  desc: Item description

Example of Successful Body Response - code CCMC (Cancel reasons)

{
  "reason": [
    {
      "code": "1",
      "desc": "Compra de vehículo"
    },
    {
      "code": "2",
      "desc": "Vacaciones"
    },
    {
      "code": "3",
      "desc": "Necesidad de los recursos"
    },
    {
      "code": "4",
      "desc": "Compra de vivienda"
    },
    {
      "code": "5",
      "desc": "Rentabilidad"
    }
  ]
}

Response information - code CCOR (Origin of the resources)

originResources: Array of origins
  code: Item code
  desc: Item description

Example of Successful Body Response - code CCOR (Origin of the resources)

{
    "originResources": [
        {
            "code": "1",
            "desc": "Compra de vehículo"
        },
        {
            "code": "2",
            "desc": "Vacaciones"
        },
        {
            "code": "3",
            "desc": "Necesidad de los recursos"
        },
        {
            "code": "4",
            "desc": "Compra de vivienda"
        },
        {
            "code": "5",
            "desc": "Rentabilidad"
        }
    ]
}

Response information - Error:

responseType: Response type

value: Error object only with value.

Example of Error Response.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "",
      "errorDesc": "",
       "errorType": ""
   }
}

Diagrama Of Sequence.

###

###

COUNTRIES:

GET

Path: /utilities-management/v1/catalogue/{categcode}

Path: /utilities-management/v1/catalogue/{categcode}

Headers

X-Invoker-Channel: Channel of origin of consumption (required true)

X-Invoker-AMTId: Amt code

X-Invoker-BranchId: Office code

X-Invoker-TerminalId: Term code

X-Invoker-Component: Component

X-Invoker-UserIPAddress: Client IP Address

X-Invoker-ServerIPAddress: Server IP Address

X-Invoker-UserMACAddress: Client MAC Address

X-Invoker-ServerMACAddress: Server MAC Address

X-Invoker-ProcessDate: Process date

X-Invoker-TxId: Id TX

X-Invoker-SessionKey: Session key

X-Invoker-Source: Origin

X-Invoker-Country: Country

X-Invoker-ProcessBpmId: ID BPM process

X-Invoker-ProcessId: Process ID

X-Invoker-Network: Net

X-Invoker-subChannel: Subchannel with which the transaction must be registered. (required true)

X-Invoker-User: User

X-Invoker-Action: Action

X-Invoker-Destination: Destination

X-Invoker-ModifierUser: Modification user

X-Invoker-ReferencedNumber: Reference number

X-Invoker-RequestNumber: Request number

X-Invoker-CustId: Client code

Headers Security

X-Security-CustLoginId: Used to identify the user who logs in

X-Security-ClientID: The Mule expression to use for obtaining the client ID from

X-Security-ClientSecret: The Mule expression to use for obtaining the client secret from API requests

authentication: Used to send a valid OAuth 2 access token

URI Parameters:

categcode: Catalogue code COUNTRIES=Countries

Response information - code COUNTRIES(Countries)

msgResponse:
    catalogueInfo:
        codeCatalogue:
        code:
        categCode:
        name:
        desc2:
        desc:
        status:
            statusDesc:
    invoker:
        user:
        modifierUser:
    createdDt:
    updateStatus:
    trnCode:
    unit:
    unitStatus:

Example of Successful Body Response - code COUNTRIES(Countries)

{
    "msgResponse": [
        {
            "catalogueInfo": {
                "codeCatalogue": "",
                "code": "PAISESDIAN",
                "categCode": "BD",
                "name": "BANGLADESH",
                "desc2": "",
                "desc": "",
                "status": {
                    "statusDesc": "A"
                }
            },
            "invoker": {
                "user": "SMCENTRAL",
                "modifierUser": ""
            },
            "createdDt": "2023-08-16T11:47:21.276162-05:00",
            "updateStatus": "2023-08-16T11:47:21.276162-05:00",
            "trnCode": "81",
            "unit": "",
            "unitStatus": ""
        }
    ]

}

Response information - Error:

responseType: Response type

value: Error object only with value.

Example of Error Response.

{
  "responseType": {
      "value": "ER"
   },
   "responseDetail": {
      "errorCode": "",
      "errorDesc": "",
       "errorType": ""
   }
}

Diagrama Of Sequence.

###

###

- Remittances - Consult catalog.

Description:

Operation developed with the objective of making queries to the Shares and Securities database in order to obtain updated information regarding parameters whose value may change over time, understanding that for the process of sending or paying remittances, manage updated information.

Path:

GET

/v1/remittances/catalogue/{catalogueName}?key={key}&value={value}:

URIParams:

QueryParams:

Headers

Mapping Data:

- Response:

Examples:

Example of Body Response:

• Ciudades:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Ciudades"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "cityId": "05001",
                "stateProv": "05",
                "city": "MEDELLIN",
                "flagforeign": false,
                "status": "A"
            }
        }
     ]
}

• Departamentos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Departamentos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "stateProv": "05",
                "country": "CO",
                "name": "ANTIOQUIA",
                "status": "A"
            }
        }
    ]
}

• Motivos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Motivos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "reason": "AHOINV",
                "name": "Ahorro/Inversión",
                "additionalData": {
                    "name": "Saving/Investments"
                },
                "status": "A"
            }
        }
    ]
}

• Nivel Empleo:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "NivelEmpleo"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "rank": "NIV1",
                "name": "Nivel inicial",
                "additionalData": {
                    "name": "Entry Level"
                },
                "status": "A"
            }
        }
    ]
}

• Ocupaciones:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Ocupaciones"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "jobTitle": "AGEINM",
                "required": true,
                "name": "Agente inmobiliario/de seguros/de ventas",
                "additionalData": {
                    "name": "Sales/Insurance/Real Estate ",
                    "required": true
                },
                "certCode": "9609",
                "status": "A"
            }
        }
    ]
}

• Paises:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Paises"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "country": "AD",
                "name": "Andorra",
                "additionalData": {
                    "name": "Andorra"
                },
                "countryId": "376",
                "status": "A"
            }
        }
    ]
}

• PaisMonedasDAS:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "PaisMonedaDAS"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "country": "AB",
                "curCode": "USD",
                "additionalData": {
                    "name": "US Dollar"
                },
                "flagAcceptTransferOrPayment": false,
                "flagApprovalMin": true,
                "flagApprovalDay": false,
                "active": true,
                "status": "A"
            }
        }
    ]
}

• Parentescos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Parentescos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "relationshipType": "AMG",
                "name": "Amigos",
                "additionalData": {
                    "name": "Friend"
                },
                "status": "A"
            }
        }
    ]
}

• Rangos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Rangos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "rank": "VLRACT1",
                "type": "VLRACT",
                "rankAmt": "$ 0 - $ 7,000,000.00",
                "additionalData": {
                    "rankAmt": "$ 0 - $ 7,000,000.00"
                },
                "minCurAmt": {
                    "amt": 0.00
                },
                "maxCurAmt": {
                    "amt": 7000000.00
                },
                "status": "A"
            }
        }
    ]
}

• Recursos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "Recursos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "originResources": "AHORR",
                "name": "Ahorro",
                "additionalData": {
                    "name": "Savings"
                },
                "status": "A"
            }
        }
     ]
}

• Tipo de Documentos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "TipoDocumentos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "govIssueIdentType": "C.C.",
                "GovIssueIdentName": "Cédula de Ciudadanía",
                "type": "2",
                "additionalData": {
                    "type": "B"
                },
                "flagApprovalSend": true,
                "flagApprovalReceive": true,
                "flagDueDT": false,
                "govIssueIdent": {
                    "govIssueIdentType": "CC"
                },
                "status": "A"
            }
        }
   ]
}

• FormasPagos:

{
    "responseType": {
        "value": "OK"
    },
    "catalogue": {
        "nameCatalogue": "FormasPagos"
    },
    "msgResponse": [
        {
            "catalogueInfo": {
                "pmtType": "C",
                "desc": "CHEQUE",
                "flagGmf": true,
                "status": "A"
            }
        }
    ]
}

Error Code Response:

Diagrama.