Jump to

• Request
• Response

Add a new accounting entry code

post

/service/v1/accountingpost

This endpoint is used to add a new accounting entry code.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

Request Body that contains data required for creating a new accounting

Root Schema : AccountingTransactionCollection

Type: object

Collection of Accounting Transaction Models.

Show Source

• data(optional): array data
• paging(optional): object PagingDto
  Paging DTO

{
    "description":"Collection of Accounting Transaction Models.",
    "type":"object",
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AccountingTransactionModel"
            }
        },
        "paging":{
            "$ref":"#/definitions/PagingDto"
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object AccountingTransactionModel
  Accounting Transaction Model

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

Nested Schema : PagingDto

Type: object

Paging DTO

Show Source

• totalResults(optional): integer
  Total Results

{
    "description":"Paging DTO",
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"Total Results"
        }
    }
}

Nested Schema : AccountingTransactionModel

Type: object

Accounting Transaction Model

Show Source

• accClass(optional): string
  Account Class
• accEntryAttributeList(optional): array accEntryAttributeList
• accEntryDesc(optional): string
  Account Entry Description
• accEntrySeq(optional): integer(int64)
  Account Entry Sequence
• accountCcy(optional): string
  Account Currency
• accountingEntryCode(optional): string
  Accounting Entry Code
• accountNo(optional): string
  Account Number
• accPartyId(optional): string
  Account Party Id
• accPartyType(optional): string
  Account Party Type
• accRoleCode(optional): string
  Account Role Code
• accRoleDesc(optional): string
  Account Role Description
• accSettMethod(optional): string
  Account Settlement Method
• accType(optional): string
  Account Type
• actualPostingAmt(optional): number
  Actual Posting Amount
• additionalField1(optional): string
  Additional Field1
• additionalField10(optional): string
  Additional Field10
• additionalField2(optional): string
  Additional Field2
• additionalField3(optional): string
  Additional Field3
• additionalField4(optional): string
  Additional Field4
• additionalField5(optional): string
  Additional Field5
• additionalField6(optional): string
  Additional Field6
• additionalField7(optional): string
  Additional Field7
• additionalField8(optional): string
  Additional Field8
• additionalField9(optional): string
  Additional Field9
• amount(optional): number
  Amount
• amountAccCcy(optional): number
  Amount Account Currency
• amountCcy(optional): string
  Amount Currency
• amountType(optional): string
  Amount Type
• applicationCode(optional): string
  Application Code
• blkRefNo(optional): string
  Block Ref No
• checkerDateStamp(optional): string
  Checker Datestamp
• checkerId(optional): string
  Checker Id
• clearingRefNo(optional): string
  Clearing Ref No
• creditExternalAttributeList(optional): array creditExternalAttributeList
• creditIntAcntList(optional): array creditIntAcntList
• creditInternalAttributeList(optional): array creditInternalAttributeList
• debitExternalAttributeList(optional): array debitExternalAttributeList
• debitIntAcntList(optional): array debitIntAcntList
• debitInternalAttributeList(optional): array debitInternalAttributeList
• drCrIndicator(optional): string
  Debit Credit Indicator
• ecaErrorCode(optional): string
  ECA Error Code
• ecaRefNo(optional): string
  Eca Reference Number
• ecaStatus(optional): string
  ECA Status
• eventCode(optional): string
  Event Code
• eventSrNo(optional): number
  Event Serial Number
• exchangeRate(optional): number
  Exchange Rate
• externalAccount(optional): string
  External Account
• externalAccountCcy(optional): string
  External Account Currency
• externalBankId(optional): string
  External Bank Id
• externalBankName(optional): string
  External Bank Name
• externalBranchCode(optional): string
  External Branch Code
• externalBranchName(optional): string
  External Branch Name
• externalBranchRoutingCode(optional): string
  External Branch Routing Code
• extPmtErrorCode(optional): string
  Payment Error Code
• extPmtErrorCodeDesc(optional): string
  External Payment Error description
• id(optional): string
  Id
• makererDateStamp(optional): string
  Maker Datestamp
• makerId(optional): string
  Maker Id
• paymentMode(optional): string
  Payment Mode
• paymentRefNo(optional): string
  Payment Ref No
• paymentStatus(optional): string
  Payment Status
• postingErrorCode(optional): string
  Posting Error Code
• postingRefNo(optional): string
  Psting Ref No
• postingStatus(optional): string
  Posting Status
• processingDate(optional): string
  Processing date
• productCode(optional): string
  Product code
• refNo(optional): string
  Reference Number
• seqNo(optional): integer(int64)
  Sequence Number
• stage(optional): string
  Stage
• status(optional): string
  Status
• txnBranchCode(optional): string
  Transaction Branch Code
• vaContraAccountNo(optional): string
  VA Contra Account Number
• vaFlagYN(optional): string
  Virtual Account flag as Y or N
• valueDate(optional): string
  Value Date
• vamPostingRefNo(optional): string
  VAM Posting Ref No
• vamPostingStatus(optional): string
  VAM Posting Status

{
    "description":"Accounting Transaction Model",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id"
        },
        "refNo":{
            "type":"string",
            "description":"Reference Number"
        },
        "seqNo":{
            "type":"integer",
            "format":"int64",
            "description":"Sequence Number"
        },
        "accountingEntryCode":{
            "type":"string",
            "description":"Accounting Entry Code"
        },
        "drCrIndicator":{
            "type":"string",
            "description":"Debit Credit Indicator"
        },
        "amountCcy":{
            "type":"string",
            "description":"Amount Currency"
        },
        "eventCode":{
            "type":"string",
            "description":"Event Code"
        },
        "amount":{
            "type":"number",
            "description":"Amount"
        },
        "amountType":{
            "type":"string",
            "description":"Amount Type"
        },
        "accountCcy":{
            "type":"string",
            "description":"Account Currency"
        },
        "amountAccCcy":{
            "type":"number",
            "description":"Amount Account Currency"
        },
        "accountNo":{
            "type":"string",
            "description":"Account Number"
        },
        "exchangeRate":{
            "type":"number",
            "description":"Exchange Rate"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "accRoleCode":{
            "type":"string",
            "description":"Account Role Code"
        },
        "accPartyType":{
            "type":"string",
            "description":"Account Party Type"
        },
        "accPartyId":{
            "type":"string",
            "description":"Account Party Id"
        },
        "accSettMethod":{
            "type":"string",
            "description":"Account Settlement Method"
        },
        "accEntrySeq":{
            "type":"integer",
            "format":"int64",
            "description":"Account Entry Sequence"
        },
        "accRoleDesc":{
            "type":"string",
            "description":"Account Role Description"
        },
        "accEntryDesc":{
            "type":"string",
            "description":"Account Entry Description"
        },
        "accType":{
            "type":"string",
            "description":"Account Type"
        },
        "eventSrNo":{
            "type":"number",
            "description":"Event Serial Number"
        },
        "ecaRefNo":{
            "type":"string",
            "description":"Eca Reference Number"
        },
        "externalAccount":{
            "type":"string",
            "description":"External Account"
        },
        "paymentMode":{
            "type":"string",
            "description":"Payment Mode"
        },
        "externalAccountCcy":{
            "type":"string",
            "description":"External Account Currency"
        },
        "externalBankId":{
            "type":"string",
            "description":"External Bank Id"
        },
        "externalBankName":{
            "type":"string",
            "description":"External Bank Name"
        },
        "externalBranchCode":{
            "type":"string",
            "description":"External Branch Code"
        },
        "externalBranchName":{
            "type":"string",
            "description":"External Branch Name"
        },
        "externalBranchRoutingCode":{
            "type":"string",
            "description":"External Branch Routing Code"
        },
        "stage":{
            "type":"string",
            "description":"Stage"
        },
        "additionalField1":{
            "type":"string",
            "description":"Additional Field1"
        },
        "additionalField2":{
            "type":"string",
            "description":"Additional Field2"
        },
        "additionalField3":{
            "type":"string",
            "description":"Additional Field3"
        },
        "additionalField4":{
            "type":"string",
            "description":"Additional Field4"
        },
        "additionalField5":{
            "type":"string",
            "description":"Additional Field5"
        },
        "additionalField6":{
            "type":"string",
            "description":"Additional Field6"
        },
        "additionalField7":{
            "type":"string",
            "description":"Additional Field7"
        },
        "additionalField8":{
            "type":"string",
            "description":"Additional Field8"
        },
        "additionalField9":{
            "type":"string",
            "description":"Additional Field9"
        },
        "additionalField10":{
            "type":"string",
            "description":"Additional Field10"
        },
        "applicationCode":{
            "type":"string",
            "description":"Application Code"
        },
        "valueDate":{
            "type":"string",
            "description":"Value Date"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing date"
        },
        "txnBranchCode":{
            "type":"string",
            "description":"Transaction Branch Code"
        },
        "productCode":{
            "type":"string",
            "description":"Product code"
        },
        "vaFlagYN":{
            "type":"string",
            "description":"Virtual Account flag as Y or N"
        },
        "actualPostingAmt":{
            "type":"number",
            "description":"Actual Posting Amount"
        },
        "makerId":{
            "type":"string",
            "description":"Maker Id"
        },
        "makererDateStamp":{
            "type":"string",
            "description":"Maker Datestamp"
        },
        "checkerDateStamp":{
            "type":"string",
            "description":"Checker Datestamp"
        },
        "checkerId":{
            "type":"string",
            "description":"Checker Id"
        },
        "postingRefNo":{
            "type":"string",
            "description":"Psting Ref No"
        },
        "postingStatus":{
            "type":"string",
            "description":"Posting Status"
        },
        "ecaStatus":{
            "type":"string",
            "description":"ECA Status"
        },
        "postingErrorCode":{
            "type":"string",
            "description":"Posting Error Code"
        },
        "ecaErrorCode":{
            "type":"string",
            "description":"ECA Error Code"
        },
        "blkRefNo":{
            "type":"string",
            "description":"Block Ref No"
        },
        "accClass":{
            "type":"string",
            "description":"Account Class"
        },
        "vaContraAccountNo":{
            "type":"string",
            "description":"VA Contra Account Number"
        },
        "vamPostingRefNo":{
            "type":"string",
            "description":"VAM Posting Ref No"
        },
        "vamPostingStatus":{
            "type":"string",
            "description":"VAM Posting Status"
        },
        "clearingRefNo":{
            "type":"string",
            "description":"Clearing Ref No"
        },
        "paymentStatus":{
            "type":"string",
            "description":"Payment Status"
        },
        "paymentRefNo":{
            "type":"string",
            "description":"Payment Ref No"
        },
        "extPmtErrorCode":{
            "type":"string",
            "description":"Payment Error Code"
        },
        "creditIntAcntList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "debitIntAcntList":{
            "type":"array",
            "items":{
                "type":"string"
            }
        },
        "accEntryAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "creditInternalAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "debitInternalAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "creditExternalAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "debitExternalAttributeList":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Attribute"
            }
        },
        "extPmtErrorCodeDesc":{
            "type":"string",
            "description":"External Payment Error description"
        }
    }
}

Nested Schema : accEntryAttributeList

Type: array

Show Source

• Array of: object Attribute
  Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : creditExternalAttributeList

Type: array

Show Source

• Array of: object Attribute
  Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : creditIntAcntList

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : creditInternalAttributeList

Type: array

Show Source

• Array of: object Attribute
  Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : debitExternalAttributeList

Type: array

Show Source

• Array of: object Attribute
  Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : debitIntAcntList

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : debitInternalAttributeList

Type: array

Show Source

• Array of: object Attribute
  Represents each attribute of the records filtered in calling service using filter query

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

Nested Schema : Attribute

Type: object

Represents each attribute of the records filtered in calling service using filter query

Show Source

• attributeName(optional): string
  Name of the attribute representing DB column name
• attributeValue(optional): string
  Value of the corresponding column in DB

{
    "description":"Represents each attribute of the records filtered in calling service using filter query",
    "type":"object",
    "properties":{
        "attributeName":{
            "description":"Name of the attribute representing DB column name",
            "type":"string"
        },
        "attributeValue":{
            "description":"Value of the corresponding column in DB",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Headers

• Location: string
  URL of newly created accentrycode

Body ()

Root Schema : ResponseDtoWrapper

Type: object

Response DTO Wrapper

Show Source

• data(optional): object ResponseResourceSupport
  Response Resource Support
• messages(optional): object ResponseDto
  Response DTO

{
    "description":"Response DTO Wrapper",
    "type":"object",
    "properties":{
        "messages":{
            "$ref":"#/definitions/ResponseDto"
        },
        "data":{
            "$ref":"#/definitions/ResponseResourceSupport"
        }
    }
}

Nested Schema : ResponseResourceSupport

Type: object

Response Resource Support

Nested Schema : ResponseDto

Type: object

Response DTO

Show Source

• codes(optional): array codes
  Codes
• id(optional): string
  ID
• requestId(optional): string
  Request ID
• status(optional): string
  Status

{
    "description":"Response DTO",
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"ID"
        },
        "status":{
            "type":"string",
            "description":"Status"
        },
        "codes":{
            "type":"array",
            "description":"Codes",
            "items":{
                "$ref":"#/definitions/ResponseCode"
            }
        },
        "requestId":{
            "type":"string",
            "description":"Request ID"
        }
    }
}

Nested Schema : codes

Type: array

Codes

Show Source

• Array of: object ResponseCode
  Response Code

{
    "type":"array",
    "description":"Codes",
    "items":{
        "$ref":"#/definitions/ResponseCode"
    }
}

Nested Schema : ResponseCode

Type: object

Response Code

Show Source

• arg(optional): string
  Arg
• args(optional): array args
  Args
• Code(optional): string
  Code
• Desc(optional): string
  Description
• Language(optional): string
  Language
• Type(optional): string
  Type

{
    "description":"Response Code",
    "type":"object",
    "properties":{
        "Code":{
            "type":"string",
            "description":"Code"
        },
        "Desc":{
            "type":"string",
            "description":"Description"
        },
        "Type":{
            "type":"string",
            "description":"Type"
        },
        "Language":{
            "type":"string",
            "description":"Language"
        },
        "args":{
            "type":"array",
            "description":"Args",
            "items":{
                "type":"object",
                "description":"Items"
            }
        },
        "arg":{
            "type":"string",
            "description":"Arg"
        }
    }
}

Nested Schema : args

Type: array

Args

Show Source

• Array of: object items
  Items

{
    "type":"array",
    "description":"Args",
    "items":{
        "type":"object",
        "description":"Items"
    }
}

Nested Schema : items

Type: object

Items

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