MediusFlow Adapter

This adapter allows you to access the Medius Flow API from SQL Server and REST commands

Want to try it in Azure? Click here to learn more or click here to create a new Enzo Server RTM 3.1 Azure VM now.

Want to try it in AWS? Click here to learn more or click here to create a new Enzo Server RTM 3.1 AWS VM now.

Configuration Settings

Name	Description	Default
Boolean _isDefault	Make this the default configuration. Defaults to true if configName is already the default.
String grant_type
String scope
String client_id
String client_secret
String connectTokenUrl
String masterDataUrl
String messageUrl
String shortUrlConnStr	URL connection string. For example: 'app=FireBase;server=https://firebasedynamiclinks.googleapis.com/v1/shortLinks?key=keyvalue;domainUriPrefix=enzo1.page.link;suffix=SHORT'

Handlers

AddSupplierInvoiceErrors
SupplierInvoiceErrors

Add a supplier invoice error details

Arguments

Name	Description	Default
correlationKey R
message R

SQL Call

exec MediusFlow.AddSupplierInvoiceErrors 'test'
insert MediusFlow.SupplierInvoiceErrors (correlationId, message) values ('123abc', 'message' )

Http Call

/bsc/mediusflow/addsupplierinvoiceerrors

Output Columns

This call does not return data.

GetSupplierInvoice
SupplierInvoice

Get the details of a supplier invoice details

Arguments

Name	Description	Default
messageStatus R		Fetched
messageId R

SQL Call

exec MediusFlow.GetSupplierInvoice 'test'
select * from MediusFlow.SupplierInvoice where arg1 = 'test'

Http Call

/bsc/mediusflow/getsupplierinvoice

Output Columns

Int32 messageId
String correlationKey
String messageStatus
Int32 invoice__documentId
String importedOrderIdentifier
String importedOrderIdentifier2
String invoice__balanceCodeString__dimensions
Decimal invoice__balanceCodeString__amount
String invoice__companyExternalSystemId
String invoice__companyId
String invoice__companyName
String invoice__companyIdentifiers
String invoice__companyOrganizationNumber
String invoice__currencyCode
String invoice__currencyExternalSystemId
Decimal invoice__currencyRate
Boolean invoice__isCurrencyRateImported
Boolean invoice__hasCrossCompanyPostings
String invoice__originalDocumentType
DateTime invoice__dueDate
DateTime invoice__finalBookingDate
String invoice__finalPeriodName
String invoice__finalPeriodExternalSystemId
String invoice__imagePath
String invoice__documentURL
DateTime invoice__invoiceDate
String invoice__invoiceNumber
String invoice__invoiceReference
Decimal invoice__netAmount
String invoice__paymentReference
String invoice__paymentTerm
DateTime invoice__preferredPaymentDate
DateTime invoice__preliminaryBookingDate
String invoice__preliminaryPeriodExternalSystemId
String invoice__preliminaryPeriodName
String invoice__preliminaryVoucherNumber
String invoice__finalVoucherNumber
Decimal invoice__roundingAmount
String invoice__supplierCountry
String invoice__supplierExternalSystemId
String invoice__supplierId
String invoice__supplierIdentifiers
String invoice__supplierName
String invoice__supplierState
String invoice__supplierTaxIndicator
String invoice__supplierTaxIndicator2
Decimal invoice__taxAmount
String invoice__taxIndicator
String invoice__taxIndicator2
Decimal invoice__totalAmount
Decimal invoice__totalCodedNetAmount
Decimal invoice__totalCodedTaxAmount
Int32 invoice__invoiceLines
Int32 invoice__codingLines
Int32 invoice__taxLines
Int32 invoice__poLines
Int32 invoice__poConnectionLines
Int32 invoice__deviationLines
Int32 invoice__exceptionTypeConnections
Boolean invoice__isPaymentBlocked
String invoice__erpId
String tag
Boolean customField_Boolean1
Boolean customField_Boolean2
Boolean customField_Boolean3
Boolean customField_Boolean4
Boolean customField_Boolean5
Decimal customField_Numeric1
Decimal customField_Numeric2
Decimal customField_Numeric3
Decimal customField_Numeric4
Decimal customField_Numeric5
String customField_Text1
String customField_Text2
String customField_Text3
String customField_Text4
String customField_Text5
DateTime customField_DateTime1
DateTime customField_DateTime2
DateTime customField_DateTime3
DateTime customField_DateTime4
DateTime customField_DateTime5
String raw

ListSupplierInvoiceCodingLines
SupplierInvoiceCodingLines

Return a list of coding lines for an invoice details

Arguments

Name	Description	Default
messageStatus R		Fetched
messageId R

SQL Call

exec MediusFlow.ListSupplierInvoiceCodingLines 'test'
select * from MediusFlow.SupplierInvoiceCodingLines where arg1 = 'test'

Http Call

/bsc/mediusflow/listsupplierinvoicecodinglines

Output Columns

String correlationKey
Int32 documentId
String CompanyId
String CompanyExternalSystemId
String importedOrderIdentifier
String Dimension1
String Dimension2
String Dimension3
String Dimension4
String Dimension5
String Dimension6
String Dimension7
String Dimension8
String Dimension9
String Dimension10
String Dimension11
String Dimension12
Decimal Amount
Decimal GrossAmount
Decimal Quantity
String Unit
Decimal UnitPrice
Int32 InvoiceLineNumber
Int32 CodingLineNumber
String TaxIndicator1
String TaxIndicator2
Boolean IsEnabled
String FreeText1
String FreeText2
String FreeText3
String FreeText4
String FreeText5
String Tag
String Raw

ListSupplierInvoiceLines
SupplierInvoiceLines

Get the lines of a supplier invoice details

Arguments

Name	Description	Default
messageStatus R		Fetched
messageId R

SQL Call

exec MediusFlow.ListSupplierInvoiceLines 'test'
select * from MediusFlow.SupplierInvoiceLines where arg1 = 'test'

Http Call

/bsc/mediusflow/listsupplierinvoicelines

Output Columns

String correlationKey
Int32 documentId
Int32 lineNumber
String ItemDescription
String ItemNumber
Decimal quantity
String quantityUnit
Decimal unitPrice
Decimal amount
Boolean customField_Boolean1
Boolean customField_Boolean2
Boolean customField_Boolean3
Boolean customField_Boolean4
Boolean customField_Boolean5
Decimal customField_Numeric1
Decimal customField_Numeric2
Decimal customField_Numeric3
Decimal customField_Numeric4
Decimal customField_Numeric5
String customField_Text1
String customField_Text2
String customField_Text3
String customField_Text4
String customField_Text5
DateTime customField_DateTime1
DateTime customField_DateTime2
DateTime customField_DateTime3
DateTime customField_DateTime4
DateTime customField_DateTime5
String Tag
String raw

ListSupplierInvoiceMessages
SupplierInvoiceMessages

Returns the supplier invoice messages. Wraps the SupplierInvoiceInvoices API call. details

Arguments

Name	Description	Default
messageStatus R		Posted
tag		FINAL
correlationKeyFilter

SQL Call

exec MediusFlow.ListSupplierInvoiceMessages 'Posted'
select * from MediusFlow.SupplierInvoiceMessages where messageStatus = 'Posted'

Http Call

/bsc/mediusflow/listsupplierinvoicemessages

Output Columns

Int32 messageId
String url
String messageStatus
String tag
String correlationKeyFilter
String raw

ListSupplierInvoicePoLines
SupplierInvoicePoLines

Return a list of PO lines for an invoice details

Arguments

Name	Description	Default
messageStatus R		Fetched
messageId R

SQL Call

exec MediusFlow.ListSupplierInvoicePoLines 'test'
select * from MediusFlow.SupplierInvoicePoLines where arg1 = 'test'

Http Call

/bsc/mediusflow/listsupplierinvoicepolines

Output Columns

String correlationKey
Int32 documentId
Int32 lineNumber
String purchaseOrderNumber
String purchaseOrderNumber2
String purchaseOrderLineNumber
String itemNumber
String itemDescription
Decimal conversionFactor
Decimal quantity
String unit
Decimal unitPrice
String reference
String orderType
Boolean isTwoWayMatch
String externalSystemId
String Raw

UpdateSupplierInvoiceMessages

Updates the status for a supplier invoice message. details

Arguments

Name	Description	Default
messageStatus R		Posted
messageId R
newStatus R		Fetched

SQL Call

exec MediusFlow.UpdateSupplierInvoiceMessages 'test'

Http Call

/bsc/mediusflow/updatesupplierinvoicemessages

Output Columns

This call does not return data.

UpdateSupplierInvoiceVoucher

Updates the voucher information for a supplier invoice message. details

Arguments

Name	Description	Default
correlationKey R
voucherId R
voucherDate R

SQL Call

exec MediusFlow.UpdateSupplierInvoiceVoucher ';;;;;;'

Http Call

/bsc/mediusflow/updatesupplierinvoicevoucher

Output Columns

This call does not return data.

AddDimensionValueImportBatch
DimensionValueImportBatch

This method allows the client to send an xml batch of dimension items that will be imported by the Mediusflow master data import queue. The dimension values have company as a mandatory prerequisite. details

Arguments

Name	Description	Default
batchXml R
importId

SQL Call

exec MediusFlow.AddDimensionValueImportBatch 'test'
insert MediusFlow.DimensionValueImportBatch (

Http Call

/bsc/mediusflow/adddimensionvalueimportbatch

Output Columns

String importId

AddPaymentTermImportBatch
PaymentTermImportBatch

This method allows the client to send an xml batch of payment term items that will be imported by the Mediusflow master data import queue. The payment terms values have company as a mandatory prerequisite. details

Arguments

Name	Description	Default
batchXml R
importId

SQL Call

exec MediusFlow.AddPaymentTermImportBatch 'test'

Http Call

/bsc/mediusflow/addpaymenttermimportbatch

Output Columns

String importId

AddRestrictionRulesImportBatch
RestrictionRulesImportBatch

Allows the client to send restriction rules that will be imported by data import queue. The Restriction rules have company prerequisite. details

Arguments

Name	Description	Default
batchXml R
importId

SQL Call

exec MediusFlow.AddRestrictionRuleImportBatch 'test'

Http Call

/bsc/mediusflow/addrestrictionrulesimportbatch

Output Columns

String importId

AddSupplierImportBatch
SupplierImportBatch

This method allows the client to send an xml batch of supplier items that will be imported by the Mediusflow master data import queue. The supplier values have company as a mandatory prerequisite. details

Arguments

Name	Description	Default
batchXml R
importId

SQL Call

exec MediusFlow.AddSupplierImportBatch 'test'

Http Call

/bsc/mediusflow/addsupplierimportbatch

Output Columns

String importId

GetDimensionValueImportBatchStatus
DimensionValueImportBatchStatus

Gets the status of an imported dimension value batch details

Arguments

Name	Description	Default
importId

SQL Call

exec MediusFlow.GetDimensionValueImportBatchStatus 'guid'
select * from MediusFlow.DimensionValueImportBatchStatus where importId = 'guid'

Http Call

/bsc/mediusflow/getdimensionvalueimportbatchstatus

Output Columns

String state
String details
Int32 itemsCount
Int32 itemsSaved
Boolean isSuccessful
String errorMessage
String error_externalSystemId
String error_validationMessage
String error_validationTag
String queueItemId
String importId
String raw

GetPaymentTermImportBatchStatus
PaymentTermImportBatchStatus

Gets the status of an imported payment terms batch details

Arguments

Name	Description	Default
importId

SQL Call

exec MediusFlow.GetPaymentTermImportBatchStatus 'guid'
select * from MediusFlow.PaymentTermImportBatchStatus where importId = 'guid'

Http Call

/bsc/mediusflow/getpaymenttermimportbatchstatus

Output Columns

String state
String details
Int32 itemsCount
Int32 itemsSaved
Boolean isSuccessful
String errorMessage
String error_externalSystemId
String error_validationMessage
String error_validationTag
String queueItemId
String importId
String raw

GetRestrictionRulesImportBatchStatus
RestrictionRulesImportBatchStatus

Gets the status of an imported restriction rules batch details

Arguments

Name	Description	Default
importId

SQL Call

exec MediusFlow.GetRestrictionRulesImportBatchStatus 'guid'
select * from MediusFlow.RestrictionRulesImportBatchStatus where importId = 'guid'

Http Call

/bsc/mediusflow/getrestrictionrulesimportbatchstatus

Output Columns

String state
String details
Int32 itemsCount
Int32 itemsSaved
Boolean isSuccessful
String errorMessage
String error_externalSystemId
String error_validationMessage
String error_validationTag
String queueItemId
String importId
String raw

GetSupplierImportBatchStatus
SupplierImportBatchStatus

Gets the status of an imported suppliers batch details

Arguments

Name	Description	Default
importId

SQL Call

exec MediusFlow.GetSupplierImportBatchStatus 'guid'
select * from MediusFlow.SupplierImportBatchStatus where importId = 'guid'

Http Call

/bsc/mediusflow/getsupplierimportbatchstatus

Output Columns

String state
String details
Int32 itemsCount
Int32 itemsSaved
Boolean isSuccessful
String errorMessage
String error_externalSystemId
String error_validationMessage
String error_validationTag
String queueItemId
String importId
String raw

AddPaymentLine

Add a PaymentLine to an uncommited PaymentInformation item using its uid details

Arguments

Name	Description	Default
uid
Date R
Amount R
Status R
Method R
Identifier R
ExternalIdentifier
AdditionalInformation

SQL Call

exec MediusFlow.AddPaymentLine '{PaymentInformation guid}', ...

Http Call

/bsc/mediusflow/addpaymentline

Output Columns

This call does not return data.

CommitPaymentInformation

Send PaymentInformation to MediusFlow details

Arguments

Name	Description	Default
uid

SQL Call

exec MediusFlow.CommitPaymentInfomation

Http Call

/bsc/mediusflow/commitpaymentinformation

Output Columns

String result

CreatePaymentInformation

Create an uncommitted PaymentInformation item details

Arguments

Name	Description	Default
uid
Date R
SupplierId R
CompanyId R
InvoiceNumber R
CustomField_Boolean1
CustomField_Boolean2
CustomField_Boolean3
CustomField_Boolean4
CustomField_Boolean5
CustomField_Numeric1
CustomField_Numeric2
CustomField_Numeric3
CustomField_Numeric4
CustomField_Numeric5
CustomField_Text1
CustomField_Text2
CustomField_Text3
CustomField_Text4
CustomField_Text5
CustomField_DateTime1
CustomField_DateTime2
CustomField_DateTime3
CustomField_DateTime4
CustomField_DateTime5

SQL Call

exec MediusFlow.CreatePaymentInformation

Http Call

/bsc/mediusflow/createpaymentinformation

Output Columns

This call does not return data.

DeleteUncommittedPaymentInformation
UncommittedPaymentInformation

Delete one or all uncommited PaymentInformation items details

Arguments

Name	Description	Default
uid

SQL Call

exec MediusFlow.DeleteUncommittedPaymentInformation    -- delete all uncommitted PaymentInformation items
delete from MediusFlow.DeleteUncommittedPaymentInformation    -- delete all uncommitted PaymentInformation items

Http Call

/bsc/mediusflow/deleteuncommittedpaymentinformation

Output Columns

This call does not return data.

ListUncommittedPaymentInformation
UncommittedPaymentInformation

List uncommitted PaymentInformation items details

Arguments

SQL Call

exec MediusFlow.ListUncommittedPaymentInformation
select * from  MediusFlow.UncommittedPaymentInformation

Http Call

/bsc/mediusflow/listuncommittedpaymentinformation

Output Columns

String uid	Unique identifier used to add PaymentLines and later call CommitPaymentInformation
DateTime Date
String CompanyId
String SupplierId
String InvoiceNumber
Boolean CustomField_Boolean1
Boolean CustomField_Boolean2
Boolean CustomField_Boolean3
Boolean CustomField_Boolean4
Boolean CustomField_Boolean5
Decimal CustomField_Numeric1
Decimal CustomField_Numeric2
Decimal CustomField_Numeric3
Decimal CustomField_Numeric4
Decimal CustomField_Numeric5
String CustomField_Text1
String CustomField_Text2
String CustomField_Text3
String CustomField_Text4
String CustomField_Text5
DateTime CustomField_DateTime1
DateTime CustomField_DateTime2
DateTime CustomField_DateTime3
DateTime CustomField_DateTime4
DateTime CustomField_DateTime5

ListUncommittedPaymentLines
UncommittedPaymentLines

List uncommitted PaymentLines details

Arguments

SQL Call

exec MediusFlow.ListUncommittedPaymentLines
select * from MediusFlow.UncommittedPaymentLines

Http Call

/bsc/mediusflow/listuncommittedpaymentlines

Output Columns

String uid	Unique identifier of a PaymentInformation item to add a PaymentLine. Leave null to use the most recent PaymentInformation uid.
DateTime Date
Decimal Amount
String Status
String Method
String Identifier
String ExternalIdentifier
String AdditionalInformation

CreateProxyServer

Create a new or updates an existing MediusFlow proxy server details

Arguments

Name	Description	Default
name R
configName
prefix R
autoStart		True
start		True
targetUrl
companyCodes
dbConnStr
jsonTriggers

SQL Call

exec MediusFlow.CreateProxyServer 'test'

Http Call

/bsc/mediusflow/createproxyserver

Output Columns

This call does not return data.

CreateProxyTrigger

Create a new or updates an existing MediusFlow proxy server trigger details

Arguments

Name	Description	Default
proxyName R
triggerName R
httpMethod R
urlPattern R
sqlCall R
jsonPathExistence
value
value2
value3
value4
value5

SQL Call

exec MediusFlow.CreateProxyTrigger 'test'

Http Call

/bsc/mediusflow/createproxytrigger

Output Columns

This call does not return data.

DeleteProxyServer

Delete a MediusFlow proxy server details

Arguments

Name	Description	Default
name R
force		False

SQL Call

exec MediusFlow.DeleteProxyServer 'test'

Http Call

/bsc/mediusflow/deleteproxyserver

Output Columns

This call does not return data.

DeleteProxyTrigger

Delete a MediusFlow proxy server trigger details

Arguments

Name	Description	Default
proxyName R
triggerName R

SQL Call

exec MediusFlow.DeleteProxyTrigger 'proxy', 'trigger'

Http Call

/bsc/mediusflow/deleteproxytrigger

Output Columns

This call does not return data.

ListProxyServers
ProxyServers

List the status and definition of configured proxy servers. details

Arguments

SQL Call

exec MediusFlow.ListProxyServers 'test'
select * from MediusFlow.ProxyServers where arg1 = 'test'

Http Call

/bsc/mediusflow/listproxyservers

Output Columns

String Name
String Prefix
Boolean AutoStart
String TargetUrl
String CompanyCodes
String dbConnStr
String triggers
Boolean IsRunning
Int64 RequestsRx
Int64 RequestsProxied
Int64 RequestsFailed
DateTime LastRequestFailure
String LastRequestFailureEx
Int64 TriggersFired
Int64 TriggersFailed
DateTime LastTriggerFailure
String LastTriggerFailureName
String LastTriggerFailureEx
DateTime StartTime
String UpTime
DateTime StopTime
String DownTime

ListProxyTriggers
ProxyTriggers

Return a list of MediusFlow proxy server triggers details

Arguments

SQL Call

exec MediusFlow.ListProxyTriggers
select * from MediusFlow.ProxyTriggers

Http Call

/bsc/mediusflow/listproxytriggers

Output Columns

String proxyName	Name of an existing proxy definition.
String triggerName	Name for this trigger.
String httpMethod	HTTP Verb: GET, POST, PUT, or DELETE.
String urlPattern	URL LIKE pattern to match.
String sqlCall	SQL stored procedure or SQL statement to call upon match. Available replacement parameters to use for SQL statements: {{keyWord}} (nvarchar(30)), {{httpVerb}} (nvarchar(30)), {{url}} (varchar(800)), {{companyId}} (nvarchar(40)), {{messageId}} (int), {{messageStatus}} (nvarchar(30)), {{orderIdentifier}} (nvarchar(200)), {{correlationKey}} (nvarchar(500)), {{documentId}} (int), {{value}} (nvarchar(max)), {{value2}} (nvarchar(max), {{value3}} (nvarchar(max), {{value4}} (nvarchar(max), and {{value5}} (nvarchar(max). Stored procs/statements are called using the dbConnStr argument value of the proxy definition. When the proxy gets a match on a Medius JSON REST verb and query pattern the specified database store procedure/statement is called and passes the trigger aforementioned SQL variables.
String jsonPathExistence	JsonPath to check within REST content for element existence. For example, $.codingLines[?(@.tag=='FreightCost')]. For more details on JsonPath syntax and an online tester please visit https://www.newtonsoft.com/json/help/html/SelectToken.htm, https://github.com/json-path/JsonPath, or https://jsonpath.com/.
String value	Optional value to be extracted and passed to the SQL store procedure/statement. For example, $[?(@.invoice.originalDocumentType==''ORDER_BASED'')]..invoiceLines[?(@.itemNumber==''FreightCost'')].amount. For more details on JsonPath syntax and an online tester please visit https://www.newtonsoft.com/json/help/html/SelectToken.htm, https://github.com/json-path/JsonPath, or https://jsonpath.com/.
String value2	Optional value to be extracted and passed to the SQL store procedure/statement. For example, $[?(@.invoice.originalDocumentType==''ORDER_BASED'')]..invoiceLines[?(@.itemNumber==''FreightCost'')].amount. For more details on JsonPath syntax and an online tester please visit https://www.newtonsoft.com/json/help/html/SelectToken.htm, https://github.com/json-path/JsonPath, or https://jsonpath.com/.
String value3	Optional value to be extracted and passed to the SQL store procedure/statement. For example, $[?(@.invoice.originalDocumentType==''ORDER_BASED'')]..invoiceLines[?(@.itemNumber==''FreightCost'')].amount. For more details on JsonPath syntax and an online tester please visit https://www.newtonsoft.com/json/help/html/SelectToken.htm, https://github.com/json-path/JsonPath, or https://jsonpath.com/.
String value4	Optional value to be extracted and passed to the SQL store procedure/statement. For example, $[?(@.invoice.originalDocumentType==''ORDER_BASED'')]..invoiceLines[?(@.itemNumber==''FreightCost'')].amount. For more details on JsonPath syntax and an online tester please visit https://www.newtonsoft.com/json/help/html/SelectToken.htm, https://github.com/json-path/JsonPath, or https://jsonpath.com/.
String value5	Optional value to be extracted and passed to the SQL store procedure/statement. For example, $[?(@.invoice.originalDocumentType==''ORDER_BASED'')]..invoiceLines[?(@.itemNumber==''FreightCost'')].amount. For more details on JsonPath syntax and an online tester please visit https://www.newtonsoft.com/json/help/html/SelectToken.htm, https://github.com/json-path/JsonPath, or https://jsonpath.com/.
Int64 Hits
Int64 Errors
DateTime LastError
String LastErrorEx

StartProxyServer

Start a MediusFlow proxy server details

Arguments

Name	Description	Default
name

SQL Call

exec MediusFlow.StartProxy 'test'

Http Call

/bsc/mediusflow/startproxyserver

Output Columns

This call does not return data.

StopProxyServer

Stop a running MediusFlow proxy server details

Arguments

Name	Description	Default
name

SQL Call

exec MediusFlow.StopProxyServer 'test'

Http Call

/bsc/mediusflow/stopproxyserver

Output Columns

This call does not return data.

BLOGS AND VIDEOS

IN THE NEWS

OTHER

MediusFlow Adapter

Configuration Settings

Handlers

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call

Http Call

Output Columns

Arguments

SQL Call