TestResults.io
  • What is TestResults.io
  • System Architecture
  • Regulated Markets
    • Health Care Industry
    • Financial Services Industry
  • What's new?
    • Update Instruction
      • Update of the Designer extension in Visual Studio
      • Update the Execution Engine
      • Update the Base- and Environment Models
    • Migration to new project file
  • Designer
    • Overview
    • First Steps
    • Installation
    • TestResults.io solution
    • The development environment
      • Tool Window Overview
        • Test Environments
          • Steps to configure a SUT VM
          • How to access files on the system under test
        • Remote Viewer
          • Control Mode
          • Capture Mode
          • Screen Editor
          • Capture Single Image
        • Screen Explorer
        • Test Case Designer
        • Image Explorer
        • API Testing
        • TestResults.io options
          • Engines
          • Servers
    • Test Cases
      • Adding Test Cases
      • Test Case structure
      • Simple Test Case (Example)
      • Executing your Test Case
      • Generating Test Containers
      • Publishing Test Cases
      • Execution Variables
    • Software Models
      • Adding SW Models
      • Referencing the Model in the Test Case
      • Generating Test Containers
      • Publishing SW Models
      • Screens and Screen Elements
        • Tables
        • Visual Sense
        • Custom Screen Elements
    • Installers
      • Adding Installers
      • Generating Test Containers
      • Publishing Installers
    • Automation Framework Reference
      • Attributes
      • Enumerations
      • Filters
        • IImageFilter Interface
        • Select
        • Resize
      • GlobalEngineParameters
      • ImageDetectionParameters
      • ImageReference
      • Interfaces
        • ITester Interface
          • ITester Methods
          • ITester Properties
        • ITestee Interface
          • ITestee Methods
        • IConnections Interface
          • IConnections Methods
          • IConnections Properties
        • IDebug Interface
        • IEngineResult
        • IHelpers Interface
        • IImageHelper Interface
          • IImageHelper Methods
        • IKeyboard Interface
          • IKeyboard Methods
        • IMouse Interface
          • IMouse Methods
          • IMouse Properties
        • IReport Interface
          • IReport Methods
        • ISUTConnection Interface
      • OcrEngineParameters
        • Best practise
        • IronOcrEngineParameters
        • LEADOcrEngineParameters
        • OcrEngineRelatedCharacters
        • OcrPreprocessingParameters
      • ResultRectangle
      • SutNotReadyException
      • TestStepAbortedException
    • FAQ
      • Two-factor authentication (2FA) and One Time Passwords (OTP)
      • Receive and verify Emails
      • Using Excel as test data source
      • Verify PDF Content
  • Portal
    • Overview
    • First Steps
    • User's Guide
      • Login
      • Projects
      • Dashboard
      • Test Cases
      • Software & Environments
      • Test Sets
      • Job Queue
      • Management
      • Notifications Summary
    • Automation Engineer's Guide
      • Test Automation Workflow
      • Automating a test case
      • Enabling Software & Environments
    • REST API Reference
      • Authentication
      • Projects
      • Test Sets
      • Test Cases
      • Test Plans
      • Test Reports
      • Files
      • Software
      • Environments
      • Untitled
      • Executions
      • Favorites
      • Statistics
      • User Management
      • Customer Management
      • Notifications
      • Configurations
      • Invoicing
  • Models
    • Overview
    • Base Model
      • BaseScreen
        • BaseScreen Properties
        • BaseScreen Methods
      • OnScreenElement
        • OnScreenElement Methods
        • OnScreenElement Properties
      • Primitives
        • Button
          • Button Methods
          • Button Properties
        • Checkbox
          • Checkbox Methods
        • ContextMenu
          • ContextMenu Methods
          • ContextMenu Properties
        • Dropdown
          • Dropdown Methods
          • Dropdown Properties
        • DropdownMenu
          • DropdownMenu Methods
          • DropdownMenu Properties
        • GenericScroller
          • GenericScroller Methods
          • GenericScroller Properties
        • HorizontalScroller
        • IconButton
          • IconButton Properties
        • Label
        • LabelWithButton
          • LabelWithButton Properties
        • LabelWithCheckbox
          • LabelWithCheckbox Properties
        • LabelWithValue
          • LabelWithValue Methods
          • LabelWithValue Properties
        • PwTextBox
          • PwTextBox Methods
        • TextBox
          • TextBox Methods
          • TextBox Properties
        • Tables and lists
          • Column
            • Column Methods
            • Column Properties
          • ItemList
            • ItemList Methods
            • ItemList Properties
          • Row
            • Row Methods
            • Row Properties
          • TableBase
            • TableBase Methods
            • TableBase Properties
        • LabelWithElementBase
          • LabelWithElementBase Properties
      • Enumerations
      • Extensions
        • EngineResultExtensions Methods
        • EnumExtensions Methods
        • ReportExtensions Methods
        • StringExtensions Methods
        • TesterConnectionExtensions Methods
        • TesterDebugExtensions Methods
        • TesterHelperExtensions Methods
        • TesterMouseExtensions Methods
        • TesterOnScreenElementExtensions
        • TesterSelectExtensions Methods
      • Helper Classes
        • BaseModelHelpers
          • BaseModelHelpers Methods
          • BaseModelHelpers Properties
        • Attributes for Designer
        • ListHelpers
      • Exceptions
        • ElementNotFoundException
        • InteractionFailedException
        • ScreenNotFoundException
      • Interfaces
        • IAppBasics Interface
          • IAppBasics Methods
          • IAppBasics Properties
        • IBrowser
        • ICommandLineWindow
        • IScroller Interface
          • IScroller Methods
          • IScroller Properties
        • ISutLocale Interface
          • ISutLocale Methods
          • ISutLocale Properties
        • ISystemHelpers
        • ISystemInteractions
        • IWindow
    • Environment Model
      • Windows
        • Screens
          • CmdWindow
            • CmdWindow Methods
            • CmdWindow Properties
          • FileDialog
            • FileDialog Methods
            • FileDialog Properties
          • FileExplorer
            • FileExplorer Properties
          • RunWindow
            • RunWindow Methods
            • RunWindow Properties
          • Window
            • Window Methods
            • Window Properties
        • SutLocale
          • SutLocale Methods
          • SutLocale Properties
        • SystemHelpers
          • SystemHelpers Methods
          • SystemHelpers Properties
        • SystemInteractions
        • WebBrowser
          • Browser
            • Browser Methods
            • Browser Properties
          • BrowserScroller
            • BrowserScroller Methods
            • BrowserScroller Properties
          • AuthenticationDialog
            • AuthenticationDialog Methods
            • AuthenticationDialog Properties
          • DownloadDialog
            • DownloadDialog Methods
            • DownloadDialog Properties
        • EnvironmentModel Enumerations
        • Interfaces
          • IWebAppBasics
            • IWebAppBasics Property
Powered by GitBook
On this page
  • Get available dates
  • Get Invoice details
  • Get Invoices
  • Get Invoice details by Test Case

Was this helpful?

  1. Portal
  2. REST API Reference

Invoicing

Get available dates

GET https://[customer].testresults.io/api/invoices

Gets the available dates for invoice selection.

Headers

Name
Type
Description

Authentication

string

Authentication token

{
  "AvailableDates": [
    {
      "Id": "75ca8a6f-7bca-4a6e-b14e-d4d2825eff43",
      "Year": 2018,
      "Month": 7
    },
    {
      "Id": "17719b42-3f06-49e7-b97e-a9418a7d5bd0",
      "Year": 2018,
      "Month": 11
    }
  ]
}

Get Invoice details

GET https://[customer].testresults.io/api/invoices/:iId

Gets Invoice details.

Path Parameters

Name
Type
Description

iId

string

Invoice ID

Headers

Name
Type
Description

Authentication

string

Authentication token

{
  "Customer": {
    "Address": null,
    "CustomerAccount": "TEST",
    "CostCenter": null
  },
  "MonthlyExecutionPackage": {
    "Hours": 0,
    "HourlyPriceInCent": 0,
    "CostsInCent": 1000
  },
  "Metadata": {
    "InvoiceNr": "1201800003",
    "Currency": null,
    "Tax": 0,
    "HourlyBasePrice": 0,
    "Year": 2018,
    "Month": 7,
    "InvoiceDate": "2019-01-17T23:00:00.0000000Z",
    "PayableTill": "2019-01-17T23:00:00.0000000Z"
  },
  "AutomatedSteps": [
    {
      "Id": "6904fc5d-e3b7-4427-83ff-df0fe3708144",
      "Name": "TestProject #1",
      "TestPlans": [
        {
          "Id": null,
          "Identifier": "64b69a77-97c1-4224-83bc-0e05af901de1",
          "Name": "TEST-ABC-01",
          "TestPlanRevision": 1,
          "StepPriceInCent": 10000,
          "StepCount": 10,
          "CostsInCent": 100000
        },
        {
          "Id": null,
          "Identifier": "56bdebcf-316b-4dbd-bec8-f7164effcd15",
          "Name": "TEST-ABC-02",
          "TestPlanRevision": 2,
          "StepPriceInCent": 10000,
          "StepCount": 5,
          "CostsInCent": 100000
        },
        {
          "Id": null,
          "Identifier": "456a4718-cb31-4fa9-94ee-32cd57166cf6",
          "Name": "TEST-ABC-03",
          "TestPlanRevision": 99,
          "StepPriceInCent": 9000,
          "StepCount": 80,
          "CostsInCent": 720000
        }
      ]
    },
    {
      "Id": "a5ac657f-92e7-4741-8a32-ffdf0b35d274",
      "Name": "TestProject #2",
      "TestPlans": [
        {
          "Id": null,
          "Identifier": "b74a4ce1-8fd3-4e44-b77e-df3161b756fa",
          "Name": "TEST2-XYZ",
          "TestPlanRevision": 18,
          "StepPriceInCent": 10000,
          "StepCount": 12,
          "CostsInCent": 120000
        }
      ]
    }
  ],
  "Executions": [
    {
      "Id": "4707c6e0-7690-40c7-a671-43b0b92d05ac",
      "Name": "API TestProject2",
      "ExecutionSubjects": [
        {
          "Identifier": "1.2.0.3",
          "Name": "Bestest SW ever",
          "CostsInCent": 0,
          "ActualDurationInSeconds": 102,
          "EnvironmentCount": 1,
          "Factor": 1,
          "CalculatedDurationInSeconds": 102,
          "InvoicedDurationInSeconds": 0
        }
      ]
    },
    {
      "Id": "faeb2061-b449-4534-b5d8-6462286278f5",
      "Name": "Paint Demo Project_dev",
      "ExecutionSubjects": [
        {
          "Identifier": "1709",
          "Name": "Paint Build 2",
          "CostsInCent": 386,
          "ActualDurationInSeconds": 2288,
          "EnvironmentCount": 1,
          "Factor": 1,
          "CalculatedDurationInSeconds": 2288,
          "InvoicedDurationInSeconds": 1390
        }
      ]
    },
    {
      "Id": "f00d03ed-38d1-4c65-b42e-cb1ab768ff05",
      "Name": "TestResults.io Regression",
      "ExecutionSubjects": [
        {
          "Identifier": "1.0",
          "Name": "TestResults.io",
          "CostsInCent": 14417,
          "ActualDurationInSeconds": 51904,
          "EnvironmentCount": 1,
          "Factor": 1,
          "CalculatedDurationInSeconds": 51904,
          "InvoicedDurationInSeconds": 51904
        },
        {
          "Identifier": "dummy",
          "Name": "no installer",
          "CostsInCent": 0,
          "ActualDurationInSeconds": 0,
          "EnvironmentCount": 1,
          "Factor": 1,
          "CalculatedDurationInSeconds": 0,
          "InvoicedDurationInSeconds": 0
        }
      ]
    },
    {
      "Id": "a758de54-237c-4404-a7e6-e9c0432bb6f3",
      "Name": "Wool Playground",
      "ExecutionSubjects": [
        {
          "Identifier": "99.100",
          "Name": "TRIO Portal with new Base Framework",
          "CostsInCent": 39586,
          "ActualDurationInSeconds": 142513,
          "EnvironmentCount": 1,
          "Factor": 1,
          "CalculatedDurationInSeconds": 142513,
          "InvoicedDurationInSeconds": 142513
        },
        {
          "Identifier": "99.99",
          "Name": "TRIO Portal",
          "CostsInCent": 8696,
          "ActualDurationInSeconds": 31308,
          "EnvironmentCount": 1,
          "Factor": 1,
          "CalculatedDurationInSeconds": 31308,
          "InvoicedDurationInSeconds": 31308
        },
        {
          "Identifier": "pascals try",
          "Name": "TrioPortal Edg",
          "CostsInCent": 84,
          "ActualDurationInSeconds": 303,
          "EnvironmentCount": 1,
          "Factor": 1,
          "CalculatedDurationInSeconds": 303,
          "InvoicedDurationInSeconds": 303
        }
      ]
    }
  ],
  "AdditionalFees": null,
  "Discounts": null,
  "PayedAt": null
}

Get Invoices

GET https://[customer].testresults.io/api/invoices/:year/:month

Gets Invoices (all or accepted only) for selected year and month .

Path Parameters

Name
Type
Description

year

string

Year

month

string

Month

Query Parameters

Name
Type
Description

acceptedonly

boolean

Accepted flag

Headers

Name
Type
Description

Authentication

string

Authentication token

[
  {
    "Id": "e15bb36f-1cac-43d3-95b3-c3b66df0d998",
    "Name": "EnvironmentModel",
    "ExecutionSubjects": [
      {
        "Identifier": "Win",
        "Name": "Windows",
        "CostsInCent": 0,
        "ActualDurationInSeconds": 997,
        "EnvironmentCount": 1,
        "Factor": 1,
        "CalculatedDurationInSeconds": 997,
        "InvoicedDurationInSeconds": 997
      }
    ]
  },
  {
    "Id": "f00d03ed-38d1-4c65-b42e-cb1ab768ff05",
    "Name": "TestResults.io Regression",
    "ExecutionSubjects": [
      {
        "Identifier": "1.0",
        "Name": "TestResults.io",
        "CostsInCent": 0,
        "ActualDurationInSeconds": 10668,
        "EnvironmentCount": 1,
        "Factor": 1,
        "CalculatedDurationInSeconds": 10668,
        "InvoicedDurationInSeconds": 10668
      }
    ]
  }
]

Get Invoice details by Test Case

GET https://[customer].testresults.io/api/invoices/:year/:month/:tcId

Gets Invoice details by selected Test Case

Path Parameters

Name
Type
Description

year

string

Year

month

string

Month

tcId

string

Test Case ID

Headers

Name
Type
Description

Authentication

string

Authentication token

[
  {
    "ProjectName": "TestResults.io Regression",
    "SubjectIdentifier": "1.0",
    "SubjectName": "TestResults.io",
    "EnvironmentName": "Windows 10 Pro - IE",
    "ExecutionNumber": 255,
    "TestSetId": "6d7f68af-5f4d-40bd-a0ea-52758592e91f",
    "TestReportId": "d4674111-ef42-450c-90c1-ed1580aea56c",
    "FinishDateTime": "2019-05-02T02:58:32.6666667Z",
    "TestSetName": "Daily Regression",
    "TestCaseIdentifier": "02",
    "TestCaseName": "Extended Regression",
    "User": "triouser@progile.ch",
    "DurationInSeconds": 2744
  },
  {
    "ProjectName": "TestResults.io Regression",
    "SubjectIdentifier": "1.0",
    "SubjectName": "TestResults.io",
    "EnvironmentName": "Windows 10 Pro - IE",
    "ExecutionNumber": 256,
    "TestSetId": "6d7f68af-5f4d-40bd-a0ea-52758592e91f",
    "TestReportId": "c4c5881e-ff4c-4641-9d74-7aa7e4587d97",
    "FinishDateTime": "2019-05-03T02:49:51.4300000Z",
    "TestSetName": "Daily Regression",
    "TestCaseIdentifier": "02",
    "TestCaseName": "Extended Regression",
    "User": "triouser@progile.ch",
    "DurationInSeconds": 2226
  }
]
PreviousConfigurationsNextOverview

Last updated 6 years ago

Was this helpful?