IPASISystemSubmitInvoice Method Provincial Approach to Student Information API
Ministry only service. This service inserts the document order invoice.

Namespace: PASI.ServiceContract
Assembly: PASI.ServiceContract (in PASI.ServiceContract.dll) Version: 9.23.3.0 (9.23.3.0)
Syntax
Copy
ElectronicPaymentSystemInvoiceConstructResponse SubmitInvoice(
	ElectronicPaymentSystemInvoiceConstructRequest request
)

Parameters

request
Type: PASI.DataContract.V201507ElectronicPaymentSystemInvoiceConstructRequest
The ElectronicPaymentSystemInvoiceConstructRequest specifying the document order invoice Id, and Arguments to use for the document order invoice.

Return Value

Type: ElectronicPaymentSystemInvoiceConstructResponse
A ElectronicPaymentSystemInvoiceConstructResponse with the new PASICoreVersion value after a successful insertion, or with Rejections after an unsuccessful update.

Service Validations

The following codes can be returned from the service operation. This list also shows core alerts that could be generated as a result calling this service. These codes are in addition to the standard set of codes that can be returned defined as in the Approach to Error Reporting. Click the link for the details.

No additional errors for this service.
Remarks

If the service encounters any errors during the submission process, it returns a list of rejections and does not save the document order invoice.

Request and Response Class Diagram



Request Fields

Full Property NameTypeRequiredOther Attributes
CallerInfoCallerInfoYes
CallerInfo.ClientMessageIDStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.SentUtcTimeDateTimeYes
CallerInfo.SoftwareSoftwareYes
CallerInfo.Software.BuildNumberStringYesValue must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.ManufacturerStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.ProductStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.Software.VersionStringYesValue must be no more than 30 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.UserUserYes
CallerInfo.User.IPAddressStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.LocalIDStringYesValue must be no more than 50 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.NameStringYesValue must be no more than 100 characters Value must not have control characters, leading, trailing or multiple embedded spaces. Content must not match regular expression: ^\s|\s{2,}|\s$|[\x00-\x19]|[\x7F-\x9F]|[^\x00-\xFF]
CallerInfo.User.OrganizationCodeStringYesValue must be no more than 6 characters
ElectronicPaymentSystemInvoiceIdInt32YesValue must be greater than or equal to 0
InvoiceProcessingStatusStringYesValue must be an appropriate InvoiceProcessingStatus code value
PASICoreVersionInt64YesValue must be greater than or equal to 0
SourceOrderIdInt32YesValue must be greater than or equal to 0
SourceOrderTypeStringYesValue must be an appropriate SourceOrderType code value


Response Fields

Full Property NameTypeRequiredOther Attributes
ElectronicPaymentSystemInvoiceConstructResponse.ElectronicPaymentSystemInvoiceIdInt32Yes
ElectronicPaymentSystemInvoiceConstructResponse.PASICoreVersionInt64Yes
ElectronicPaymentSystemInvoiceConstructResponse.RejectionsList<Rejection>No
ElectronicPaymentSystemInvoiceConstructResponse.Rejections.CodeStringYes
ElectronicPaymentSystemInvoiceConstructResponse.Rejections.DescriptionStringYes
See Also

Reference

IPASISystem Interface
PASI.ServiceContract Namespace