Jump to

• Request
• Response

Mobile Workflow - Get Supplier Details

get

/services/private/Reim/supplier

This service is used to get past due and currently due invoices for a supplier site, along with performance information for the supplier site.

Request

Query Parameters

• supplierId(required): string

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 : SupplierDetailsRDO

Type: object

Show Source

• costDiscrepancyPercentage: number (double)
• costDiscrepancyTotal: integer (int64)
• hyperMediaContent: object object IReSTHyperMediaContent
• invoicesCount: array array invoicesCount
• links: array array links
• performanceDetail: object object SupplierPerformanceDetail
• quantityDiscrepancyPercentage: number (double)
• quantityDiscrepancyTotal: integer (int64)
• supplierId: string
• supplierName: string
• supplierScorecard: number (double)
• supplierScorecardMax: number (double)

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ILinkRDO"
            }
        },
        "supplierName":{
            "type":"string"
        },
        "supplierId":{
            "type":"string"
        },
        "supplierScorecard":{
            "type":"number",
            "format":"double"
        },
        "supplierScorecardMax":{
            "type":"number",
            "format":"double"
        },
        "invoicesCount":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/SupplierDetailsInvoiceCount"
            }
        },
        "costDiscrepancyTotal":{
            "type":"integer",
            "format":"int64"
        },
        "costDiscrepancyPercentage":{
            "type":"number",
            "format":"double"
        },
        "quantityDiscrepancyTotal":{
            "type":"integer",
            "format":"int64"
        },
        "quantityDiscrepancyPercentage":{
            "type":"number",
            "format":"double"
        },
        "performanceDetail":{
            "$ref":"#/components/schemas/SupplierPerformanceDetail"
        },
        "hyperMediaContent":{
            "$ref":"#/components/schemas/IReSTHyperMediaContent"
        }
    }
}

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 SupplierDetailsInvoiceCount

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

Nested Schema : links

Type: array

Show Source

• Array of: object ILinkRDO

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

Nested Schema : SupplierPerformanceDetail

Type: object

Show Source

• assignedTo: string
• automatchRate: integer (int64)
• automatchTotal: integer (int64)
• currencyCode: string
• numberOfInvoices: integer (int64)
• totalAmount: integer (int64)

{
    "type":"object",
    "properties":{
        "assignedTo":{
            "type":"string"
        },
        "numberOfInvoices":{
            "type":"integer",
            "format":"int64"
        },
        "totalAmount":{
            "type":"integer",
            "format":"int64"
        },
        "automatchTotal":{
            "type":"integer",
            "format":"int64"
        },
        "currencyCode":{
            "type":"string"
        },
        "automatchRate":{
            "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 : SupplierDetailsInvoiceCount

Type: object

Show Source

• daysOut: integer (int64)
• description: string
• invoiceCount: integer (int64)

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

Back to Top