Jump to

• Request
• Response

Create the invoice transaction details record

post

/service/v1/postInvoiceTxnData

This endpoint is used to create the invoice transaction details record.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

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

Body ()

Request body with invoice transaction details to be persisted

Root Schema : InstrumentTxnDTOCollection

Type: object

Collection of InstrumentTxnDTO.

Show Source

• obChargesTxnDTOList(optional): array obChargesTxnDTOList

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

Nested Schema : obChargesTxnDTOList

Type: array

Show Source

• Array of: object InstrumentTxnDTO
  Instrument Transaction DTO.

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

Nested Schema : InstrumentTxnDTO

Type: object

Instrument Transaction DTO.

Show Source

• acceptanceAmount(optional): number
  Acceptance Amount
• buyerId(optional): string
  Buyer Id
• buyerName(optional): string
  Buyer Name
• event(optional): string
  Event
• extInvoiceRefNo(optional): string
  External Invoice Reference Number
• invoiceCcy(optional): string
  Invoice Currency
• invoiceDate(optional): string
  Invoice Date
• invoiceDueDate(optional): string
  Invoice Due Date
• invoiceRefNo(optional): string
  Invoice Reference Number
• invoiceStatus(optional): string
  Invoice Status
• netInvoiceAmt(optional): number
  Net Invoice Amount
• processingDate(optional): string
  Processing Date
• programCode(optional): string
  Program Code
• relation(optional): string
  Relation
• supplierId(optional): string
  Supplier Id
• supplierName(optional): string
  Supplier Name
• txnRefNo(optional): string
  Transaction Reference Number

{
    "description":"Instrument Transaction DTO.",
    "type":"object",
    "properties":{
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "invoiceRefNo":{
            "type":"string",
            "description":"Invoice Reference Number"
        },
        "invoiceStatus":{
            "type":"string",
            "description":"Invoice Status"
        },
        "invoiceCcy":{
            "type":"string",
            "description":"Invoice Currency"
        },
        "netInvoiceAmt":{
            "type":"number",
            "description":"Net Invoice Amount"
        },
        "acceptanceAmount":{
            "type":"number",
            "description":"Acceptance Amount"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "invoiceDate":{
            "type":"string",
            "description":"Invoice Date"
        },
        "invoiceDueDate":{
            "type":"string",
            "description":"Invoice Due Date"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "programCode":{
            "type":"string",
            "description":"Program Code"
        },
        "relation":{
            "type":"string",
            "description":"Relation"
        },
        "extInvoiceRefNo":{
            "type":"string",
            "description":"External Invoice Reference Number"
        },
        "processingDate":{
            "type":"string",
            "description":"Processing Date"
        },
        "event":{
            "type":"string",
            "description":"Event"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

Success

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