Jump to

• Request
• Response

Create the purchase order details record

post

/service/v1/postPoTxnData

This endpoint is used to create the purchase order 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 purchase order details to be persisted

Root Schema : PoDTOCollection

Type: object

Collection of PO DTO.

Show Source

• obChargesTxnDTOList(optional): array obChargesTxnDTOList

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

Nested Schema : obChargesTxnDTOList

Type: array

Show Source

• Array of: object PoTxnDTO

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

Nested Schema : PoTxnDTO

Type: object

Match All

Show Source

• allOf GenericDto
• object PoTxnDTO-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/GenericDto"
        },
        {
            "type":"object",
            "properties":{
                "obPoTxnId":{
                    "type":"string",
                    "description":"Ob Po Transaction Id"
                },
                "txnRefNo":{
                    "type":"string",
                    "description":"Transaction Reference Number"
                },
                "poStatus":{
                    "type":"string",
                    "description":"Po status"
                },
                "currency":{
                    "type":"string",
                    "description":"Currency"
                },
                "buyerId":{
                    "type":"string",
                    "description":"Buyer Id"
                },
                "supplierId":{
                    "type":"string",
                    "description":"Supplier Id"
                },
                "buyerName":{
                    "type":"string",
                    "description":"Buyer Name"
                },
                "supplierName":{
                    "type":"string",
                    "description":"Supplier Name"
                },
                "netPoAmount":{
                    "type":"number",
                    "description":"Net Po Amount"
                },
                "acceptanceAmount":{
                    "type":"number",
                    "description":"Acceptance Amount"
                },
                "poDate":{
                    "type":"string",
                    "description":"Po Date"
                },
                "promisedShipmentDate":{
                    "type":"string",
                    "description":"Promised Shipment Date"
                },
                "programId":{
                    "type":"string",
                    "description":"Program Id"
                },
                "programName":{
                    "type":"string",
                    "description":"Program Name"
                },
                "relationshipCode":{
                    "type":"string",
                    "description":"Relationship Code"
                },
                "poExternalNumber":{
                    "type":"string",
                    "description":"PO External Number"
                },
                "poInternalNumber":{
                    "type":"string",
                    "description":"PO Internal Number"
                },
                "processingDate":{
                    "type":"string",
                    "description":"Processing Date"
                },
                "event":{
                    "type":"string",
                    "description":"Event"
                }
            }
        }
    ]
}

Nested Schema : GenericDto

Match All

Show Source

• object GenericDto-allOf[0]
  Discriminator: resource_type

{
    "allOf":[
        {
            "type":"object",
            "discriminator":"resource_type"
        }
    ]
}

Nested Schema : GenericDto-allOf[0]

Type: object

Discriminator: resource_type

Nested Schema : PoTxnDTO-allOf[1]

Type: object

Show Source

• acceptanceAmount(optional): number
  Acceptance Amount
• buyerId(optional): string
  Buyer Id
• buyerName(optional): string
  Buyer Name
• currency(optional): string
  Currency
• event(optional): string
  Event
• netPoAmount(optional): number
  Net Po Amount
• obPoTxnId(optional): string
  Ob Po Transaction Id
• poDate(optional): string
  Po Date
• poExternalNumber(optional): string
  PO External Number
• poInternalNumber(optional): string
  PO Internal Number
• poStatus(optional): string
  Po status
• processingDate(optional): string
  Processing Date
• programId(optional): string
  Program Id
• programName(optional): string
  Program Name
• promisedShipmentDate(optional): string
  Promised Shipment Date
• relationshipCode(optional): string
  Relationship Code
• supplierId(optional): string
  Supplier Id
• supplierName(optional): string
  Supplier Name
• txnRefNo(optional): string
  Transaction Reference Number

{
    "type":"object",
    "properties":{
        "obPoTxnId":{
            "type":"string",
            "description":"Ob Po Transaction Id"
        },
        "txnRefNo":{
            "type":"string",
            "description":"Transaction Reference Number"
        },
        "poStatus":{
            "type":"string",
            "description":"Po status"
        },
        "currency":{
            "type":"string",
            "description":"Currency"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "supplierId":{
            "type":"string",
            "description":"Supplier Id"
        },
        "buyerName":{
            "type":"string",
            "description":"Buyer Name"
        },
        "supplierName":{
            "type":"string",
            "description":"Supplier Name"
        },
        "netPoAmount":{
            "type":"number",
            "description":"Net Po Amount"
        },
        "acceptanceAmount":{
            "type":"number",
            "description":"Acceptance Amount"
        },
        "poDate":{
            "type":"string",
            "description":"Po Date"
        },
        "promisedShipmentDate":{
            "type":"string",
            "description":"Promised Shipment Date"
        },
        "programId":{
            "type":"string",
            "description":"Program Id"
        },
        "programName":{
            "type":"string",
            "description":"Program Name"
        },
        "relationshipCode":{
            "type":"string",
            "description":"Relationship Code"
        },
        "poExternalNumber":{
            "type":"string",
            "description":"PO External Number"
        },
        "poInternalNumber":{
            "type":"string",
            "description":"PO Internal 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