Jump to

• Request
• Response

Query charge amount for external posting

post

/service/queryExternalCharge

This endpoint is used to query the charge amount for External Posting.

Request

Supported Media Types

• application/json

Header Parameters

• sourceCode: string
  Source from which request is initiated

Body ()

request body contains application code and customer/list of customer for which external posting entry details to be shared

Root Schema : QueryInputListDTO

Type: object

Show Source

• applicationCode(optional): string
  application code
• QueryInputDto: array QueryInputDto

{
    "type":"object",
    "allOf":[
        {
            "type":"object"
        }
    ],
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"application code"
        },
        "QueryInputDto":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/QueryInputDto"
            }
        }
    },
    "required":[
        "realCustomerNo",
        "QueryInputDto"
    ]
}

Match All

Show Source

• object QueryInputListDTO-allOf[0]

{
    "type":"object",
    "allOf":[
        {
            "type":"object"
        }
    ],
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"application code"
        },
        "QueryInputDto":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/QueryInputDto"
            }
        }
    },
    "required":[
        "realCustomerNo",
        "QueryInputDto"
    ]
}

Nested Schema : QueryInputDto

Type: array

Show Source

• Array of: object QueryInputDto

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

Nested Schema : QueryInputListDTO-allOf[0]

Type: object

Nested Schema : QueryInputDto

Type: object

Show Source

• realCustomerNo: string
  real customer no

{
    "type":"object",
    "properties":{
        "realCustomerNo":{
            "type":"string",
            "description":"real customer no"
        }
    },
    "required":[
        "realCustomerNo"
    ]
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Returns the charge maintenance actions based on given id.

Body ()

Root Schema : ExternalChgPostingCollection

Type: object

Collection of Charge Details.

Show Source

• data(optional): array data
• messages(optional): object ChgPostingResponseDto
• paging(optional): object PagingDto

{
    "description":"Collection of Charge Details.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ExternalChgPostingEntriesDTO"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        },
        "messages":{
            "$ref":"#/definitions/ChgPostingResponseDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object ExternalChgPostingEntriesDTO
  External charge posting details

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

Nested Schema : ChgPostingResponseDto

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "codes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/ChgPostingResponseCode"
            }
        }
    }
}

Nested Schema : PagingDto

Type: object

Show Source

• totalResults(optional): integer

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer"
        }
    }
}

Nested Schema : ExternalChgPostingEntriesDTO

Type: object

External charge posting details

Match All

Show Source

• object ExternalChgPostingEntriesDTO-allOf[0]

{
    "description":"External charge posting details",
    "type":"object",
    "allOf":[
        {
            "type":"object",
            "properties":{
                "applicationCode":{
                    "type":"string",
                    "description":"application code"
                },
                "realCustomerNo":{
                    "type":"string",
                    "description":"real customer number"
                },
                "chgRefno":{
                    "type":"string",
                    "description":"charge reference number"
                },
                "txnBranch":{
                    "type":"string",
                    "description":"Transaction Branch"
                },
                "accountingEntry":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/AccountingEntryDto"
                    }
                }
            }
        }
    ]
}

Nested Schema : ExternalChgPostingEntriesDTO-allOf[0]

Type: object

Show Source

• accountingEntry(optional): array accountingEntry
• applicationCode(optional): string
  application code
• chgRefno(optional): string
  charge reference number
• realCustomerNo(optional): string
  real customer number
• txnBranch(optional): string
  Transaction Branch

{
    "type":"object",
    "properties":{
        "applicationCode":{
            "type":"string",
            "description":"application code"
        },
        "realCustomerNo":{
            "type":"string",
            "description":"real customer number"
        },
        "chgRefno":{
            "type":"string",
            "description":"charge reference number"
        },
        "txnBranch":{
            "type":"string",
            "description":"Transaction Branch"
        },
        "accountingEntry":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountingEntryDto"
            }
        }
    }
}

Nested Schema : accountingEntry

Type: array

Show Source

• Array of: object AccountingEntryDto
  Accounting Entry details

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

Nested Schema : AccountingEntryDto

Type: object

Accounting Entry details

Show Source

• accountBranch(optional): string
  Account Branch
• accountccy(optional): string
  Account currency
• accountNumber(optional): string
  Account number
• addlInfo(optional): string
  Additional Information
• amntInAccCcy(optional): number
  Amount in account currency
• amntInChgCcy(optional): number
  amount in charge currency
• chargeCcy(optional): string
  charge currency
• chargeCode(optional): string
  charge code
• chargeCodeDesc(optional): string
  charge code description
• debitCreditInd(optional): string
  debit credit indicator
• eventserialNo(optional): string
  event serial number
• txnCode(optional): string
  Transaction Code
• valueDate(optional): string
  Value Date

{
    "description":"Accounting Entry details",
    "type":"object",
    "properties":{
        "eventserialNo":{
            "type":"string",
            "description":"event serial number"
        },
        "chargeCode":{
            "type":"string",
            "description":"charge code"
        },
        "chargeCodeDesc":{
            "type":"string",
            "description":"charge code description"
        },
        "debitCreditInd":{
            "type":"string",
            "description":"debit credit indicator"
        },
        "accountNumber":{
            "type":"string",
            "description":"Account number"
        },
        "accountBranch":{
            "type":"string",
            "description":"Account Branch"
        },
        "accountccy":{
            "type":"string",
            "description":"Account currency"
        },
        "amntInAccCcy":{
            "type":"number",
            "description":"Amount in account currency"
        },
        "chargeCcy":{
            "type":"string",
            "description":"charge currency"
        },
        "amntInChgCcy":{
            "type":"number",
            "description":"amount in charge currency"
        },
        "valueDate":{
            "type":"string",
            "description":"Value Date"
        },
        "txnCode":{
            "type":"string",
            "description":"Transaction Code"
        },
        "addlInfo":{
            "type":"string",
            "description":"Additional Information"
        }
    }
}

Nested Schema : codes

Type: array

Show Source

• Array of: object ChgPostingResponseCode

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

Nested Schema : ChgPostingResponseCode

Type: object

Show Source

• Code(optional): string
• Desc(optional): string
• Language(optional): string
• Type(optional): string

{
    "type":"object",
    "properties":{
        "Code":{
            "type":"string"
        },
        "Desc":{
            "type":"string"
        },
        "Type":{
            "type":"string"
        },
        "Language":{
            "type":"string"
        }
    }
}

400 Response

Malformed syntax.

401 Response

Request does not have sufficient credentials.

403 Response

Request is not authorized.

500 Response

Internal error

Back to Top