API Functions

GetInvoices

Gets Invoices by parameters
Request Method: POST	GetInvoicesRequest GetInvoices request object
Response	GetInvoicesResponse Returns List of Invoices and Total Record Count

GetDespatchs

Gets Despatch by parameters
Request Method: POST	GetDespatchsRequest GetDespatch request object
Response	GetDespatchsResponse Returns List of Despatch and Total Record Count

GetFolders

Gets the folder list
Request Method: POST	GetFoldersRequest Request object
Response	GetFoldersResponse List of folders

GetSources

Gets the source definition list
Request Method: POST	GetSourcesRequest GetSources request object
Response	GetSourcesResponse Returns List of Sources

SetInvoiceNo

Set InvoiceNo to Invoice by InvoiceIntId
Request Method: POST	SetInvoiceNoRequest SetInvoiceNo request object
Response	SetInvoiceNoResponse Returns nothing

SendInvoices

Send Invoices to GIB
Request Method: POST	SendInvoicesRequest SendInvoices request object
Response	SendInvoicesResponse Returns results

CheckInvoice

Checks Invoice is void in Source System
Request Method: POST	CheckInvoiceRequest CheckInvoice request object
Response	CheckInvoiceResponse Returns CheckInvoice response object

SetInvoice

Save an invoice to portal+ and if SendInvoice is true, send to GIB
Request Method: POST	SetInvoiceRequest SetInvoice request object
Response	SetInvoiceResponse SetInvoice response object

SetCheck

Save an Check to portal+
Request Method: POST	SetCheckRequest SetCheck request object
Response	SetCheckResponse SetCheck response object

SetDespatch

Save an despatch to portal+ and if SendDespatch is true, send to GIB
Request Method: POST	SetDespatchRequest SetDespatch request object
Response	SetDespatchResponse SetDespatch response object

GetAccounts

Get All Accounts from Source
Request Method: POST	GetAccountsRequest GetAccounts request object
Response	GetAccountsResponse Returns List of Accounts from requested Source

NotifyInvoiceResponseState

This api function can only be used for commercial scenario invoices. For outgoing commercial invoices (portalplus to gib), if integrator receives an accept or deny invoice response from GIB, it forwards this status info to PortalPlus by this api function. For incoming commercial invoices (gib to portalplus), this api function accepts or denies an invoice and sends this status notification to gib by calling integrator's notify status api function.
Request Method: POST	NotifyInvoiceResponseStateRequest NotifyInvoiceResponseStateRequest containing acceptance status
Response	NotifyInvoiceResponseStateResponse Returns NotifyInvoiceResponseStateResponse object

NotifyEnvelopeStatus

If integrator receive an envelope status message from GIB, he forwards this info to PortalPlus by this api function
Request Method: POST	NotifyEnvelopeStatusRequest NotifyEnvelopeStatus request object
Response	NotifyEnvelopeStatusResponse Returns NotifyEnvelopeStatus response object

GetPartyInfo

[Deprecated] GetPartyInfo is deprecated, please use GetNewPartyInfo instead.
Get Party Info from Source System
Request Method: POST	GetPartyInfoRequest GetPartyInfo request object
Response	GetPartyInfoResponse Returns GetPartyInfo response object

GetPartyInfoList

[Deprecated] GetPartyInfoList is deprecated, please use GetNewPartyInfoList instead.
Get Party Info List from Source System
Request Method: POST	GetPartyInfoListRequest GetPartyInfoList request object
Response	GetPartyInfoListResponse Returns List of GetPartyInfo

GetNewPartyInfo

Get Party Info from Source System
Request Method: POST	GetPartyInfoRequest GetPartyInfo request object
Response	GetUserListResponse Returns GetPartyInfo response object

GetNewPartyInfoList

Get Party Info List from Source System
Request Method: POST	GetPartyInfoListRequest GetPartyInfoList request object
Response	GetUserListGroupResponse Returns List of GetPartyInfo

GetSourceParameters

Gets source specific extra parameters
Request Method: POST	GetSourceParametersRequest request object containing source id
Response	GetSourceParametersResponse list of extra source parameters

CancelEArchiveInvoice

Cancels an e-archive invoice
Request Method: POST	CancelEArchiveInvoiceRequest invoice info to be cancelled
Response	CancelEArchiveInvoiceResponse ?

CancelCheck

Cancels an e-check
Request Method: POST	CancelCheckRequest check info to be cancelled
Response	CancelCheckResponse ?

GetCheckList

Returns the id-list of the echeck within the given criteria and the given sort order. You can get the list from portalplus database
Request Method: POST	GetCheckListRequest ?
Response	GetCheckListResponse ?

GetChecks

Gets Checks by parameters
Request Method: POST	GetChecksRequest GetChecks request object
Response	GetChecksResponse Returns List of Checks and Total Record Count

GetCodeDefs

Returns GIB Reason Code list
Request Method: POST	GetCodeDefsRequest Requested list type
Response	GetCodeDefsResponse Code list

GetInvoiceView

Returns invoice view in requested format
Request Method: POST	GetInvoiceViewRequest Requested invoice and format
Response	GetInvoiceViewResponse If requested format is pdf, byte array pdf data will be returned as formatted base64 string. If requested format is html, ViewData will be html string.

GetDocumentView

Returns document view in requested format
Request Method: POST	GetDocumentViewRequest Requested document and format
Response	GetInvoiceViewResponse If requested format is pdf, byte array pdf data will be returned as formatted base64 string. If requested format is html, ViewData will be html string.

GetUbl

Returns ubl-tr (with xslt) of a portalplus invoice
Request Method: POST	GetUblRequest Requested Invoice Ubl
Response	GetUblResponse ?

GetInvoiceList

Returns the id-list of the invoices within the given criteria and the given sort order. You can get the list from portalplus database or from a datasource by setting RunAtSource parameter to true.
Request Method: POST	GetInvoiceListRequest ?
Response	GetInvoiceListResponse ?

SetEArchiveInvoiceAsProcessed

Sets the e-archive invoice as processed at the source system.
Request Method: POST	SetEArchiveInvoiceAsProcessedRequest ?
Response	SetEArchiveInvoiceAsProcessedResponse Http 200 means success

Ping

Is Service up and runnig check
Request Method: POST
Response	string if it's OK, returns "OK"

ChangeInvoiceFolder

Change Document Folder
Request Method: POST	ChangeInvoiceFolderRequest ChangeInvoiceFolderRequest object
Response	ChangeInvoiceFolderResponse ChangeInvoiceFolderResponse object