Jump to

• Request
• Response

Purchase Order Link Program

patch

/service/v1/po/linkProgram

This endpoint is used to purchase order link program.

Request

Supported Media Types

• application/json
• application/xml

Header Parameters

• appId: string
• branchCode: string
• userId: string

Body ()

Root Schema : PoLinkedPrgRequest

Type: object

Show Source

• buyerId(optional): string
  Buyer Id
• poExternalNumber(optional): string
  Purchase Order External Number
• poInternalNumber(optional): string
  Purchase Order Internal Number
• programId(optional): string
  Program Code

{
    "type":"object",
    "properties":{
        "poInternalNumber":{
            "type":"string",
            "description":"Purchase Order Internal Number"
        },
        "poExternalNumber":{
            "type":"string",
            "description":"Purchase Order External Number"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "programId":{
            "type":"string",
            "description":"Program Code"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/xml

201 Response

Returns message of succes or failure

Body ()

Root Schema : PoServiceResponse

Type: object

Show Source

• buyerId(optional): string
  Buyer Id
• errors(optional): array errors
  Error List
• poExternalNumber(optional): string
  Po External Number
• poInternalNumber(optional): string
  Po Internal Number
• poStatus(optional): string
  Po Status
• poTransactionRefNo(optional): string
  Po Transaction Ref Number
• processStatus(optional): string
  Process Status
• sourceTxnId(optional): string
  sourceTxnId

{
    "type":"object",
    "properties":{
        "poInternalNumber":{
            "type":"string",
            "description":"Po Internal Number"
        },
        "poExternalNumber":{
            "type":"string",
            "description":"Po External Number"
        },
        "buyerId":{
            "type":"string",
            "description":"Buyer Id"
        },
        "poStatus":{
            "type":"string",
            "description":"Po Status"
        },
        "processStatus":{
            "type":"string",
            "description":"Process Status"
        },
        "poTransactionRefNo":{
            "type":"string",
            "description":"Po Transaction Ref Number"
        },
        "sourceTxnId":{
            "type":"string",
            "description":"sourceTxnId"
        },
        "errors":{
            "type":"array",
            "description":"Error List",
            "items":{
                "$ref":"#/definitions/ErrorDto"
            }
        }
    }
}

Nested Schema : errors

Type: array

Error List

Show Source

• Array of: object ErrorDto

{
    "type":"array",
    "description":"Error List",
    "items":{
        "$ref":"#/definitions/ErrorDto"
    }
}

Nested Schema : ErrorDto

Type: object

Show Source

• errorCode(optional): string
  Error Codes Displaying
• errorDesc(optional): string
  Error Description displaying based on error codes

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error Codes Displaying"
        },
        "errorDesc":{
            "type":"string",
            "description":"Error Description displaying based on error codes"
        }
    }
}

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