Jump to

• Request
• Response

Mobile Workflow - Get Invoice Matching Dashboard Details

get

/services/private/Reim/dashboard

This service is used to gather performance information necessary to populate the mobile dashboard. This includes past or currently due invoices, automatch rate, supplier sites, and employees.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

Default Response

default response

Body ()

Root Schema : DashboardTransferRDO

Type: object

Show Source

• automatchRate: array array automatchRate
• date: string
• hyperMediaContent: object object IReSTHyperMediaContent
• invoicesCount: array array invoicesCount
• links: array array links
• totalEmployees: integer (int64)
• totalInvoices: integer (int64)
• totalSuppliers: integer (int64)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ILinkRDO"
            }
        },
        "date":{
            "type":"string"
        },
        "invoicesCount":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DashboardInvoiceCount"
            }
        },
        "automatchRate":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/DashboardAutomatchRate"
            }
        },
        "totalSuppliers":{
            "type":"integer",
            "format":"int64"
        },
        "totalEmployees":{
            "type":"integer",
            "format":"int64"
        },
        "totalInvoices":{
            "type":"integer",
            "format":"int64"
        },
        "hyperMediaContent":{
            "$ref":"#/components/schemas/IReSTHyperMediaContent"
        }
    }
}

Nested Schema : automatchRate

Type: array

Show Source

• Array of: object DashboardAutomatchRate

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DashboardAutomatchRate"
    }
}

Nested Schema : IReSTHyperMediaContent

Type: object

Show Source

• linkRDO: array array linkRDO

{
    "type":"object",
    "properties":{
        "linkRDO":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ILinkRDO"
            }
        }
    }
}

Nested Schema : invoicesCount

Type: array

Show Source

• Array of: object DashboardInvoiceCount

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/DashboardInvoiceCount"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object ILinkRDO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ILinkRDO"
    }
}

Nested Schema : DashboardAutomatchRate

Type: object

Show Source

• automatchedCount: integer (int64)
• description: string
• manualMatchedCount: integer (int64)

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "automatchedCount":{
            "type":"integer",
            "format":"int64"
        },
        "manualMatchedCount":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : linkRDO

Type: array

Show Source

• Array of: object ILinkRDO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ILinkRDO"
    }
}

Nested Schema : ILinkRDO

Type: object

Show Source

• href: string
• methodType: string
• rel: string
• type: string

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "methodType":{
            "type":"string"
        }
    }
}

Nested Schema : DashboardInvoiceCount

Type: object

Show Source

• daysOut: integer (int64)
• description: string
• matchedCount: integer (int64)
• unmatchedCount: integer (int64)

{
    "type":"object",
    "properties":{
        "description":{
            "type":"string"
        },
        "daysOut":{
            "type":"integer",
            "format":"int64"
        },
        "matchedCount":{
            "type":"integer",
            "format":"int64"
        },
        "unmatchedCount":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Back to Top