Release Purchase Order

Start Release Purchase Order Process

POST /api/.../workflow

This method starts the process to release an acquisitions-based purchase order.

Permissions

This call requires the following:

  • CR_AccessAcquisitions_Allow
  • CR_PurchaseOrders_ReleaseReceiveCancelClosePO based on ordering organization
  • CR_ModifyABibRecordFromAcquisitionsAndSerials_Allow when opting to set 'Display in PAC'
  • CR_CreateAndDeleteItemRecordFromAcquisitionsAndSerials_Allow when opting to create on-order items

Workflow Steps

  • Start procedure
  • Check PO num length
  • Check for release required fields
  • Check for missing bibs
  • Check duplicate line segments
  • Check none ISBN/ISSN and DisplayInPAC
  • Check on-order item generation
  • Choose payment options
  • Release purchase order
  • Provide supplier EDI instruction

Request Information

Parameters
Name Type Required Description
WorkflowRequest DtoWorkflowRequest Yes Define this parameter in the request body.
DtoWorkflowRequest
Property Type Nullable Description
WorkflowRequestType Int No Required. To release a purchase order, this must be set to 32 (ReleasePurchaseOrder).
TxnBranchID Int No Transacting branch ID. This should represent where the PO is being released from.
TxnUserID Int No Transacting Polaris user ID. This should represent who originally created this release PO request.
TxnWorkstationID Int No Transacting workstation ID. This should represent where the release PO request originated from.
RequestExtension DtoWorkflowRequestExtension No To reactivate a hold request requires a DtoReleasePurchaseOrderExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes In the future, it may be possible to pass in a list of replies for automated processing.
DtoReleasePurchaseOrderExtensionData
Property Type Nullable Description
WorkflowRequestExtensionType Int No To release a purchase order, the extension type must be a 29 (ReleasePurchaseOrderData).
Data Object No This must be an extension data object of type DtoReleasePurchaseOrderExtensionData
DtoReleasePurchaseOrderExtensionData
Property Type Nullable Description
PurchaseOrderID Integer No Primary key. Used to identity purchase order being released.

Release purchase order body

application/json, text/json 
{
    "WorkflowRequestType": 32,
    "TxnBranchID": 3,
    "TxnUserID": 1,
    "TxnWorkstationID": 1237,
    "RequestExtension":
    {
        "WorkflowRequestExtensionType": 29,
        "Data":{
            "PurchaseOrderID": 20788
        }
    },
    "WorkflowReplies":null
}

Response Information

Example - Missing ISBN/ISSN or 'Display In PAC' unchecked response
application/json, text/json 
{
  "WorkflowRequestGuid": "409ef0fe-eb91-4a8f-bed4-d330307c82d9",
  "WorkflowRequestType": 32,
  "WorkflowStatus": -3,
  "Prompt": {
    "WorkflowPromptID": 124,
    "Name": null,
    "Description": null,
    "WorkflowPromptType": 50,
    "WorkflowPromptOptions": 6,
    "DefaultPromptOption": 5,
    "Title": "Purchase Order Release Alert",
    "Message": "The following lines are missing ISBN/ISSN data or the bibliographic record's
'Display In PAC' box is unchecked:",
    "AlternateMessage": "",
    "AlternateYesText": "",
    "AlternateNoText": "",
    "AlternateCancelText": "",
    "AlternateContinueText": "",
    "PromptExtension": {
      "WorkflowPromptExtensionType": 44,
      "Data": {
        "ShowCheckbox": true,
        "CheckboxText": "Check 'Display in PAC'",
        "IsChecked": true,
        "Columns": [
          {
            "Name": "Line Number/Title",
            "Key": "LineDescription",
            "Type": "Text"
          },
          {
            "Name": "Reason",
            "Key": "AlertMessage",
            "Type": "Text"
          }
        ],
        "Data": [
          {
            "LineNumber": 8,
            "LineDescription": "Line Number 8; The corporation [DVD]",
            "AlertMessage": "Missing ISBN/ISSN"
          },
          {
            "LineNumber": 9,
            "LineDescription": "Line Number 9; Alone in the wilderness [DVD]",
            "AlertMessage": "Missing ISBN/ISSN"
          },
          {
            "LineNumber": 123,
            "LineDescription": "Line Number 123; Engine, engine, number nine [sound recording]",
            "AlertMessage": "The linked bibliographic record's \"Display In PAC\" box is unchecked"
          },
          {
            "LineNumber": 734,
            "LineDescription": "Line Number 734; Hip hop: gold [compact audio disc].",
            "AlertMessage": "Missing ISBN/ISSN
The linked bibliographic record's \"Display In PAC\" box is unchecked"
          }
        ]
      }
    }
  },
  "InformationMessages": [],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
Example - Generate on-order items response
application/json, text/json 
{
  "WorkflowRequestGuid": "d6dd2fbf-c8ec-4e5a-9a1d-a6db899177e8",
  "WorkflowRequestType": 32,
  "WorkflowStatus": -3,
  "Prompt": {
    "WorkflowPromptID": 125,
    "Name": null,
    "Description": null,
    "WorkflowPromptType": 1,
    "WorkflowPromptOptions": 2,
    "DefaultPromptOption": 2,
    "Title": "Create on-order items",
    "Message": "Do you want to generate on-order item records?",
    "AlternateMessage": "",
    "AlternateYesText": "",
    "AlternateNoText": "",
    "AlternateCancelText": "",
    "AlternateContinueText": "",
    "PromptExtension": null
  },
  "InformationMessages": [],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
Example - Payment options response
application/json, text/json 
{
  "WorkflowRequestGuid": "4102f9cf-9961-4e7c-a60e-cf93ef736f93",
  "WorkflowRequestType": 32,
  "WorkflowStatus": -3,
  "Prompt": {
    "WorkflowPromptID": 128,
    "Name": null,
    "Description": null,
    "WorkflowPromptType": 48,
    "WorkflowPromptOptions": 6,
    "DefaultPromptOption": 5,
    "Title": "Payment Options",
    "Message": null,
    "AlternateMessage": "",
    "AlternateYesText": "",
    "AlternateNoText": "",
    "AlternateCancelText": "",
    "AlternateContinueText": "",
    "PromptExtension": {
      "WorkflowPromptExtensionType": 42,
      "Data": {
        "Amount": 13.2,
        "DefaultPaymentType": 3,
        "IsForeignCurrency": false,
        "AmountLabel": "Amount:",
        "ExchangeRate": null,
        "ExchangeRateLastModifiedDate": null
      }
    }
  },
  "InformationMessages": [],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
Example - Negative free balance response
application/json, text/json 

{
  "WorkflowRequestGuid": "4102f9cf-9961-4e7c-a60e-cf93ef736f93",
  "WorkflowRequestType": 32,
  "WorkflowStatus": -3,
  "Prompt": {
    "WorkflowPromptID": 129,
    "Name": null,
    "Description": null,
    "WorkflowPromptType": 1,
    "WorkflowPromptOptions": 6,
    "DefaultPromptOption": 4,
    "Title": "Negative free balance",
    "Message": "The free balance in fund(s) A 3rd Fund will result in a negative amount.

Do you want to continue?",
    "AlternateMessage": "",
    "AlternateYesText": "",
    "AlternateNoText": "",
    "AlternateCancelText": "",
    "AlternateContinueText": "",
    "PromptExtension": null
  },
  "InformationMessages": [],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}
Example - Overexpenditure response
application/json, text/json 
{
    "WorkflowRequestGuid":"c894167c-9e98-47ff-885b-7ac31f4e76c8",
    "WorkflowRequestType":32,
    "WorkflowStatus":-3,
    "Prompt":{
        "WorkflowPromptID":131,
        "Name":null,
        "Description":null,
        "WorkflowPromptType":49,
        "WorkflowPromptOptions":6,
        "DefaultPromptOption":4,
        "Title":"Overexpenditure list",
        "Message":null,
        "AlternateMessage":"",
        "AlternateYesText":"",
        "AlternateNoText":"",
        "AlternateCancelText":"",
        "AlternateContinueText":"",
        "PromptExtension":{
            "WorkflowPromptExtensionType":43,
            "Data":{
                "ObjectType":19,
                "IsOverexpenditure":true,
                "Prepaid":true,
                "Funds":[
                    {
                        "IsLineItem":false,
                        "FundID":7927,
                        "FundName":"october 15",
                        "LineAndSegment":null,
                        "FiscalYearName":"LUZ FY 2008",
                        "Description":"Free Balance",
                        "AmountOver":null
                    },
                    {
                        "IsLineItem":false,
                        "FundID":7927,
                        "FundName":"october 15",
                        "LineAndSegment":null,
                        "FiscalYearName":"LUZ FY 2008",
                        "Description":"Fund",
                        "AmountOver":200.0000
                    },
                    {
                        "IsLineItem":false,
                        "FundID":7927,
                        "FundName":"october 15",
                        "LineAndSegment":null,
                        "FiscalYearName":"LUZ FY 2008",
                        "Description":"Invoice",
                        "AmountOver":200.0000
                    }
                ],
                "LineItemFunds":[
                    {
                        "IsLineItem":true,
                        "FundID":0,
                        "FundName":"october 15",
                        "LineAndSegment":"1, 1",
                        "FiscalYearName":"LUZ FY 2008",
                        "Description":"",
                        "AmountOver":25.0000
                    },
                    {
                        "IsLineItem":true,
                        "FundID":0,
                        "FundName":"october 15",
                        "LineAndSegment":"1, 2",
                        "FiscalYearName":"LUZ FY 2008",
                        "Description":"",
                        "AmountOver":25.0000
                    },
                    {
                        "IsLineItem":true,
                        "FundID":0,
                        "FundName":"october 15",
                        "LineAndSegment":"1, 3",
                        "FiscalYearName":"LUZ FY 2008",
                        "Description":"",
                        "AmountOver":25.0000
                    },
                    {
                        "IsLineItem":true,
                        "FundID":0,
                        "FundName":"october 15",
                        "LineAndSegment":"1, 4",
                        "FiscalYearName":"LUZ FY 2008",
                        "Description":"",
                        "AmountOver":25.0000
                    }
                ]
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Success
application/json, text/json 
{
  "WorkflowRequestGuid": "128172b6-93ef-4605-af45-29ff2d0cd953",
  "WorkflowRequestType": 32,
  "WorkflowStatus": 1,
  "Prompt": null,
  "InformationMessages": [
    {
      "Type": 1,
      "Title": "",
      "Message": "The order was released successfully."
    }
  ],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}

HTTP Response Codes

Code Description
200 OK. Success

Required Permissions

Permission IDs found here.

    CR_AccessAcquisitions_Allow
    CR_PurchaseOrders_ReleaseReceiveCancelClosePO
    CR_ModifyABibRecordFromAcquisitionsAndSerials_Allow
    CR_CreateAndDeleteItemRecordFromAcquisitionsAndSerials_Allow