Invoice Payment

Start Pay Invoice Process

POST /api/.../workflow

This method allows the caller to pay invoice.

Permissions

This call requires the CR_Invoices_Modify (ID: 36) and CR_Invoices_PayCredit (ID: 39). CR_Invoices_PayExceedFundExpendLimits (343) permission is based on the invoice's branch.

Workflow Steps

  • Validate data in the request
  • Check if the funds closed (can not be bypassed)
  • Check fund expenditure limits, returns the list of funds that over-expended or expenditure limits are exceeded (can be bypassed)
  • Check if linked lines are locked (can not be bypassed)
  • Check if linked funds are locked (can not be bypassed)
  • Pay invoice

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. This value must be set to 30.
TxnBranchID Int No Transacting branch ID. This should represent where the request originated from. Typically the same as the logged on branch, but in the case of offline processing it would be the branch that was logged into during offline processing.
TxnUserID Int No Transacting Polaris user ID. This should represent who originally created this request. Typically the same as the logged on user, but in the case of offline processing it would be the user that was logged on during offline processing.
TxnWorkstationID Int No Transacting workstation ID. This should represent where the request originated from. Typically the same as the logged on workstation, but in the case of offline processing it would be the workstation that was logged into during offline processing.
RequestExtension DtoWorkflowRequestExtension No To pay invoice requires a InvoicePaymentExtensionData object.
WorkflowReplies List of DtoWorkflowReply Yes It is possible to pass in a list of replies for automated processing.
InvoicePaymentExtensionData
Property Type Nullable Description
WorkflowRequestExtensionType Int No To pay invoice, the extension type must be a 27.
Data Object No This must be an extension data object of type DtoInvoicePaymentExtensionData
InvoicePaymentExtensionData
Property Type Nullable Description
InvoiceID Integer No Primary key. Used to pay invoice record.
InvoiceStatusID Integer No Open: 1, Closed: 2, Cancelled: 3, Held: 4, Paid: 5, PartiallyPaid: 6, Credited: 7, PrePaid: 8
PaymentStatusID Integer No Values: Credited: 1, Free: 3, Open: 6, Paid: 7, Prepaid: 9, PartPaid: 10, Debit: 11, Credit: 12
CheckNumber String No Check number
CheckDate DateTime No The date the check is issued
VchrNumber String Yes Voucher number
VchrDate DateTime Yes The date on the voucher
PayAmount Decimal Yes Invoice amount
PaymentType Integer Yes Values 2: Check and 3: Voucher

Pay invoice Request body

application/json, text/json 
{
   
    "WorkflowRequestType": 30,
    "TxnBranchID": 3,
    "TxnUserID": 1,
    "TxnWorkstationID": 923,
    "RequestExtension": {
        "WorkflowRequestExtensionType": 27,
        "Data": {
            "InvoiceID": 8289,
            "InvoiceStatusID":1,
            "PaymentStatusID": 1,
            "CheckNumber":"123",
            "CheckDate":"2021-06-18T00:00:00-04:00",  
            "PayAmount":5.0,
            "PaymentType":2    
        }
    },
    "WorkflowReplies": null
}
application/json, text/json 
{
    "WorkflowRequestGuid":"0da2f26d-f645-4711-98e2-aed902df43f8",
    "WorkflowRequestType":25,
    "WorkflowStatus":-3,
    "Prompt":{"WorkflowPromptID":107,
    "Name":null,"Description":null,
    "WorkflowPromptType":38,
    "WorkflowPromptOptions":6,
    "DefaultPromptOption":4,
    "Title":"Create Item for Issue/Part",
    "Message":"","AlternateMessage":"",
    "AlternateYesText":"","AlternateNoText":"",
    "AlternateCancelText":"",
    "AlternateContinueText":"",
        "PromptExtension":
        {
            "WorkflowPromptExtensionType":36,
            "Data":
            {
                "Title":"Semi - Pro football guide.",
                "DestinationOrgID":103,
                "DestinationOrgName":"Stillwater Public Library (STI)",
                "Designation":"(2013)",
                "UnitPrice":123.4500,
                "Barcode":null,
                "UnitPriceEnabled":true
            }
        }
    },
    "InformationMessages":[],
    "AnswerExtension":null,
    "CircTranType":0,
    "ReceiptType":0,
    "ReceiptUrl":"",
    "FineEReceiptSent":false
}
Example - Overexpenditure response
application/json, text/json 
{
  "WorkflowRequestGuid": "19bac540-8caa-4d10-8d8e-54b8956b4430",
  "WorkflowRequestType": 30,
  "WorkflowStatus": -3,
  "Prompt": {
    "WorkflowPromptID": 122,
    "Name": null,
    "Description": null,
    "WorkflowPromptType": 41,
    "WorkflowPromptOptions": 6,
    "DefaultPromptOption": 4,
    "Title": "Overexpenditure List",
    "Message": "",
    "AlternateMessage": "",
    "AlternateYesText": "",
    "AlternateNoText": "",
    "AlternateCancelText": "",
    "AlternateContinueText": "",
    "PromptExtension": {
      "WorkflowPromptExtensionType": 41,
      "Data": {
        "FundExpenditureLimitData": [
          {
            "Flag": 2,
            "FundID": 639,
            "FundName": "Build 181a",
            "Fiscalyrname": "Build 181",
            "AmountOverExp": 160.06,
            "LineNum": null,
            "SegNum": null
          },
          {
            "Flag": 3,
            "FundID": 639,
            "FundName": "Build 181a",
            "Fiscalyrname": "Build 181",
            "AmountOverExp": 16.56,
            "LineNum": null,
            "SegNum": null
          },
          {
            "Flag": 4,
            "FundID": 639,
            "FundName": "Build 181a",
            "Fiscalyrname": "Build 181",
            "AmountOverExp": 16.56,
            "LineNum": "1",
            "SegNum": "1"
          }
        ]
      }
    }
  },
  "InformationMessages": [],
  "AnswerExtension": null,
  "CircTranType": 0,
  "ReceiptType": 0,
  "ReceiptUrl": "",
  "FineEReceiptSent": false
}

Pay invoice Response Information

Example: DtoWorkflowAnswer - Invoice paid successfully
application/json, text/json 
{
   "WorkflowRequestGuid": "19bac540-8caa-4d10-8d8e-54b8956b4430",
  "WorkflowRequestType": 30,
  "WorkflowStatus": 1,
  "Prompt": null,
  "InformationMessages": [
    {
      "Type": 1,
      "Title": "",
      "Message": "Invoice paid 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_Invoices_Modify(based on invoice's branch ID)
    CR_Invoices_PayCredit (based on the invoice's branch ID)
    CR_Invoices_PayExceedFundExpendLimits