{ "openapi": "3.1.0", "info": { "title": "Ropo One", "description": "REST API", "version": "1.0.0" }, "servers": [ { "url": "/rest", "description": "Ropo One" } ], "paths": { "/token": { "post": { "tags": [ "auth" ], "summary": "Get token", "operationId": "AuthTokenAction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthLogin" } } } }, "responses": { "201": { "description": "Successfull login. Token will expire in 2 hours", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthToken" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthError" } } } } }, "x-domain": [ "public" ] } }, "/contract": { "patch": { "tags": [ "contract" ], "summary": "Update a contract", "operationId": "updateContractAction", "requestBody": { "description": "JSON data with contract details.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractUpdateRequest" } } } }, "responses": { "200": { "description": "Returns success message if contract was succesfully updated.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContractUpdateRequest" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/control/incontrol/{govid}": { "get": { "tags": [ "control" ], "summary": "Search companies in control", "operationId": "ControlSearchAction", "parameters": [ { "name": "govid", "in": "path", "description": "Business Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Control" } } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] }, "post": { "tags": [ "control" ], "summary": "Add company to control", "operationId": "ControlAddAction", "parameters": [ { "name": "govid", "in": "path", "description": "Business Id", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlAddResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } } }, "security": [ { "bearerAuth": [] } ] }, "delete": { "tags": [ "control" ], "summary": "Delete company from control", "operationId": "ControlDeleteAction", "parameters": [ { "name": "govid", "in": "path", "description": "Business id", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Control disabled" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } } }, "security": [ { "bearerAuth": [] } ] } }, "/control/reportsbygovid/{govid}": { "get": { "tags": [ "control" ], "summary": "Search reports by businessid", "operationId": "ControlReportsbygovidAction", "parameters": [ { "name": "govid", "in": "path", "description": "Business Id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlReport" } } } } }, "400": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } }, "404": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/control/reportsbydate/{date}": { "get": { "tags": [ "control" ], "summary": "Search reports by date", "operationId": "ControlReportsByDateAction", "parameters": [ { "name": "date", "in": "path", "description": "Report date", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ControlReport" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/control/reports/{reportid}": { "get": { "tags": [ "control" ], "summary": "Get report", "operationId": "ControlReportAction", "parameters": [ { "name": "reportid", "in": "path", "description": "Id of report", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successfull operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlReportResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/control/reportspdf/{reportid}": { "get": { "tags": [ "control" ], "summary": "Get report in PDF-format", "operationId": "ControlReportPdfAction", "parameters": [ { "name": "reportid", "in": "path", "description": "Id of report", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Control report PDF encoded in base64", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlPdfDataResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ControlError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditdecision/read": { "get": { "tags": [ "creditdecision" ], "summary": "Get exiting decision", "operationId": "5b478c522a76e62a66968348b2e87884", "parameters": [ { "name": "timestamp", "in": "query", "description": "Decision timestamp found from created decision response data block", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Credit decision report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionReportResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditdecision": { "post": { "tags": [ "creditdecision" ], "summary": "Create new creditdecision", "operationId": "6e0d8255bc1a59890c7c48ca148cf820", "requestBody": { "description": "CreditDecisionReportRequest", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionReportRequest" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionReportResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditdecision/search": { "post": { "tags": [ "creditdecision" ], "summary": "Search from exiting decisions", "operationId": "1077ea5372c5b56943a3f3b9ce1422c4", "requestBody": { "description": "CreditDecisionReportRequest", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionReportRequest" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionSearchReportResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditdecision/browse": { "get": { "tags": [ "creditdecision" ], "summary": "Browse exiting decisions", "operationId": "ba7684de39041c6519fc2e3989d72f83", "parameters": [ { "name": "limit", "in": "query", "description": "Request item limit to be returned. Recommended values are 100 or 200, maximum is 1000.", "required": false, "schema": { "type": "integer" } }, { "name": "dir", "in": "query", "description": "Sort direction. Allowed values are 'ASC' or 'DESC'. ASC returns items from oldest to newest (default). DESC returns items from newest to oldest.", "required": false, "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "description": "Cursor for pagination to identify edge for next page. This value is provided in the 'response_metadata' object 'next_cursor' property.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionSearchReportResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditDecisionError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditinfo/search/{govid}/{querier_ssn}": { "get": { "tags": [ "creditinfo" ], "summary": "Show old credit queries", "operationId": "CreditInfoSearchAction", "parameters": [ { "name": "govid", "in": "path", "description": "Social security number OR Business id", "required": true, "schema": { "type": "string" } }, { "name": "querier_ssn", "in": "path", "description": "Querier sosial security number. This value can be empty in some cases.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CreditInfoReport" } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditinfopdf/{reportid}": { "get": { "tags": [ "creditinfo" ], "summary": "Get full report in PDF-format", "operationId": "CreditInfoReportPdfAction", "parameters": [ { "name": "reportid", "in": "path", "description": "Id of report", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Report PDF encoded in base64", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoPdfDataResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoError" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditinforating/{reportid}": { "get": { "tags": [ "creditinfo" ], "summary": "Get rating and riskclass from rating-report", "operationId": "CreditInfoReportRatingAction", "parameters": [ { "name": "reportid", "in": "path", "description": "Id of report", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Rating and riskclass from report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoRatingResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditinfopersoncreditrating/{reportid}": { "get": { "tags": [ "creditinfo" ], "summary": "Get credit rating from credit-report", "operationId": "CreditInfoReportCreditRatingAction", "parameters": [ { "name": "reportid", "in": "path", "description": "Id of report", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Credit rating from report", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoCreditRatingResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoError" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/creditinfo": { "post": { "tags": [ "creditinfo" ], "summary": "Make new credit query", "operationId": "CreditInfoNewAction", "requestBody": { "description": "CreditInfoRequest", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoRequest" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreditInfoCreatedResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/ibancalculator/{accountnum}": { "get": { "tags": [ "ibancalculator" ], "summary": "Change old accountnumbers to IBAN-format", "operationId": "IbanCalculatorIban", "parameters": [ { "name": "accountnum", "in": "path", "description": "old accountnumber", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IbanCalculatorResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IbanCalculatorError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs": { "get": { "tags": [ "jobs" ], "summary": "Get jobs", "operationId": "JobGetJobAction", "parameters": [ { "name": "jobid", "in": "query", "description": "Id of the job", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobJobInfo" } } } }, "401": { "description": "Unauthorized" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] }, "post": { "tags": [ "jobs" ], "summary": "Add bills", "operationId": "JobAddJobAction", "parameters": [ { "name": "DataIdentifier", "in": "header", "description": "Data identifier defined by customer for tracking purposes", "required": false, "schema": { "type": "string" } }, { "name": "DataTypeIdentifier", "in": "header", "description": "Data type identifier", "required": false, "schema": { "type": "string" } }, { "name": "Content-Type", "in": "header", "description": "Content type", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Job", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "401": { "description": "Unauthorized" }, "429": { "description": "Too many requests - Too many concurrent requests for this customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] }, "patch": { "tags": [ "jobs" ], "summary": "Modify existing bill data", "operationId": "JobPatchJobAction", "parameters": [ { "name": "jobid", "in": "query", "description": "Id of the job to modify [jobid or billnum is required]", "required": false, "schema": { "type": "integer" } }, { "name": "billnum", "in": "query", "description": "Billnum of the job to modify [jobid or billnum is required]", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON defining only the fields to modify. Currently supported: 'paydate', 'addaddress'.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDataSet" } } } }, "responses": { "200": { "description": "Successful operation" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/statusupdates": { "get": { "tags": [ "jobs" ], "summary": "Get jobs status update information", "operationId": "JobsGetStatusUpdatesAction", "parameters": [ { "name": "date", "in": "query", "description": "Date (YYYY-MM-DD) to define to get all status update of given day.", "required": false, "schema": { "type": "string" } }, { "name": "billnum", "in": "query", "description": "Invoice number. Response will contain all status updates for the invoice.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsStatusUpdatesResult" } } } }, "204": { "description": "No Content, No status updates to return" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsStatusUpdatesCommonErrorResult" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/pdf": { "get": { "tags": [ "jobs" ], "summary": "Get bill in pdf-format", "operationId": "JobsGetPdfAction", "parameters": [ { "name": "jobid", "in": "query", "description": "Id of the job [contractnum, billnum or jobid is required]", "required": false, "schema": { "type": "integer" } }, { "name": "billnum", "in": "query", "description": "Billnum of the job [contractnum, billnum or jobid is required]", "required": false, "schema": { "type": "string" } }, { "name": "contractnum", "in": "query", "description": "Contractnum of the job [contractnum, billnum or jobid is required]", "required": false, "schema": { "type": "string" } }, { "name": "documentdate", "in": "query", "description": "Document date of the job [also contractnum or billnum is required]", "required": false, "schema": { "type": "string" } }, { "name": "origdata", "in": "query", "description": "0 = current, 1 = original[default]", "required": false, "schema": { "type": "integer" } }, { "name": "documenttype", "in": "query", "description": "Documenttype for Joisto archive.", "required": false, "schema": { "type": "string" } }, { "name": "joistocolumn", "in": "query", "description": "Column name in Joisto archive (JobId, Laskunumero, Laskunro)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Returns PDF", "content": { "application/pdf": {} } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/opensalesinvoices": { "patch": { "tags": [ "jobs" ], "summary": "Modify existing bill data for multiple open invoices by customer and order number", "operationId": "patchOpenSalesInvoicesAction", "parameters": [ { "name": "custnum", "in": "query", "description": "Customer number of job(s) to modify", "required": true, "schema": { "type": "string" } }, { "name": "ordernumber", "in": "query", "description": "Order number of job(s) to modify", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "JSON defining only the fields to modify. Currently 'addaddress' is the only one supported.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDataSet" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobPatchOpenSalesInvoicesResponse" } } } }, "204": { "description": "No content (no jobs were updated)" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "403": { "description": "Forbidden (customer type mismatch)", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/deliverystatus": { "patch": { "tags": [ "jobs" ], "summary": "Update invoice delivery status", "operationId": "patchJobsDeliveryStatus", "requestBody": { "description": "JSON defining status udpate", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDeliveryStatusRequest" } } } }, "responses": { "200": { "description": "Successful operation" }, "204": { "description": "No content (no jobs were updated)" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/preview": { "post": { "tags": [ "jobs" ], "summary": "Preview of the invoice", "operationId": "JobPreviewJobAction", "parameters": [ { "name": "DataIdentifier", "in": "header", "description": "Data identifier defined by customer for tracking purposes", "required": false, "schema": { "type": "string" } }, { "name": "DataTypeIdentifier", "in": "header", "description": "Data type identifier", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Data sent. Can be JSON defined by the Job Model, but also mutually agreed custom data", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "responses": { "201": { "description": "Returns PDF", "headers": { "pdfname": { "description": "pdf filename", "schema": { "type": "string" } } }, "content": { "application/pdf": {} } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/localprint": { "post": { "tags": [ "jobs" ], "summary": "Print locally the invoice", "operationId": "JobLocalprintJobAction", "parameters": [ { "name": "DataIdentifier", "in": "header", "description": "Data identifier defined by customer for tracking purposes", "required": false, "schema": { "type": "string" } }, { "name": "DataTypeIdentifier", "in": "header", "description": "Data type identifier", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Data sent. Can be JSON defined by the Job Model, but also mutually agreed custom data", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Job" } } } }, "responses": { "201": { "description": "Returns PDF", "headers": { "pdfname": { "description": "pdf filename", "schema": { "type": "string" } } }, "content": { "application/pdf": {} } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/payment": { "post": { "tags": [ "jobs" ], "summary": "Add payment to existing job.", "operationId": "JobAddPaymentJobAction", "requestBody": { "description": "JobAddPayment", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAddPayment" } } } }, "responses": { "201": { "description": "Payment response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAddPaymentResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAddPaymentResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/creditnote": { "post": { "tags": [ "jobs" ], "summary": "Add credit note to existing job", "operationId": "JobAddCreditNoteJobAction", "requestBody": { "description": "JobAddCreditNote", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAddCreditNote" } } } }, "responses": { "201": { "description": "Credit note response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAddCreditNoteResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobAddCreditNoteResponse" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/transferconfirmation": { "get": { "tags": [ "jobs" ], "summary": "Send transfer report based on Batch ID", "operationId": "TransferConfirmationTransfer", "parameters": [ { "name": "batchid", "in": "query", "description": "Transferconfirmation batchid identifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } }, "404": { "description": "report not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResponseErrors" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/dispute": { "post": { "tags": [ "jobs" ], "summary": "Dispute a job", "operationId": "disputeJobAction", "parameters": [ { "name": "jobid", "in": "query", "description": "Job ID, required if invoice number not given.", "schema": { "type": "string" } }, { "name": "invoice_number", "in": "query", "description": "Invoice number, required if job ID not given.", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON data with dispute reason in description.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDisputeRequest" } } } }, "responses": { "200": { "description": "Returns success message if job was succesfully disputed.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDisputeResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/dispute/resolve": { "post": { "tags": [ "jobs" ], "summary": "Resolve a disputed job", "operationId": "resolveDisputeJobAction", "parameters": [ { "name": "jobid", "in": "query", "description": "Job ID, required if invoice_number not given.", "schema": { "type": "string" } }, { "name": "invoice_number", "in": "query", "description": "Invoice number, required if job ID not given.", "schema": { "type": "string" } } ], "requestBody": { "description": "JSON data with resolve reason in description.", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobResolveDisputeRequest" } } } }, "responses": { "200": { "description": "Returns success message if job was succesfully resolved.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobDisputeResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/jobs/findbyendcustomer": { "post": { "tags": [ "jobs" ], "summary": "Find open jobs by end customer SSN or customer number", "operationId": "JobsFindByEndCustomerAction", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsByEndCustomerRequest" } } } }, "responses": { "200": { "description": "Jobs found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/JobsByEndCustomerResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/online/paylink": { "get": { "tags": [ "paylink" ], "summary": "Get online payment link for a job", "operationId": "getOnlinePayLinkAction", "parameters": [ { "name": "billnum", "in": "query", "description": "Invoice number", "required": true, "schema": { "type": "string" } }, { "name": "callback_url", "in": "query", "description": "Callback URL to receive payment status updates", "required": true, "schema": { "type": "string" } }, { "name": "service", "in": "query", "description": "Payment service to use, e.g. 'tink', 'bank', etc.", "required": false, "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language for the payment link, defaults to system language", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PaylinkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/online/onlinelink": { "get": { "tags": [ "onlinelink" ], "summary": "Online link to MyRopo Job page", "operationId": "sendOnlineLinkToJobAction", "parameters": [ { "name": "billnum", "in": "query", "description": "Billnumber of the job", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OnlineLinkResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/product/stock": { "get": { "tags": [ "productstock" ], "summary": "Get customer warehouse stock balance", "operationId": "productStockAction", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStockResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProductStockError" } } } } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/receiverproposal": { "post": { "tags": [ "receiverproposal" ], "summary": "Add Receiver Proposals", "operationId": "addReceiverProposalAction", "parameters": [ { "name": "Encoding", "in": "header", "description": "Optional file encoding 'UTF-8' or 'ISO-8859-1'. Default encoding is 'iso-8859-1'", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "ReceiverProposal XML-string", "required": true, "content": { "application/xml": { "schema": { "type": "string" } } } }, "responses": { "201": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReceiverResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/telecomsubscription/event": { "post": { "tags": [ "telecomsubscription" ], "summary": "API interface for delivering telecom subscription events", "operationId": "telecomSubscriptionEventAction", "requestBody": { "description": "Details of the telecom subscription event", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TelecomSubscriptionEvent" } } } }, "responses": { "200": { "description": "Successful operation" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } }, "/usageplace/event": { "post": { "tags": [ "usageplace" ], "summary": "API interface for delivering disconnection / reconnection events", "operationId": "usageplaceEventAction", "requestBody": { "description": "Details of the usageplace", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageplaceEvent" } } } }, "responses": { "200": { "description": "Successful operation" }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/HttpApiProblem" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "bearerAuth": [] } ], "x-domain": [ "public" ] } } }, "components": { "schemas": { "AuthError": { "title": "AuthError", "description": "AuthError", "properties": { "errorId": { "type": "integer", "example": "400" }, "errorText": { "type": "string", "example": "Invalid credentials" } }, "type": "object" }, "AuthLogin": { "title": "AuthLogin", "description": "AuthLogin", "required": [ "cid", "apicode" ], "properties": { "cid": { "description": "Customer number", "type": "string", "example": "1000011" }, "apicode": { "description": "Apicode", "type": "string", "example": "password123" } }, "type": "object" }, "AuthToken": { "title": "AuthToken", "description": "AuthToken", "properties": { "token": { "type": "string", "example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ" } }, "type": "object" }, "ContractUpdateRequest": { "title": "ContractUpdateRequest", "description": "ContractUpdateRequest", "properties": { "data": { "$ref": "#/components/schemas/JobContract" } }, "type": "object" }, "Control": { "title": "Control", "description": "Control", "properties": { "controlId": { "type": "integer", "example": "2000015" }, "govId": { "type": "string", "example": "1234567-8" }, "startTime": { "type": "string", "example": "2017-02-09T13:07:00+02:00" }, "controlName": { "type": "string", "example": "Yritys Oy" }, "statusCode": { "type": "string", "example": "2" }, "statusText": { "type": "string", "example": "Waiting activation" } }, "type": "object" }, "ControlAddResponse": { "title": "ControlAddResponse", "description": "ControlAddResponse", "properties": { "controlId": { "type": "integer", "example": "2000000" }, "govId": { "type": "string", "example": "1234567-8" }, "startTime": { "type": "string", "example": "2017-02-09T13:07:00+02:00" }, "controlName": { "type": "string", "example": "Yritys Oy" }, "statusCode": { "type": "string", "example": "2" }, "statusText": { "type": "string", "example": "Waiting activation" } }, "type": "object" }, "ControlError": { "title": "ControlError", "description": "ControlError", "properties": { "errorId": { "type": "integer", "example": "400" }, "errorText": { "type": "string", "example": "Bad request" } }, "type": "object" }, "ControlPdfDataResponse": { "title": "ControlPdfDataResponse", "description": "ControlPdfDataResponse", "properties": { "data": { "type": "string", "format": "byte", "example": "base64encodeddata" } }, "type": "object" }, "ControlReport": { "title": "ControlReport", "description": "ControlReport", "properties": { "reportId": { "type": "integer", "example": "123" }, "controlId": { "type": "integer", "example": "2000000" }, "govId": { "type": "string", "example": "1234567-8" }, "controlName": { "type": "string", "example": "Yritys Oy" }, "datetime": { "type": "string", "example": "2017-02-09T13:07:00+02:00" } }, "type": "object" }, "ControlReportResponse": { "title": "ControlReportResponse", "description": "ControlReportResponse", "properties": { "reportId": { "type": "integer", "example": "123" }, "controlId": { "type": "integer", "example": "2000000" }, "timestamp": { "type": "string", "example": "2017-02-09T13:07:00+02:00" }, "control_govid": { "type": "string", "example": "1234567-8" }, "control_name": { "type": "string", "example": "Yritys Oy" }, "control_rating": { "type": "string", "example": "A" }, "control_paydex": { "type": "string", "example": "70" }, "control_ratingdate": { "type": "string", "example": "2017-02-09" }, "control_scoringchange": { "type": "string", "example": "" }, "control_ratingchange": { "type": "string", "example": "RAT" }, "control_namechange": { "type": "string", "example": "NIM" }, "control_newpaymentfault": { "type": "string", "example": "MHA" }, "control_newaccountingdetails": { "type": "string", "example": "TIL" }, "control_companydel": { "type": "string", "example": "LAK" }, "control_fusion": { "type": "string", "example": "FUU" }, "control_epr": { "type": "string", "example": "EPR" }, "control_prevrating": { "type": "string", "example": "C" }, "control_duns": { "type": "string", "example": "123456789" }, "control_receivinggovid": { "type": "string", "example": "1234567-8" }, "control_score": { "type": "string", "example": "80" }, "control_payment_code1": { "type": "string", "example": "YVK" }, "control_payment_date1": { "type": "string", "example": "2017-02-09" }, "control_payment_amount1": { "type": "integer", "example": "10" }, "control_payment_ref1": { "type": "string", "example": "" }, "control_payment_receiver1": { "type": "string", "example": "Yritys Oy" }, "control_payment_code2": { "type": "string", "example": "YVK" }, "control_payment_date2": { "type": "string", "example": "2017-02-09" }, "control_payment_amount2": { "type": "integer", "example": "10" }, "control_payment_ref2": { "type": "string", "example": "" }, "control_payment_receiver2": { "type": "string", "example": "Yritys Oy" }, "control_payment_code3": { "type": "string", "example": "YVK" }, "control_payment_date3": { "type": "string", "example": "2017-02-09" }, "control_payment_amount3": { "type": "integer", "example": "10" }, "control_payment_ref3": { "type": "string", "example": "" }, "control_payment_receiver3": { "type": "string", "example": "Yritys Oy" }, "control_payment_code4": { "type": "string", "example": "YVK" }, "control_payment_date4": { "type": "string", "example": "2017-02-09" }, "control_payment_amount4": { "type": "integer", "example": "10" }, "control_payment_ref4": { "type": "string", "example": "" }, "control_payment_receiver4": { "type": "string", "example": "Yritys Oy" }, "control_payment_code5": { "type": "string", "example": "YVK" }, "control_payment_date5": { "type": "string", "example": "2017-02-09" }, "control_payment_amount5": { "type": "integer", "example": "10" }, "control_payment_ref5": { "type": "string", "example": "" }, "control_payment_receiver5": { "type": "string", "example": "Yritys Oy" }, "control_payment_code6": { "type": "string", "example": "YVK" }, "control_payment_date6": { "type": "string", "example": "2017-02-09" }, "control_payment_amount6": { "type": "integer", "example": "10" }, "control_payment_ref6": { "type": "string", "example": "" }, "control_payment_receiver6": { "type": "string", "example": "Yritys Oy" }, "control_payment_code7": { "type": "string", "example": "YVK" }, "control_payment_date7": { "type": "string", "example": "2017-02-09" }, "control_payment_amount7": { "type": "integer", "example": "10" }, "control_payment_ref7": { "type": "string", "example": "" }, "control_payment_receiver7": { "type": "string", "example": "Yritys Oy" }, "control_payment_code8": { "type": "string", "example": "YVK" }, "control_payment_date8": { "type": "string", "example": "2017-02-09" }, "control_payment_amount8": { "type": "integer", "example": "10" }, "control_payment_ref8": { "type": "string", "example": "" }, "control_payment_receiver8": { "type": "string", "example": "Yritys Oy" }, "control_payment_code9": { "type": "string", "example": "YVK" }, "control_payment_date9": { "type": "string", "example": "2017-02-09" }, "control_payment_amount9": { "type": "integer", "example": "10" }, "control_payment_ref9": { "type": "string", "example": "" }, "control_payment_receiver9": { "type": "string", "example": "Yritys Oy" } }, "type": "object" }, "CreditDecisionCustomer": { "title": "CreditDecisionCustomer", "description": "CreditDecisionCustomer", "properties": { "name": { "description": "Customer name", "type": [ "string", "null" ], "example": "Corporation Ltd" }, "businessid": { "description": "Company businessid", "type": [ "string", "null" ], "example": "01234567" }, "ssn": { "description": "Person sosial security number", "type": [ "string", "null" ], "example": "010203-1234" } }, "type": "object" }, "CreditDecisionError": { "title": "CreditDecisionError", "description": "CreditDecisionError", "properties": { "errorId": { "type": "integer", "example": "400" }, "errorText": { "type": "string", "example": "Bad request" } }, "type": "object" }, "CreditDecisionMetadata": { "title": "CreditDecisionMetadata", "description": "CreditDecisionMetadata", "properties": { "next_cursor": { "description": "Cursor for pagination to identify edge for next page. This value is provided in the 'response_metadata' object 'next_cursor' property.", "type": "string", "example": "MjAyMS0wMi0wNFQwNzo0OTo0MC4yMDda" } }, "type": "object" }, "CreditDecisionModel": { "title": "CreditDecisionModel", "description": "CreditDecisionModel", "properties": { "name": { "description": "Model name", "type": "string", "example": "Yritysmalli (vakio)" }, "code": { "description": "Model code", "type": "string", "example": "YRVAK1" } }, "type": "object" }, "CreditDecisionProposal": { "title": "CreditDecisionProposal", "description": "CreditDecisionProposal", "properties": { "code": { "description": "Decision code. 0 = No, 1 = Consider, 2 = Yes", "type": "string", "example": "2" }, "text": { "description": "Decision described in text", "type": "string", "example": "Yes" }, "factor": { "type": "array", "items": { "$ref": "#/components/schemas/CreditDecisionReportFactor" } } }, "type": "object" }, "CreditDecisionReportData": { "title": "CreditDecisionReportData", "description": "CreditDecisionReportData", "properties": { "timestamp": { "description": "Decision creation timestamp in ISO8601 format", "type": "string", "example": "2021-03-09T06:09:45.470Z" }, "proposal": { "$ref": "#/components/schemas/CreditDecisionProposal" }, "customer": { "$ref": "#/components/schemas/CreditDecisionCustomer" }, "model": { "$ref": "#/components/schemas/CreditDecisionModel" } }, "type": "object" }, "CreditDecisionReportFactor": { "title": "CreditDecisionReportResponse", "description": "CreditDecisionReportResponse", "properties": { "code": { "description": "Factor code", "type": "string", "example": "041" }, "text": { "description": "Factor described in text.", "type": "string", "example": "Person has 10 payment defaults, which is 3 pcs." } }, "type": "object" }, "CreditDecisionReportRequest": { "title": "CreditDecisionReportRequest", "description": "CreditDecisionReportRequest", "required": [ "id" ], "properties": { "id": { "description": "Valid sosial security number or business id", "type": "string", "example": "010203-1234" }, "limit": { "description": "Request item limit to be returned. Recommended values are 100 or 200, maximum is 1000.", "type": "integer", "example": "1000" }, "dir": { "description": "Sort direction. Allowed values are 'ASC' or 'DESC'. ASC returns items from oldest to newest (default). DESC returns items from newest to oldest.", "type": "string", "example": "DESC" }, "cursor": { "description": "Cursor for pagination to identify edge for next page. This value is provided in the 'response_metadata' object 'next_cursor' property.", "type": "string", "example": "MjAyMS0wMi0wNFQwNzo0OTo0MC4yMDda" } }, "type": "object" }, "CreditDecisionReportResponse": { "title": "CreditDecisionReportResponse", "description": "CreditDecisionReportResponse", "properties": { "created_at": { "description": "Event creation timestamp in ISO8601 format", "type": "string", "format": "date", "example": "2019-08-12T14:36:00+00:00" }, "data": { "$ref": "#/components/schemas/CreditDecisionReportData" } }, "type": "object" }, "CreditDecisionSearchReportData": { "title": "CreditDecisionReportData", "description": "CreditDecisionReportData", "properties": { "timestamp": { "description": "Decision creation timestamp in ISO8601 format", "type": "string", "example": "2021-03-09T06:09:45.470Z" }, "proposal": { "$ref": "#/components/schemas/CreditDecisionProposal" }, "customer": { "$ref": "#/components/schemas/CreditDecisionCustomer" }, "model": { "$ref": "#/components/schemas/CreditDecisionModel" } }, "type": "object" }, "CreditDecisionSearchReportResponse": { "title": "CreditDecisionSearchReportResponse", "description": "CreditDecisionSearchReportResponse", "properties": { "created_at": { "description": "Event creation timestamp in ISO8601 format", "type": "string", "format": "date", "example": "2019-08-12T14:36:00+00:00" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CreditDecisionSearchReportData" } }, "metadata": { "oneOf": [ { "$ref": "#/components/schemas/CreditDecisionMetadata" }, { "type": "null" } ] } }, "type": "object" }, "CreditInfoCreatedResponse": { "title": "CreditInfoCreatedResponse", "description": "CreditInfoCreatedResponse", "properties": { "id": { "type": "integer", "example": "123123" } }, "type": "object" }, "CreditInfoCreditRatingResponse": { "title": "CreditInfoCreditRatingResponse", "description": "CreditInfoCreditRatingResponse", "properties": { "creditrating": { "type": "string", "example": "0" } }, "type": "object" }, "CreditInfoError": { "title": "CreditInfoError", "description": "CreditInfoError", "properties": { "errorId": { "type": "integer", "example": "400" }, "errorText": { "type": "string", "example": "Bad request" } }, "type": "object" }, "CreditInfoPdfDataResponse": { "title": "CreditInfoPdfDataResponse", "description": "CreditInfoPdfDataResponse", "properties": { "data": { "type": "string", "format": "byte", "example": "base64encodeddata" } }, "type": "object" }, "CreditInfoRatingResponse": { "title": "CreditInfoRatingResponse", "description": "CreditInfoRatingResponse", "properties": { "rating": { "type": "string", "example": "B" }, "riskclass": { "type": "integer", "example": "11" } }, "type": "object" }, "CreditInfoReport": { "title": "CreditInfoReport", "description": "CreditInfoReport", "properties": { "id": { "type": "integer", "example": "123" }, "name": { "type": "string", "example": "123" }, "govid": { "type": "string", "example": "1234567-8" }, "querytype": { "type": "string", "example": "creditplus" }, "queryname": { "type": "string", "example": "Luottotiedot + Yritysyhteydet" }, "datetime": { "type": "string", "example": "2017-02-09T13:07:00+02:00" }, "whodid": { "type": "string", "example": "John Smith" } }, "type": "object" }, "CreditInfoRequest": { "title": "CreditInfoRequest", "description": "CreditInfoRequest", "required": [ "govid", "creditinfo_reason", "creditinfo_status" ], "properties": { "govid": { "description": "Business Id or Social security number", "type": "string", "example": "2262509-5" }, "creditinfo_reason": { "description": "Reason for query", "type": "string", "enum": [ "1", "2", "3", "4", "5", "6", "7", "8", "9", "A", "B", "C" ], "example": "1" }, "creditinfo_status": { "description": "Type of report", "type": "string", "enum": [ "krbasic", "krplus", "krplus2", "credit", "creditcplus", "rating" ], "example": "krbasic" }, "querier_name": { "description": "Querier name", "type": "string", "example": "John Doe" }, "querier_ssn": { "description": "Querier sosial security number", "type": "string", "example": "111111-111C" } }, "type": "object" }, "Error": { "title": "Error", "description": "Error", "properties": { "Code": { "type": "integer", "example": "404" }, "Message": { "type": "string", "example": "Not Found" } }, "type": "object" }, "HttpApiProblem": { "title": "HttpApiProblem", "description": "HttpApiProblem", "properties": { "status": { "description": "The HTTP status code generated by the origin server for this occurrence of the problem", "type": [ "integer", "null" ] }, "type": { "description": "A URI reference that identifies the problem type", "type": [ "string", "null" ] }, "title": { "description": "A short, human-readable summary of the problem type", "type": [ "string", "null" ] }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem", "type": [ "string", "null" ] } }, "type": "object" }, "IbanCalculatorError": { "title": "IbanCalculatorError", "description": "IbanCalculatorError", "properties": { "errorId": { "type": "integer", "example": "400" }, "errorText": { "type": "string", "example": "Bad request" } }, "type": "object" }, "IbanCalculatorResponse": { "title": "IbanCalculatorResponse", "description": "IbanCalculatorResponse", "properties": { "iban": { "type": "string", "example": "FI2112345600000785" }, "bic": { "type": "string", "example": "HELSFIHH" } }, "type": "object" }, "Job": { "title": "Job", "description": "Job", "properties": { "datastream": { "$ref": "#/components/schemas/JobDataStream" } }, "type": "object" }, "JobAccountRow": { "title": "JobAccountRow", "description": "JobAccountRow", "required": [ "accountid", "vatamount", "netamount" ], "properties": { "accountid": { "description": "Account ID for the accounting of the company that uses the interface", "type": "integer", "example": "3000" }, "credit": { "description": "Accounting for the sales bill for the principals accounting", "type": [ "number", "null" ], "example": "100.00" }, "debit": { "description": "Accounting for the sales bill for the principals accounting", "type": [ "number", "null" ], "example": "100.00" }, "desc": { "description": "Explanation of the export line in the accounting of the sales bill", "type": [ "string", "null" ], "example": "Leivokset" }, "servicecode": { "description": "Cost centre", "type": [ "string", "null" ], "example": "0" }, "servicecode_name": { "description": "Cost centter name", "type": [ "string", "null" ], "example": "300" }, "netamount": { "description": "Total amount of the bill without VAT", "type": "number", "example": "120.01" }, "taxpr": { "description": "VAT percentage 0-100", "type": [ "number", "null" ], "example": "24.00" }, "vatamount": { "description": "Total VAT amount of the bill", "type": "number", "example": "27.62" }, "type": { "description": "Business type", "type": [ "string", "null" ], "example": "A12345" }, "type2": { "description": "Project number", "type": [ "string", "null" ], "example": "B12345" }, "type3": { "description": "Responsible unit", "type": [ "string", "null" ], "example": "C12345" }, "type4": { "description": "Business area number", "type": [ "string", "null" ], "example": "D12345" }, "type5": { "description": "Dimension data 5", "type": [ "string", "null" ], "example": "123" }, "type6": { "description": "Dimension data 6", "type": [ "string", "null" ], "example": "123" }, "type7": { "description": "Dimension data 7", "type": [ "string", "null" ], "example": "123" }, "type8": { "description": "Dimension data 8", "type": [ "string", "null" ], "example": "123" }, "type9": { "description": "Dimension data 9", "type": [ "string", "null" ], "example": "123" }, "type10": { "description": "Dimension data 10", "type": [ "string", "null" ], "example": "123" }, "kwh": { "description": "kWh", "type": [ "number", "null" ], "example": "123,10" }, "voucherbatch": { "description": "The voucher batch number in the principal's accounting.", "type": [ "string", "null" ], "example": "A123" }, "batch": { "description": "The batch of accounting.", "type": [ "string", "null" ], "example": "OLDLEDGER" }, "vatcode": { "description": "VAT code from Finvoice. 0 = tax free sale, 1 = with tax sale, 2 = tax free buy, 3 = with tax buy", "type": [ "integer", "null" ], "example": "1" } }, "type": "object" }, "JobAddAddress": { "title": "JobAddAddress", "description": "JobAddAddress", "properties": { "address": { "type": [ "string", "null" ], "example": "Kuninkaankatu 15" }, "city": { "type": [ "string", "null" ], "example": "KUOPIO" }, "addressaddline1": { "description": "Line above name", "type": [ "string", "null" ], "example": "Johto" }, "addressaddline2": { "description": "Line between receivers name and address", "type": [ "string", "null" ], "example": "PL 43" }, "addressaddline3": { "description": "Line between receivers name and address", "type": [ "string", "null" ], "example": "CO Mauno Mansikka" }, "addresstype": { "description": "1 = postitusosoite, 2 = toimitusosoite, 3 = laskutusosoite, 4 = rinnakkais, 5 = toissijainen velallinen, 6 = muu, 7 = kayttopaikka, 8 = toimittaja", "type": [ "number", "null" ], "example": "1" }, "person": { "type": [ "string", "null" ], "example": "Tauno Testaaja" }, "company": { "type": [ "string", "null" ], "example": "Toiminimi Testaaja" }, "addresscountry": { "type": [ "string", "null" ], "example": "FIN" }, "postcode": { "type": [ "string", "null" ], "example": "70100" }, "custnum": { "type": [ "string", "null" ], "example": "123456" }, "govid": { "description": "Identification of seller Business ID (Business Identity Code = Y-tunnus in Finnish or Persons social security number)", "type": [ "string", "null" ], "example": "123456-7" }, "vatid": { "description": "VAT number", "type": [ "string", "null" ], "example": "FI1234567" }, "customertype": { "description": "1=comppany, 2=person", "type": [ "integer", "null" ], "example": "1" }, "email": { "description": "Contact email", "type": [ "string", "null" ], "example": "name@domain.fi" }, "phone": { "description": "Contact phone", "type": [ "string", "null" ], "example": "+3581234567" }, "partytext": { "description": "Description of address", "type": [ "string", "null" ], "example": "Workshop" }, "partycode": { "description": "Business fields defined type code for address.", "type": [ "string", "null" ], "example": "xyz" }, "sitecode": { "description": "Code for address.", "type": [ "string", "null" ], "example": "123456" }, "contactperson": { "type": [ "string", "null" ], "example": "Liisa Assistentti" }, "countryname": { "type": [ "string", "null" ], "example": "Sweden" }, "ovt": { "description": "OrganisationUnitNumber", "type": [ "string", "null" ], "example": "00371234567800001" }, "department": { "type": [ "string", "null" ], "example": "Kuopio" }, "contactpersontitle": { "type": [ "string", "null" ], "example": "Salesmanager" }, "contactpersondepartment": { "type": [ "string", "null" ], "example": "Sales" } }, "type": "object" }, "JobAddCreditNote": { "title": "JobAddCreditNote", "description": "JobAddCreditNote", "required": [ "amount", "date" ], "properties": { "amount": { "description": "Amount of credit note", "type": "number", "example": "710.00" }, "billcode": { "description": "Reference of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)", "type": "string", "example": "123467" }, "billnum": { "description": "Billnum of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)", "type": "string", "example": "R123467" }, "jobid": { "description": "Id of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)", "type": "integer", "example": "123467" }, "date": { "description": "Date", "type": "string", "example": "2017-10-10" }, "type": { "description": "Credit note type", "type": "string", "example": "allocated" }, "creditnotebillnum": { "description": "Credit note invoice number", "type": "string", "example": "26251" }, "description": { "description": "Description of credit note", "type": "string", "example": "Capital amount increased due to agreement change." } }, "type": "object" }, "JobAddCreditNoteResponse": { "title": "JobAddCreditNoteResponse", "description": "JobAddCreditNoteResponse", "properties": { "jobid": { "description": "Id of job", "type": "integer", "example": "123456" }, "billnum": { "description": "Billnum of job", "type": "string", "example": "R12345" }, "billcode": { "description": "Reference of job", "type": "string", "example": "123456" }, "date": { "description": "Date of credit note", "type": "string", "example": "2017-10-10" }, "amount": { "description": "Amount of credit note", "type": "number", "example": "710.00" }, "statusid": { "description": "0 : UNDONE, 1 : FAIL, 2 : OLD, 8 : IGNORE, 10 : NOT FOUND, 11 : CANCELLED, 12 = OLD CANCEL.", "type": "number", "example": "1" }, "statustext": { "description": "additional information", "type": "number", "example": "Capital kirjattu" } }, "type": "object" }, "JobAddPayment": { "title": "JobAddPayment", "description": "JobAddPayment", "required": [ "amount", "paydate" ], "properties": { "amount": { "description": "Amount of payment", "type": "number", "example": "710.00" }, "billcode": { "description": "Reference of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)", "type": "string", "example": "123467" }, "billnum": { "description": "Billnum of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)", "type": "string", "example": "R123467" }, "jobid": { "description": "Id of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)", "type": "integer", "example": "123467" }, "paydate": { "description": "Date of payment", "type": "string", "example": "2017-10-10" }, "identifier": { "description": "Payment targeting identifier", "type": "string", "example": "insurance" }, "type": { "description": "Payment type", "type": "string", "example": "directpayment" }, "creditnotebillnum": { "description": "Credit note invoice number", "type": "string", "example": "26251" }, "description": { "description": "Description of payment", "type": "string", "example": "Capital amount increased due to agreement change." } }, "type": "object" }, "JobAddPaymentResponse": { "title": "JobAddPaymentResponse", "description": "JobAddPaymentResponse", "properties": { "jobid": { "description": "Id of job", "type": "integer", "example": "123456" }, "billnum": { "description": "Billnum of job", "type": "string", "example": "R12345" }, "billcode": { "description": "Reference of job", "type": "string", "example": "123456" }, "paydate": { "description": "Date of payment", "type": "string", "example": "2017-10-10" }, "amount": { "description": "Amount of payment", "type": "number", "example": "710.00" }, "capitalbefore": { "description": "Open capital before payment", "type": "number", "example": "710.00" }, "capitalafter": { "description": "Open capital after payment", "type": "number", "example": "0.00" }, "focusedtocapital": { "description": "Amount focused to opencapital", "type": "number", "example": "710.00" }, "interestbefore": { "description": "Amount before to interest", "type": "number", "example": "0.00" }, "interestafter": { "description": "Amount after to interest", "type": "number", "example": "0.00" }, "focusedtointerest": { "description": "Amount focused to interest", "type": "number", "example": "0.00" }, "noticefeebefore": { "description": "Amount after to customer notice fee", "type": "number", "example": "0.00" }, "noticefeeafter": { "description": "Amount before to customer notice fee", "type": "number", "example": "0.00" }, "focusedtonoticefee": { "description": "Amount focused to customer notice fee", "type": "number", "example": "0.00" }, "unfocused": { "description": "Unfocused amount", "type": "number", "example": "0.00" }, "statusid": { "description": "0 : UNDONE, 1 : FAIL, 2 : OLD, 3 : ROPO, 4 : ROPO Refund, 5 : CLOSE, 6 : OHISPAY, 8 : IGNORE, 9 : DIFFCID, 10 : NOT FOUND, 11 : CANCELLED. Only with value 6 Http-Responsecode is 201 other 400", "type": "number", "example": "6" }, "statustext": { "description": "additional information", "type": "number", "example": "Capital kirjattu" } }, "type": "object" }, "JobAllocated": { "title": "JobAllocated", "description": "JobAllocated", "required": [ "allocated", "billnum", "jobid" ], "properties": { "billnum": { "description": "Bill number of job.", "type": "string", "example": "R123467" }, "jobid": { "description": "Id of job.", "type": "integer", "example": "123467" }, "allocated": { "description": "Allocated amount of credit note", "type": "number", "example": "50" } }, "type": "object" }, "JobAllowance": { "title": "JobAllowance", "description": "JobAllowance", "required": [ "percent", "amount", "baseamount" ], "properties": { "freetext": { "description": "Information in text format", "type": [ "string", "null" ], "example": "Platinum customer discount" }, "reasoncode": { "description": "Check instructions from EU Norm BT-98", "type": [ "string", "null" ], "example": "XYZ" }, "percent": { "description": "Percent", "type": "number", "example": "10.0" }, "amount": { "description": "Amount excluding VAT", "type": "number", "example": "10.00" }, "vatamount": { "description": "VAT amount", "type": "number", "example": "10.00" }, "baseamount": { "description": "Base amount, excluding VAT", "type": "number", "example": "100.00" }, "vatcategorycode": { "description": "VAT code", "type": [ "string", "null" ], "example": "ABC" }, "vatratepercent": { "description": "VAT percent", "type": [ "number", "null" ], "example": "24" } }, "type": "object" }, "JobAttachment": { "title": "JobAttachment", "description": "JobAttachment", "properties": { "attachmentid": { "description": "Preloaded attachment from Ropo One", "type": [ "integer", "null" ], "example": "2519700" }, "attachmentfile": { "description": "Base64 encoded file", "type": [ "string", "null" ], "example": "JVBERi0xLjQNJeLjz9MNCjE" }, "attachmentname": { "description": "Name of attachment", "type": [ "string", "null" ], "example": "Attachment.pdf" }, "securityclass": { "description": "Security class of attachment.", "type": [ "string", "null" ], "example": "SEI01" }, "type": { "description": "Type of attachment. default = regular attachment, station = station insert, letter = payment control letter attachment, cover = attachment pdf use as cover page when printed to envelope", "type": [ "string", "null" ], "example": "cover" }, "jobid": { "description": "Jobid of attachement", "type": [ "integer", "null" ], "example": "123456789" } }, "type": "object" }, "JobBankInfo": { "title": "JobBankInfo", "description": "JobBankInfo", "properties": { "name": { "description": "Name of the bank", "type": "string", "example": "Nordea" }, "iban": { "description": "International Bank Account Number", "type": "string", "example": "FI1234345312312312" }, "bic": { "description": "Bank Identification Code", "type": "string", "example": "OKOYFIHH" }, "bban": { "description": "Basic Bank Account Number", "type": "string", "example": "1234345312312312" }, "bankgiro": { "description": "Bankgiro", "type": "string", "example": "123456789" }, "plusgirot": { "description": "Plusgirot", "type": "string", "example": "123456789" } }, "type": "object" }, "JobBreakdown": { "title": "JobBreakdown", "description": "JobBreakdown", "properties": { "billnum": { "description": "Laskunnumero", "type": "string", "example": "12345678" }, "origpaydate": { "description": "Original paydate", "type": "string", "example": "12.12.2018" }, "capital": { "description": "Total amount of original capital", "type": "number", "example": "710.00" }, "interest": { "description": "Total amount of interests", "type": "number", "example": "7.00" }, "expenses": { "description": "Total amount of expenses", "type": "number", "example": "50.00" }, "netamount": { "description": "Total amount of open capital without VAT", "type": "number", "example": "200.00" }, "opencapital": { "description": "Total amount of open capital", "type": "number", "example": "250.00" }, "title": { "description": "Breakdown title", "type": "string", "example": "Sähkö" }, "vatamount": { "description": "Total VAT amount of open capital", "type": "number", "example": "50.00" }, "subtaskids": { "description": "IDs of subtasks", "type": "string" }, "subtasks": { "type": "array", "items": { "$ref": "#/components/schemas/JobBreakdown" } }, "creditnotes": { "oneOf": [ { "$ref": "#/components/schemas/JobCreditNotes", "description": "List of end customers unallocated credit notes" }, { "type": "null" } ], "description": "List of end customers unallocated credit notes" }, "opencapitalwithoutcreditnotes": { "description": "Total amount of open capital without credit note allocations.", "type": "number", "example": "250.00" }, "overdueinterest": { "description": "Overdueinterestpercentage", "type": "number", "example": "50.00" } }, "type": "object" }, "JobCashDiscountRow": { "title": "JobCashDiscountRow", "description": "JobCashDiscountRow", "required": [ "discountamount", "discountdate", "discountpercent" ], "properties": { "discountamount": { "description": "The amount of cashiers discount in euros (Finland) or Swedish kronor (Sweden)", "type": "number", "example": "28.30" }, "discountbaseamount": { "description": "Base amount for discount calculation in euros (Finland) or Swedish kronor (Sweden)", "type": "number", "example": "28.30" }, "discountdate": { "description": "The last date of validity of the cashiers discount", "type": "string", "format": "date", "example": "2017-02-17" }, "discountpercent": { "description": "Percentage of the cashiers discount of the bill amount including VAT", "type": "number", "example": "2" }, "discountfreetext": { "description": "Text displayed on the bill received by the customer to notify the customer of the cashiers discount.", "type": [ "string", "null" ], "example": "10 pv -2%" } }, "type": "object" }, "JobClassification": { "title": "JobClassification", "description": "JobClassification", "properties": { "documenttype": { "description": "Type of the document", "type": [ "string", "null" ], "example": "GeneralNote" } }, "type": "object" }, "JobContract": { "title": "JobContract", "description": "JobContract", "required": [ "contract_no" ], "properties": { "contract_no": { "description": "Contract number", "type": "string", "example": "123456" }, "name": { "type": [ "string", "null" ], "example": "Network contract" }, "startdate": { "type": [ "string", "null" ], "example": "2017-06-01" }, "enddate": { "description": "Contract end date", "type": [ "string", "null" ], "example": "2018-06-01" }, "contractstatus": { "description": "Status of contract (active, closed, terminated)", "type": [ "string", "null" ], "example": "closed" }, "type": { "description": "Type of contract (insurance)", "type": [ "string", "null" ], "example": "insurance" }, "termination_date": { "description": "Contract termination date", "type": [ "string", "null" ], "example": "2022-06-01" }, "terminationterm": { "description": "Contract termination term. Number of days termination will be done.", "type": [ "integer", "null" ], "example": "14" }, "product": { "description": "Contract product name", "type": [ "string", "null" ], "example": "Home insurance" } }, "type": "object" }, "JobCreditNote": { "title": "JobCreditNote", "description": "JobCreditNote", "required": [ "amount", "date" ], "properties": { "amount": { "description": "Amount of credit note", "type": "number", "example": "710.00" }, "billnum": { "description": "Bill number of job.", "type": "string", "example": "R123467" }, "jobid": { "description": "Id of job.", "type": "integer", "example": "123467" }, "billdate": { "description": "Date", "type": "string", "example": "2017-10-10" }, "duedate": { "description": "Date", "type": "string", "example": "2017-10-10" }, "allocated": { "description": "Allocated amount of credit note", "type": "number", "example": "50" }, "unallocated": { "description": "Unallocated amount of credit note", "type": "number", "example": "50" }, "job_allocated": { "type": "array", "items": { "$ref": "#/components/schemas/JobAllocated" } } }, "type": "object" }, "JobCreditNotes": { "title": "JobCreditNotes", "description": "JobCreditNotes", "properties": { "creditnote": { "description": "List of credit invoices / notes", "type": "array", "items": { "$ref": "#/components/schemas/JobCreditNote" } } }, "type": "object" }, "JobCurrency": { "title": "JobEnergyContract", "description": "Jobs currency will be used currency balance calculations", "properties": { "source": { "description": "Source of currency. Job = when job is created, payment = when payment has arrived", "type": "string", "example": "job" }, "currency": { "description": "Original currency", "type": "string", "example": "DKK" }, "rate": { "description": "Rate of currency", "type": "number", "example": "1.501" }, "amount": { "description": "Original amount in target currency", "type": "number", "example": "1.001" }, "currency_date": { "description": "Date of currency.", "type": [ "string", "null" ], "example": "2017-06-01" } }, "type": "object" }, "JobDataSet": { "title": "JobDataSet", "description": "JobDataSet", "required": [ "jobtype", "address", "city", "customertype" ], "properties": { "accountdate": { "description": "Account date", "type": [ "string", "null" ], "format": "date", "example": "2017-10-10" }, "address": { "description": "The street address of the recipient", "type": "string", "example": "Satamakatu 123" }, "addressaddline1": { "description": "The first additional line of the address card, printed above the name of the recipient", "type": [ "string", "null" ], "example": "Johto" }, "addressaddline2": { "description": "The second additional line of the address card, printed between the name and the street address", "type": [ "string", "null" ], "example": "PL 43" }, "addressaddline3": { "description": "Line between receivers name and the street address", "type": [ "string", "null" ], "example": "CO Mauno Mansikka" }, "addresscountry": { "description": "The home country of the recipient", "type": [ "string", "null" ], "example": "FIN" }, "advancepayment": { "description": "Amount of advancepayment", "type": [ "number", "null" ], "example": "15.00" }, "amount": { "description": "Total amount of the bill", "type": [ "number", "null" ], "example": "19.96" }, "billcode": { "description": "Reference number or message, by which the payment is delivered to the biller", "type": [ "string", "null" ], "example": "4349" }, "billdate": { "description": "The date of the bill", "type": [ "string", "null" ], "format": "date", "example": "2017-01-01" }, "xmldate": { "description": "The date of the bill on invoices or reminder date", "type": [ "string", "null" ], "format": "date", "example": "2017-01-01" }, "billnum": { "description": "The current number of the bill in the accounting books of the principal", "type": [ "string", "null" ], "example": "11213" }, "billtemplate": { "description": "The layout design of the bill template: CUSTOM, ECOM, BOBCAT, INC", "type": [ "string", "null" ], "example": "CUSTOM" }, "billtemplateid": { "description": "The layout id of the bill template.", "type": [ "integer", "null" ], "example": "123" }, "cashbill": { "description": "A cash bill is marked as paid directly: 1=cash bill", "type": [ "integer", "null" ], "example": "1" }, "checkbillnum": { "description": "Check if the bill number is unique 1=on, 0=off", "type": [ "integer", "null" ], "example": "1" }, "city": { "description": "The mailing location of the debtor", "type": "string", "example": "KUOPIO" }, "claimtext": { "description": "Reason for Recall and Recourse.", "type": [ "string", "null" ], "example": "Unpaid bill 123456." }, "collectionprocess": { "description": "Type of receivable. Influences the collection process", "type": [ "string", "null" ], "example": "AUTO" }, "color": { "description": "1=color, 0=black and white", "type": [ "integer", "null" ], "example": "0" }, "collectioninvoice": { "description": "1=Collection invoice, 0=Single invoice", "type": [ "integer", "null" ], "example": "0" }, "company": { "description": "Name of the corporate customer", "type": "string", "example": "Matin konepaja Oy" }, "contactperson": { "description": "Contact person", "type": [ "string", "null" ], "example": "Liisa Liukaas" }, "contactpersontitle": { "description": "Contact person title", "type": [ "string", "null" ], "example": "Assistentti" }, "contactpersondepartment": { "description": "Contact person department", "type": [ "string", "null" ], "example": "Customer service" }, "country": { "description": "Country where the corporate customer is registered", "type": [ "string", "null" ], "example": "FIN" }, "countryname": { "description": "Recipients country name", "type": [ "string", "null" ], "example": "Finland" }, "currency": { "description": "Currency of job", "type": [ "string", "null" ], "example": "EUR" }, "custnum": { "description": "The customer number of the customer in the principals system", "type": [ "string", "null" ], "example": "1022" }, "customerid": { "description": "The customer number of the customer in Ropo One", "type": [ "integer", "null" ], "example": "1022" }, "customertype": { "description": "Type of customer: 1=company, 2=natural person", "type": "integer", "example": "1" }, "deliverydate": { "description": "Products delivery date on invoice or cover note.", "type": [ "string", "null" ], "format": "date", "example": "2017-01-24" }, "deliverymethod": { "description": "Products delivery method as text.", "type": [ "string", "null" ], "example": "Kiitolinja" }, "deliveryterm": { "description": "Terms of delivery as text.", "type": [ "string", "null" ], "example": "NOK" }, "department": { "description": "Recipients department", "type": [ "string", "null" ], "example": "Sales" }, "doublesided": { "description": "0=singleside(default), 1=use doublesided bill", "type": [ "integer", "null" ], "example": "0" }, "email": { "description": "The e-mail address to which the bill is sent", "type": [ "string", "null" ], "example": "foobar@helloworld.com" }, "email2": { "description": "The second e-mail address to which the bill is sent", "type": [ "string", "null" ], "example": "foobar@helloworld.com" }, "evoice": { "description": "Finnish e-invoice address", "type": [ "string", "null" ], "example": "FI123578612717718" }, "evoiceint": { "description": "The code of the intermediary in the e-invoice", "type": [ "string", "null" ], "example": "NDEAFIHH" }, "finance": { "description": "1 = if funding applied from Ropo Finance.", "type": [ "integer", "null" ], "example": "0" }, "foreignamount": { "description": "Total amount of the bill in its original currency.", "type": [ "number", "null" ], "example": "123.32" }, "foreigncurrency": { "description": "TotalIdentifier of the currency used in the bill.", "type": [ "string", "null" ], "example": "SEK" }, "freetext": { "description": "Free text field at the end of the bill", "type": [ "string", "null" ], "example": "Kiitokset tilauksesta!" }, "govid": { "description": "The business ID (Y-tunnus) or personal identity code of the customer", "type": [ "string", "null" ], "example": "2262509-5" }, "jobtype": { "description": "Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service", "type": "integer", "example": "0" }, "language": { "description": "Language of the bill: eng, fin, swe, est", "type": [ "string", "null" ], "example": "fin" }, "model": { "description": "Make, cost centre in the customers accounting or other reference", "type": [ "string", "null" ], "example": "Malli tai merkki" }, "negvat": { "description": "1, if reverse VAT liability is used in the bill", "type": [ "integer", "null" ], "example": "1" }, "netamount": { "description": "Total amount of the bill without VAT", "type": [ "number", "null" ], "example": "16.10" }, "noticedate": { "description": "Date of the first payment notice.", "type": [ "string", "null" ], "format": "date", "example": "2017-03-24" }, "noticedate2": { "description": "Date of the second payment notice.", "type": [ "string", "null" ], "format": "date", "example": "2017-04-24" }, "noticedate3": { "description": "Date of the third payment notice.", "type": [ "string", "null" ], "format": "date", "example": "2017-05-24" }, "noticedate4": { "description": "Date of the fourth payment notice.", "type": [ "string", "null" ], "format": "date", "example": "2017-06-24" }, "noticefee": { "description": "Principals notice costs.", "type": [ "number", "null" ], "example": "10.00" }, "ordernumber": { "description": "Order number", "type": [ "integer", "null" ], "example": "10232" }, "ourcode": { "description": "The principals reference", "type": [ "string", "null" ], "example": "Volvo ABC-553" }, "overdueinterest": { "description": "Delay interest rate", "type": [ "number", "null" ], "example": "8.0" }, "ovt": { "description": "OrganisationUnitNumber of recipient", "type": [ "string", "null" ], "example": "00371234567800001" }, "ownref": { "description": "Temporary reference for sending", "type": [ "string", "null" ], "example": "155" }, "origbillnum": { "description": "Billnumber of collection invoices. Compulsory when invoice is sub invoice jobtype = 602.", "type": [ "string", "null" ], "example": "123456" }, "paydate": { "description": "The due date of the bill", "type": [ "string", "null" ], "format": "date", "example": "2017-01-17" }, "payplanamount": { "description": "Amount of one instalment in a payment schedule in euros.", "type": [ "number", "null" ], "example": "100.00" }, "payplancount": { "description": "The number of instalments in a payment schedule.", "type": [ "integer", "null" ], "example": "5" }, "payplaninterval": { "description": "Interval between instalments of the payment schedule in months.", "type": [ "integer", "null" ], "example": "1" }, "payplan": { "$ref": "#/components/schemas/JobPayplan" }, "pdfname": { "description": "Predefined filename. This value is returned in preview and localprint responseheader", "type": [ "string", "null" ], "example": "preview.pdf" }, "period": { "description": "The date when the bill is recorded in the principals accounting. Contact our customer service before using this!", "type": [ "string", "null" ], "format": "date", "example": "2017-02-17" }, "person": { "description": "The name of the consumer client", "type": [ "string", "null" ], "example": "Teppo Nuutinen" }, "phone": { "description": "The phone number of the customer/buyer/debtor", "type": [ "string", "null" ], "example": "+358441234567" }, "postclass": { "description": "Class of the letter in the post: 1 or 2", "type": "integer", "example": "2" }, "postcode": { "description": "The postal code of the customer", "type": [ "string", "null" ], "example": "70100" }, "putonhold": { "description": "Should jobstatus be changed to 100: 1 = yes, 0 = no", "type": [ "integer", "null" ], "example": 1 }, "refundtobillnum": { "description": "Bill number of the principal to which the credit note is allocated.", "type": [ "string", "null" ], "example": "11213" }, "refundtojobid": { "description": "Assignment ID generated by Ropo to which the credit note is allocated.", "type": [ "integer", "null" ], "example": "31211" }, "refundiban": { "description": "Account number where credit note is payed", "type": [ "string", "null" ], "example": "FI2112345600000785" }, "refundmessage": { "description": "Message for payment of credit note", "type": [ "string", "null" ], "example": "tm 22141739 tili 1514 va 4804" }, "refundmessagetype": { "description": "Messagetype for payment of credit note: 1=Using reference, 3=Using message", "type": [ "integer", "null" ], "example": "3" }, "salesman": { "description": "The code of the salesman", "type": [ "integer", "null" ], "example": "12" }, "salesmanname": { "description": "Name or initials of the salesman", "type": [ "string", "null" ], "example": "Sam Salesman" }, "sendtype": { "description": "Type of sending of the bill: post, print, email or evoice", "type": [ "string", "null" ], "example": "post" }, "secondarysendtype": { "type": "array", "items": { "$ref": "#/components/schemas/JobSendtype" } }, "sensible": { "description": "Is a payment notice sent automatically: 1=no, 0=yes", "type": [ "integer", "null" ], "example": "0" }, "servicecode": { "description": "Cost center id", "type": [ "string", "null" ], "example": "1" }, "servicecode_name": { "description": "Cost center Name", "type": [ "string", "null" ], "example": "Center X" }, "servicecode_dimension": { "description": "Cost center code", "type": [ "string", "null" ], "example": "123" }, "TA0001": { "description": "Site key in construction invoices.", "type": [ "string", "null" ], "example": "TA-FI-STVOY0001-B" }, "TA0002": { "description": "Site number in construction invoices.", "type": [ "string", "null" ], "example": "1234" }, "TA0003": { "description": "Reported to the site register: Y = yes, N = no", "type": [ "string", "null" ], "example": "Y" }, "totalamount": { "description": "Total bill amount including VAT", "type": [ "number", "null" ], "example": "19.96" }, "vatamount": { "description": "Total VAT amount of the bill", "type": [ "number", "null" ], "example": "3.86" }, "vatlayout": { "description": "VAT layout at invoice lines when only one is shown. 0 = Without VAT 1 = VAT included", "type": [ "integer", "null" ], "example": "0" }, "vatid": { "description": "The VAT ID of the customer", "type": [ "string", "null" ], "example": "FI22059054" }, "vatperiod": { "description": "The date on which VAT is applied in the principals accounting. Contact our customer service before using this!", "type": [ "string", "null" ], "format": "date", "example": "2017-02-17" }, "voucherbatch": { "description": "Voucher batch", "type": [ "string", "null" ], "example": "43" }, "vouchernum": { "description": "Voucher number", "type": [ "string", "null" ], "example": "202132" }, "yourcode": { "description": "Reference of the buyer", "type": [ "string", "null" ], "example": "Teppo Nuutinen" }, "addaddress": { "type": "array", "items": { "$ref": "#/components/schemas/JobAddAddress" } }, "accountrow": { "type": "array", "items": { "$ref": "#/components/schemas/JobAccountRow" } }, "advancepayments": { "type": "array", "items": { "$ref": "#/components/schemas/JobPartialPayment" } }, "attachment": { "type": "array", "items": { "$ref": "#/components/schemas/JobAttachment" } }, "cashdiscountrow": { "type": "array", "items": { "$ref": "#/components/schemas/JobCashDiscountRow" } }, "contract": { "type": "array", "items": { "$ref": "#/components/schemas/JobContract" } }, "originalcurrency": { "type": "array", "items": { "$ref": "#/components/schemas/JobCurrency" } }, "definitiondetails": { "type": "array", "items": { "$ref": "#/components/schemas/JobDefinitions" } }, "image": { "oneOf": [ { "$ref": "#/components/schemas/JobImage" }, { "type": "null" } ] }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/JobLink" } }, "packagedetails": { "oneOf": [ { "$ref": "#/components/schemas/JobPackageDetails" }, { "type": "null" } ] }, "payee": { "oneOf": [ { "$ref": "#/components/schemas/JobPayee" }, { "type": "null" } ] }, "payrow": { "type": "array", "items": { "$ref": "#/components/schemas/JobPayRow" } }, "propertyrow": { "type": "array", "items": { "$ref": "#/components/schemas/JobPropertyRow" } }, "marks": { "type": "array", "items": { "$ref": "#/components/schemas/JobMarks" } }, "taxrow": { "type": "array", "items": { "$ref": "#/components/schemas/JobTaxRow" } }, "xmldetailsrow": { "type": "array", "items": { "$ref": "#/components/schemas/JobXmlDetailsRow" } }, "usageplaces": { "type": "array", "items": { "$ref": "#/components/schemas/JobUsagePlace" } }, "freetexts": { "type": "array", "items": { "$ref": "#/components/schemas/JobFreetext" } }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/JobAllowance" } }, "charges": { "type": "array", "items": { "$ref": "#/components/schemas/JobAllowance" } }, "originalinvoicereferences": { "description": "Refer to previous invoices (e.g. instalments)", "type": "array", "items": { "$ref": "#/components/schemas/JobOriginalInvoiceReference" } }, "partialpayments": { "type": "array", "items": { "$ref": "#/components/schemas/JobPartialPayment" } }, "interestrates": { "type": "array", "items": { "$ref": "#/components/schemas/JobInterestRate" } }, "classification": { "$ref": "#/components/schemas/JobClassification" }, "sendparameters": { "$ref": "#/components/schemas/JobSendParameters" }, "avtalegiro": { "description": "Used to determine that invoice is Avtalegiro type", "type": [ "string", "null" ], "example": "avtalegiro" }, "autogiro": { "description": "Used to determine that invoice is Autogiro type", "type": [ "string", "null" ], "example": "autogiro" }, "subset": { "type": "array", "items": { "$ref": "#/components/schemas/JobDataSet" } } }, "type": "object" }, "JobDataStream": { "title": "JobDataStream", "description": "JobDataStream", "properties": { "debug": { "description": "Testing of the interface, true=on", "type": [ "string", "null" ], "example": "true" }, "noreport": { "description": "Blocks the sending of a transmission emailreport of the assignment, true=on", "type": [ "string", "null" ], "example": "true" }, "operator": { "description": "Operators ID", "type": [ "string", "null" ], "example": "123456" }, "origname": { "description": "Original name of the data file. Optional.", "type": [ "string", "null" ], "example": "invoices.xml" }, "transferkey": { "description": "Transfer key to validate transfer.", "type": [ "string", "null" ], "example": "7d843a4e0d13ceb69b61e919ca4b0fbe" }, "fileid": { "description": "Filekey identifying content file.", "type": [ "string", "null" ], "example": "7d843a4e0d13ceb69b61e919ca4b0fbe" }, "batchid": { "description": "Batch identification.", "type": [ "string", "null" ], "example": "batch123123" }, "dataset": { "type": "array", "items": { "$ref": "#/components/schemas/JobDataSet" } } }, "type": "object" }, "JobDefinitions": { "title": "JobDefinitions", "description": "JobDefinitions", "properties": { "headertext": { "description": "Definition header text in Finvoice or Teapps invoice message.", "type": [ "string", "null" ], "example": "Vuosikayttoarvio" }, "code": { "description": "Defininition code in Finvoice or Teapps invoice message.", "type": [ "string", "null" ], "example": "E1003" }, "value": { "description": "Value of the additional data entered in Finvoice or Teapps invoice message.", "type": [ "string", "null" ], "example": "17030" }, "unitcode": { "description": "Unit code for value of the additional data entered in Finvoice or Teapps invoice message.", "type": [ "string", "null" ], "example": "kWh" }, "unitcodeun": { "description": "EU UN Unit code for value of the additional data entered in Finvoice or Teapps invoice message.", "type": [ "string", "null" ], "example": "KWH" } }, "type": "object" }, "JobDeliveryStatusRequest": { "title": "JobDeliveryStatusRequest", "description": "JobDeliveryStatusRequest", "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "service": { "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobDeliveryStatusRequestData" } } }, "type": "object" }, "JobDeliveryStatusRequestData": { "title": "JobDeliveryStatusRequestData", "description": "JobDeliveryStatusRequestData", "properties": { "reporterid": { "type": "string" }, "documentid": { "type": "string" }, "status": { "type": "string" }, "statustime": { "type": "string" }, "description": { "type": "string" } }, "type": "object" }, "JobDisputeRequest": { "title": "JobDisputeRequest", "description": "JobDisputeRequest", "properties": { "data": { "$ref": "#/components/schemas/JobDisputeRequestData" } }, "type": "object" }, "JobDisputeRequestData": { "title": "JobDisputeRequestData", "description": "JobDisputeRequestData", "properties": { "description": { "type": "string", "example": "More information on why case was disputed." } }, "type": "object" }, "JobDisputeResponse": { "title": "JobDisputeResponse", "description": "JobDisputeResponse", "properties": { "created_at": { "description": "Timestamp of the response.", "type": "string" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/JobDisputeResponseData" } } }, "type": "object" }, "JobDisputeResponseData": { "title": "JobDisputeResponseData", "description": "JobDisputeResponseData", "properties": { "updated_at": { "description": "Timestamp when the dispute was succesfully made.", "type": "string" }, "jobid": { "description": "ID of the disputed job.", "type": "integer" }, "billnum": { "description": "Billnum of the disputed job.", "type": "string" }, "status": { "description": "Success status of the dispute request.", "type": "boolean" }, "statustext": { "description": "Status text of the dispute request.", "type": "string" } }, "type": "object" }, "JobEnergyContract": { "title": "JobEnergyContract", "description": "JobEnergyContract", "properties": { "contract_no": { "description": "Contract number", "type": [ "string", "null" ], "example": "123456" }, "name": { "type": [ "string", "null" ], "example": "Verkkosopimus" }, "vendor_name": { "type": [ "string", "null" ], "example": "Testiverkot" }, "startdate": { "type": [ "string", "null" ], "example": "2017-06-01" }, "enddate": { "description": "Contract end date", "type": [ "string", "null" ], "example": "2018-06-01" }, "expdate": { "description": "Contract period end date.", "type": [ "string", "null" ], "example": "2018-06-01" } }, "type": "object" }, "JobFreetext": { "title": "JobFreetext", "description": "JobFreetext", "properties": { "texttype": { "description": "Freetext type e.g. HEADER = (top part of the invoice), FOOTER (bottom part of invoice), GIRO (giro part of the invoice)", "type": [ "string", "null" ], "example": "HEADER" }, "textname": { "description": "Freetext name or header", "type": [ "string", "null" ], "example": "Text header" }, "textvalue": { "description": "Freetext", "type": [ "string", "null" ], "example": "This is jobs free text" } }, "type": "object" }, "JobImage": { "title": "JobImage", "description": "JobImage", "required": [ "file" ], "properties": { "file": { "description": "Base64 encoded pdf-file", "type": "string", "example": "JVBERi0xLjQNJeLjz9MNCjE" }, "pagecount": { "description": "number of pages in the pdf-file", "type": [ "integer", "null" ], "example": "2" }, "fileType": { "description": "Attachment file type", "type": [ "string", "null" ], "example": "txt" } }, "type": "object" }, "JobInstalment": { "title": "JobInstalment", "description": "JobInstalment", "properties": { "date": { "description": "Date of instalment", "type": "string", "format": "date", "example": "2017-01-17" }, "amount": { "description": "Amount of one instalment in a payment schedule in euros.", "type": "number", "example": "10.00" } }, "type": "object" }, "JobInterestRate": { "title": "JobInterestRate", "description": "JobInterestRate", "properties": { "interest_type": { "description": "Type of the interest added (overdueinterest, creditinterest etc.)", "type": "string" }, "annual_rate": { "description": "Annual interest rate", "type": "number", "example": "19.90" }, "real_annual_rate": { "description": "Real annual interest rate", "type": "number", "example": "27.29" }, "start_from_date": { "description": "The first day the interest is effective", "type": "string", "format": "date" }, "end_at_date": { "description": "The last day the interest is effective", "type": [ "string", "null" ], "format": "date" } }, "type": "object" }, "JobInvoicerowAddress": { "title": "JobInvoicerowAddress", "description": "JobInvoicerowAddress", "properties": { "party_text": { "description": "Party related text", "type": [ "string", "null" ] }, "party_code": { "description": "Party code defined by the industry concerned", "type": [ "string", "null" ] }, "party_identifier": { "description": "Identification of any party Business ID", "type": [ "string", "null" ] }, "party_identifier_scheme_id": { "description": "Scheme of party ID", "type": [ "string", "null" ] }, "name": { "description": "Company name", "type": [ "string", "null" ] }, "name2": { "description": "Company name", "type": [ "string", "null" ] }, "department": { "description": "Department", "type": [ "string", "null" ] }, "tax_code": { "description": "VAT ID", "type": [ "string", "null" ] }, "any_party_code": { "description": "Other Identification of any party", "type": [ "string", "null" ] }, "any_party_code_scheme_id": { "description": "Scheme of any party code", "type": [ "string", "null" ] }, "address": { "description": "Street address", "type": [ "string", "null" ] }, "address2": { "description": "Street address 2", "type": [ "string", "null" ] }, "address3": { "description": "Street address 3", "type": [ "string", "null" ] }, "postcode": { "description": "Post code", "type": [ "string", "null" ] }, "city": { "description": "Post city", "type": [ "string", "null" ] }, "country_code": { "description": "Country code", "type": [ "string", "null" ] }, "country_name": { "description": "Country name", "type": [ "string", "null" ] }, "subdivision": { "description": "The subdivision of a country.", "type": [ "string", "null" ] }, "post_box_id": { "description": "PO box", "type": [ "string", "null" ] }, "organisation_unit_number": { "description": "OVT code (OVT-tunnus), format nnnnn (SFS)", "type": [ "string", "null" ] }, "site_code": { "description": "Site code of party", "type": [ "string", "null" ] } }, "type": "object" }, "JobInvoicerowOverDue": { "title": "JobInvoicerowOverDue", "description": "JobInvoicerowOverDue", "properties": { "original_invoice_identifier": { "description": "Invoice number for the original invoice", "type": [ "string", "null" ] }, "original_invoice_date": { "description": "Date for the original invoice", "type": [ "string", "null" ], "format": "date" }, "original_due_date": { "description": "Due date for the original invoice", "type": [ "string", "null" ], "format": "date" }, "original_invoice_total_amount": { "description": "Total sum of original invoice", "type": [ "number", "null" ] }, "original_epi_remittance_info_identifier": { "description": "Payment reference of original invoice", "type": [ "string", "null" ] }, "paid_vat_excluded_amount": { "description": "Paid sum without VAT", "type": [ "number", "null" ] }, "paid_vat_included_amount": { "description": "Paid sum with VAT", "type": [ "number", "null" ] }, "paid_date": { "description": "Payment date", "type": [ "string", "null" ], "format": "date" }, "un_paid_vat_excluded_amount": { "description": "Sum not yet paid without VAT", "type": [ "number", "null" ] }, "un_paid_vat_included_amount": { "description": "Sum not yet paid with VAT", "type": [ "number", "null" ] }, "collection_date": { "description": "Collection date", "type": [ "string", "null" ], "format": "date" }, "collection_quantity": { "description": "The number of collections", "type": [ "string", "null" ] }, "quantity_unit_code": { "description": "Type of collections, eg. Pcs, unit", "type": [ "string", "null" ] }, "quantity_unit_code_u_n": { "description": "Check instructions from EU Norm", "type": [ "string", "null" ] }, "collection_charge_amount": { "description": "Collection charge", "type": [ "number", "null" ] }, "interest_rate": { "description": "interest rate", "type": [ "number", "null" ] }, "interest_start_date": { "description": "Start date for interest period", "type": [ "string", "null" ], "format": "date" }, "interest_end_date": { "description": "End date for interest period", "type": [ "string", "null" ], "format": "date" }, "interest_period_text": { "description": "Text for interest period", "type": [ "string", "null" ] }, "interest_date_number": { "description": "The number of interest dates", "type": [ "string", "null" ] }, "interest_charge_amount": { "description": "interest charge sum", "type": [ "number", "null" ] }, "interest_charge_vat_amount": { "description": "interest sum", "type": [ "number", "null" ] }, "amount_currency_identifier": { "description": "ISO4217 eg. EUR,USD...", "type": [ "string", "null" ] } }, "type": "object" }, "JobJobInfo": { "title": "JobJobInfo", "description": "JobJobInfo", "properties": { "accountdate": { "description": "The date job was added", "type": [ "string", "null" ], "format": "date", "example": "2017-10-10" }, "address": { "description": "The street address of the recipient", "type": "string", "example": "Satamakatu 123" }, "addressaddline1": { "description": "The first additional line of the address card, printed above the name of the recipient", "type": "string", "example": "Johto" }, "addressaddline2": { "description": "The second additional line of the address card, printed between the name and the street address", "type": "string", "example": "PL 43" }, "billcode": { "description": "Reference number or message, by which the payment is delivered to the biller", "type": "string", "example": "4349" }, "billnum": { "description": "The current number of the bill in the accounting books of the principal", "type": "string", "example": "11213" }, "city": { "description": "The mailing location of the debtor", "type": "string", "example": "KUOPIO" }, "company": { "description": "Name of the corporate customer", "type": "string", "example": "Matin konepaja Oy" }, "country": { "description": "Country where the corporate customer is registered", "type": "string", "example": "FIN" }, "currentpaydate": { "description": "Current paydate", "type": "string", "example": "2017-12-31" }, "currentstatus": { "description": "Current status", "type": "integer", "example": "0" }, "currentstatustext": { "description": "Current statustext", "type": "string", "example": "Invoicing" }, "custnum": { "description": "The customer number of the customer in the principals system", "type": "string", "example": "1022" }, "govid": { "description": "The business ID (Y-tunnus) or personal identity code of the customer", "type": "string", "example": "2262509-5" }, "jobid": { "description": "Job id", "type": "integer", "example": "123" }, "nextstatus": { "description": "Next status (-1 if next status is not available)", "type": "integer", "example": "1" }, "nextstatusdate": { "description": "Date when next status occurs", "type": "string", "example": "2018-01-15" }, "nextstatustext": { "description": "Next status text", "type": "string", "example": "Reminder" }, "origjobdate": { "description": "Date when job was originally received", "type": "string", "example": "2017-11-13" }, "origjobtext": { "description": "Original status text", "type": "string", "example": "Invoicing" }, "origjobtype": { "description": "Jobtype when job was originally received", "type": "integer", "example": "0" }, "paydate": { "description": "Original duedate of the bill", "type": "string", "example": "2017-11-27" }, "person": { "description": "The name of the consumer client", "type": "string", "example": "Teppo Nuutinen" }, "postcode": { "description": "The postal code of the customer", "type": "string", "example": "70100" }, "reference": { "description": "Reference number or message, by which the payment is delivered to the biller", "type": "string", "example": "412431235" }, "refundtojobid": { "description": "Assignment ID generated by Ropo to which the credit note is allocated.", "type": "integer", "example": "31211" }, "vatid": { "description": "The VAT ID of the customer", "type": "string", "example": "FI22059054" }, "breakdown": { "type": "array", "items": { "$ref": "#/components/schemas/JobBreakdown" } }, "payment": { "type": "array", "items": { "$ref": "#/components/schemas/JobPayment" } }, "refund": { "type": "array", "items": { "$ref": "#/components/schemas/JobRefund" } }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatus" } } }, "type": "object" }, "JobLink": { "title": "JobLink", "description": "JobAllowance", "properties": { "name": { "description": "Name of link", "type": [ "string", "null" ], "example": "SellerReferenceIdentifierUrlText" }, "link": { "description": "Actual link", "type": [ "string", "null" ], "example": "http://www.seller.com/reference" } }, "type": "object" }, "JobMarks": { "title": "JobMarks", "description": "JobMarks", "properties": { "jobid": { "description": "Job ID", "type": [ "integer", "null" ], "example": "3000" }, "statustime": { "description": "", "type": [ "string", "null" ], "format": "datetime", "example": "2018-10-23 10:12:32" }, "text": { "description": "", "type": [ "string", "null" ], "example": "" }, "whodid": { "description": "", "type": [ "integer", "null" ], "example": "3000" }, "specialmark": { "description": "", "type": [ "boolean", "null" ], "example": "1" }, "customermark": { "description": "", "type": [ "boolean", "null" ], "example": "1" }, "restricted": { "description": "", "type": [ "boolean", "null" ], "example": "1" } }, "type": "object" }, "JobOriginalInvoiceReference": { "title": "JobOriginalInvoiceReference", "description": "JobOriginalInvoiceReference", "properties": { "invoicenumber": { "description": "Previous invoice number", "type": "string", "example": "123456" }, "invoicedate": { "description": "Previous invoice date", "type": "string", "example": "2017-12-31" }, "netamount": { "description": "Amount of the invoice without VAT", "type": [ "number", "null" ], "example": "7.60" }, "totalamount": { "description": "The total amount of an invoice including VAT", "type": [ "number", "null" ], "example": "10.00" } }, "type": "object" }, "JobPackageDetails": { "title": "JobPackageDetails", "description": "JobPackageDetails", "properties": { "packagelength": { "description": "Length of package", "type": [ "string", "null" ], "example": "1" }, "lengthquantityunitcode": { "description": "Length quantity unit code.", "type": [ "string", "null" ], "example": "m" }, "lengthquantityunitcodeun": { "description": "Check instructions from EU Norm", "type": [ "string", "null" ], "example": "M" }, "packagewidth": { "description": "Width of package", "type": [ "string", "null" ], "example": "1" }, "widthquantityunitcode": { "description": "Width quantity unit code.", "type": [ "string", "null" ], "example": "m" }, "widthquantityunitcodeun": { "description": "Check instructions from EU Norm", "type": [ "string", "null" ], "example": "M" }, "packageheight": { "description": "Height of package", "type": [ "string", "null" ], "example": "2" }, "heightquantityunitcode": { "description": "Height quantity unit code.", "type": [ "string", "null" ], "example": "m" }, "heightquantityunitcodeun": { "description": "Check instructions from EU Norm", "type": [ "string", "null" ], "example": "M" }, "packageweight": { "description": "Total weight", "type": [ "string", "null" ], "example": "100" }, "weightquantityunitcode": { "description": "Total weight unit code", "type": [ "string", "null" ], "example": "kg" }, "weightquantityunitcodeun": { "description": "Check instructions from EU Norm", "type": [ "string", "null" ], "example": "KG" }, "packagenetweight": { "description": "Net weight", "type": [ "string", "null" ], "example": "40" }, "netweightquantityunitcode": { "description": "Net weight unit code", "type": [ "string", "null" ], "example": "kg" }, "netweightquantityunitcodeun": { "description": "Check instructions from EU Norm", "type": [ "string", "null" ], "example": "TN" }, "packagevolume": { "description": "Volume", "type": [ "string", "null" ], "example": "3" }, "volumequantityunitcode": { "description": "Volume unit code", "type": [ "string", "null" ], "example": "m3" }, "volumequantityunitcodeun": { "description": "Check instructions from EU Norm", "type": [ "string", "null" ], "example": "M3" }, "transportcarriagequantity": { "description": "Number of transport carriages", "type": [ "string", "null" ], "example": "2" }, "carriagequantityunitcode": { "description": "Number of items ( eg. Pcs, unit, piece)", "type": [ "string", "null" ], "example": "kpl" }, "carriagequantityunitcodeun": { "description": "Check instructions from EU Norm", "type": [ "string", "null" ], "example": "PCS" } }, "type": "object" }, "JobPartialPayment": { "title": "JobPartialPayment", "description": "JobPartialPayment", "properties": { "paid_amount": { "description": "Paid amount of loaned sum with VAT.", "type": [ "number", "null" ] }, "paid_vat_excluded_amount": { "description": "Paid amount of loaned sum without VATs", "type": [ "number", "null" ] }, "unpaid_amount": { "description": "Unpaid amount of loaned sum with VAT", "type": [ "number", "null" ] }, "unpaid_vat_excluded_amount": { "description": "Unpaid amount of loaned sum without VAT", "type": [ "number", "null" ] }, "interest_percent": { "description": "The interest percent related to the partial payment", "type": [ "number", "null" ] }, "prosessing_costs_amount": { "description": "Cost related to the partial payment", "type": [ "number", "null" ] }, "vat_included_amount": { "description": "Amount to be paid back of the loan in this specific payment, VAT included", "type": [ "number", "null" ] }, "vat_excluded_amount": { "description": "Amount to be paid back of the loan in this specific payment, VAT excluded", "type": [ "number", "null" ] }, "duedate": { "description": "duedate", "type": [ "string", "null" ], "format": "date" }, "reference_identifier": { "description": "Payment reference number", "type": [ "string", "null" ] } }, "type": "object" }, "JobPatchOpenSalesInvoicesResponse": { "title": "JobPatchOpenSalesInvoicesResponse", "description": "JobPatchOpenSalesInvoicesResponse", "properties": { "opensalesinvoices": { "type": "array", "items": { "$ref": "#/components/schemas/JobPatchOpenSalesInvoicesResponseResult" } } }, "type": "object" }, "JobPatchOpenSalesInvoicesResponseResult": { "title": "JobPatchOpenSalesInvoicesResponseResult", "description": "JobPatchOpenSalesInvoicesResponseResult", "properties": { "jobid": { "description": "Job ID", "type": "integer", "example": "1234123" }, "billnum": { "description": "Bill number", "type": "string", "example": "4213451" } }, "type": "object" }, "JobPayRow": { "title": "JobPayRow", "description": "JobPayRow", "properties": { "accountid": { "description": "Account ID for the accounting of the company that uses the interface", "type": [ "integer", "null" ], "example": "3000" }, "allownullvalues": { "description": "1=true, row does not have to have desc, count, amount, taxpr, vatamount, netamount, totalamount values", "type": [ "boolean", "null" ], "example": "0" }, "amount": { "description": "Unit price without VAT", "type": [ "number", "null" ], "example": "0.76" }, "count": { "description": "Number of units", "type": [ "number", "null" ], "example": "10" }, "desc": { "description": "Name of the product", "type": [ "string", "null" ], "example": "Leivokset" }, "discount": { "description": "Discount rate", "type": [ "number", "null" ], "example": "25" }, "eancode": { "description": "The EAN code", "type": [ "string", "null" ], "example": "5901234123457" }, "enddate": { "description": "The period end date (e.g. the hotel room check-out date)", "type": [ "string", "null" ], "format": "date", "example": "2017-02-17" }, "freetext": { "description": "An explanation added to the product; may include several lines", "type": [ "string", "null" ], "example": "- 500 Mt kotisivutilaa" }, "invoicerowtype": { "description": "0 = normal, 25600 = Sub total row (does not affect invoice total), 25601 = Header row", "type": [ "integer", "null" ], "example": "25600" }, "itemtype": { "description": "The unit of amount, e.g. pcs, h or m3", "type": [ "string", "null" ], "example": "pcs" }, "netamount": { "description": "Amount of the invoice line without VAT", "type": [ "number", "null" ], "example": "7.60" }, "priceunit": { "description": "Unit of unit price", "type": [ "string", "null" ], "example": "e/kwh" }, "productid": { "description": "Product ID", "type": [ "string", "null" ], "example": "XN5" }, "rowline": { "description": "The VAT amount of the invoice line", "type": [ "integer", "null" ], "example": "1" }, "rowtype": { "description": "Identifies invoice row debt type. 3 = capital, 6 = customer fee, 12 = customer reminder fee, etc.", "type": [ "integer", "null" ], "example": "3" }, "salesman": { "description": "The code of the salesman", "type": [ "integer", "null" ], "example": "12" }, "salesmanname": { "description": "Name or initials of the salesman", "type": [ "string", "null" ], "example": "Sam Salesman" }, "servicecode": { "description": "Cost centre", "type": [ "string", "null" ], "example": "0" }, "startdate": { "description": "The start date of the period (e.g. the hotel room check-in date)", "type": [ "string", "null" ], "format": "date", "example": "2017-02-17" }, "storage": { "description": "Id of product in Ropo One storage. Need separate contract", "type": [ "integer", "null" ], "example": "12345" }, "TA0001": { "description": "Site key in construction invoices.", "type": [ "string", "null" ], "example": "TA-FI-STVOY0001-B" }, "TA0002": { "description": "Site number in construction invoices.", "type": [ "string", "null" ], "example": "1234" }, "TA0003": { "description": "Reported to the site register: Y = yes, N = no", "type": [ "string", "null" ], "example": "Y" }, "taxpr": { "description": "VAT percentage 0-100", "type": [ "number", "null" ], "example": "24.00" }, "totalamount": { "description": "The total price of an invoice line including VAT", "type": [ "number", "null" ], "example": "10.00" }, "itemprice": { "description": "Item price", "type": [ "number", "null" ], "example": "147.60" }, "totalitemprice": { "description": "Unit price including VAT", "type": [ "number", "null" ], "example": "147.60" }, "vatamount": { "description": "The VAT amount of the invoice line", "type": [ "number", "null" ], "example": "2.40" }, "vatcode": { "description": "VAT-code from Finvoice or CAB", "type": [ "string", "null" ], "example": "1" }, "vatfreetext": { "description": "Taxfree reason", "type": [ "string", "null" ], "example": "MOMS Directive 44 type" }, "subidentifier": { "description": "Finvoice RowSubIdentifier or SubIdentifier: Identifies invoice row in SubInvoicerow. Technical identifier if Sub invoice row is used", "type": [ "string", "null" ], "example": "1" }, "identifier": { "description": "Identifies invoice row capital or expence.", "type": [ "string", "null" ], "example": "INDENFIER" }, "rowpositionidentifier": { "description": "Finvoice RowPositionIdentifier or SubRowPositionIdentifier: Identifies the invoice row", "type": [ "string", "null" ], "example": "1" }, "usageplacecode": { "description": "Usage place code", "type": [ "string", "null" ], "example": "123456" }, "definitions": { "type": "array", "items": { "$ref": "#/components/schemas/JobDefinitions" } }, "packagedetails": { "$ref": "#/components/schemas/JobPackageDetails" }, "propertyrow": { "type": "array", "items": { "$ref": "#/components/schemas/JobPropertyRow" } }, "discounts": { "type": "array", "items": { "$ref": "#/components/schemas/JobAllowance" } }, "charges": { "type": "array", "items": { "$ref": "#/components/schemas/JobAllowance" } }, "links": { "type": "array", "items": { "$ref": "#/components/schemas/JobLink" } }, "rowoverdue": { "$ref": "#/components/schemas/JobInvoicerowOverDue" }, "invoicerowaddress": { "description": "Row any party details: The sector of business is responsible for maintaining the data contents and description", "type": "array", "items": { "$ref": "#/components/schemas/JobInvoicerowAddress" } } }, "type": "object" }, "JobPayee": { "title": "JobPayee", "description": "JobPayee", "required": [ "address", "city", "name", "postcode", "govid" ], "properties": { "address": { "description": "Address of the payee", "type": "string", "example": "Sienikatu 3" }, "address2": { "description": "Address line 2 of the payee", "type": "string", "example": "Sienikatu 3" }, "addressaddline1": { "description": "Line above name", "type": [ "string", "null" ], "example": "Johto" }, "addressaddline2": { "description": "Line between receivers name and address", "type": [ "string", "null" ], "example": "PL 43" }, "addressaddline3": { "description": "Line between receivers name and address", "type": [ "string", "null" ], "example": "CO Mauno Mansikka" }, "city": { "description": "City of the payee", "type": "string", "example": "Kuopio" }, "countryname": { "description": "Country of the payee", "type": "string", "example": "Norway" }, "countrycode": { "description": "Country code of the payee", "type": "string", "example": "NOR" }, "contact_email": { "description": "Contact email address of payee", "type": [ "string", "null" ], "example": "asiakaspalvelu@somewhere.fi" }, "contact_name": { "description": "Contact name of payee", "type": [ "string", "null" ], "example": "Asiakaspalvelu" }, "contact_phone": { "description": "Contact phone of payee", "type": [ "string", "null" ], "example": "020-123123" }, "govid": { "description": "y-tunnus", "type": "string", "example": "1234567-8" }, "name": { "description": "Name of payee", "type": "string", "example": "Yritys Oy" }, "name_extension": { "description": "Extension for payeename", "type": [ "string", "null" ], "example": "Kuopion toimipaikka" }, "ovt": { "description": "OVT of payee", "type": [ "string", "null" ], "example": "003712345678" }, "postcode": { "description": "Postcode of payee", "type": "string", "example": "00100" }, "vatid": { "description": "VAT number of payee", "type": "string", "example": "FI1234567" }, "www": { "description": "www-address of payee", "type": [ "string", "null" ], "example": "www.company.fi" }, "fax": { "description": "fax number", "type": [ "string", "null" ], "example": "020-123123" }, "bankinfos": { "type": "array", "items": { "$ref": "#/components/schemas/JobBankInfo" } } }, "type": "object" }, "JobPayment": { "title": "JobPayment", "description": "JobPayment", "properties": { "amount": { "description": "Amount of payment", "type": "number", "example": "710.00" }, "desc": { "description": "Visible description to customer", "type": "string", "example": "PAID" }, "paydate": { "description": "Date of payment", "type": "string", "example": "2017-10-10" }, "rowtype": { "description": "Type of row", "type": "integer", "example": "1" }, "rowtypetext": { "description": "Description of rowtype in text", "type": "string", "example": "Capital" }, "returndesc": { "description": "Type of returndesc", "type": "integer", "example": "1" }, "returndesctext": { "description": "Description of returndesc in text", "type": "string", "example": "Paid to the creditor" }, "rowtime": { "description": "Timestamp of rowinsert", "type": "string", "example": "2017-10-10 12:23:32" }, "statusid": { "description": "Id of payment", "type": "integer", "example": "213123" } }, "type": "object" }, "JobPayplan": { "title": "JobPayplan", "description": "JobPayplan", "properties": { "instalment": { "type": "array", "items": { "$ref": "#/components/schemas/JobInstalment" } } }, "type": "object" }, "JobPropertyRow": { "title": "JobPropertyRow", "description": "JobPropertyRow", "required": [ "propname", "propvalue" ], "properties": { "propname": { "description": "Control data for invoice layout or debt recovery.", "type": "string", "example": "E1002" }, "propvalue": { "description": "Control data value provided with propname tag. ", "type": "string", "example": "1402465093" } }, "type": "object" }, "JobRefund": { "title": "JobRefund", "description": "JobRefund", "properties": { "amount": { "description": "Amount of refund", "type": "number", "example": "19.96" }, "date": { "description": "Date of refund", "type": "string", "example": "2017-10-30" }, "jobid": { "description": "Assignment ID generated by Ropo to which the credit note is allocated.", "type": "integer", "example": "123456" } }, "type": "object" }, "JobResolveDisputeRequest": { "title": "JobResolveDisputeRequest", "description": "JobResolveDisputeRequest", "properties": { "data": { "$ref": "#/components/schemas/JobResolveDisputeRequestData" } }, "type": "object" }, "JobResolveDisputeRequestData": { "title": "JobResolveDisputeRequestData", "description": "JobResolveDisputeRequestData", "properties": { "description": { "type": "string", "example": "More information on why case was resolved." } }, "type": "object" }, "JobResponse": { "title": "JobResponse", "description": "JobResponse", "properties": { "result": { "type": "array", "items": { "$ref": "#/components/schemas/JobResponseResult" } }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/JobResponseErrors" } }, "accepted": { "description": "Total count of accepted jobs", "type": "integer", "example": "1" } }, "type": "object" }, "JobResponseErrors": { "title": "JobResponseErrors", "description": "JobResponseErrors", "properties": { "error": { "description": "Error description.", "type": "string", "example": "Billnum 11213 already exists" } }, "type": "object" }, "JobResponseResult": { "title": "JobResponseResult", "description": "JobResponseResult", "properties": { "accepted": { "description": "When 1 job is accepted to Ropo One, When 0 job is rejected -> see error for rejection reason", "type": "integer", "example": "1" }, "amount": { "description": "", "type": [ "number", "null" ], "example": "49.53" }, "billnum": { "description": "The current number of the bill in the accounting books of the principal", "type": "string", "example": "11213" }, "billcode": { "description": "The reference number generated by client", "type": "string", "example": "112134" }, "error": { "description": "Reason for not accepting job", "type": [ "string", "null" ], "example": "Billnum 1002 already exists" }, "evoicetype": { "description": "More detail information if sendtype is evoice. Possible values are: elasku, suoramaksu, finvoice", "type": [ "string", "null" ], "example": "elasku" }, "jobid": { "description": "Task number created by Ropo One for the job", "type": [ "integer", "null" ], "example": "549198" }, "jobstatus": { "description": "", "type": "string", "example": "0" }, "jobtype": { "description": "Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service", "type": "string", "example": "0" }, "notice": { "description": "Job is accepted but might need attention.", "type": [ "array", "null" ], "items": { "type": "string" }, "xml": { "name": "notes" }, "example": [ "Please check the chosen customer type", "Please check the address" ] }, "origbillnum": { "description": "Aggregate invoicing (jobtype=602) requires origbillnum.", "type": [ "string", "null" ], "example": "11213" }, "ownref": { "description": "Temporary reference for sending", "type": "integer", "example": "155" }, "print": { "description": "If sendtype is print this returns same value as jobid. Else null.", "type": [ "string", "null" ], "example": "null" }, "receiver": { "type": "string", "example": "Receivers name. Company or Person depending on customertype" }, "reference": { "description": "The reference number generated by Ropo One", "type": "string", "example": "2011035491985" }, "sendtype": { "description": "Type of sending of the bill: post, print, email or evoice", "type": "string", "example": "post" } }, "type": "object" }, "JobSendParameters": { "title": "JobSendParameters", "description": "JobSendParameters", "properties": { "earliestsenddate": { "description": "The earliest date when the invoice can be sent. This date only affects invoices with classification->documentype = generalnote", "type": [ "string", "null" ], "example": "2022-10-24" }, "delivery_channel_priority": { "description": "Comma separated list of delivery channels", "type": [ "string", "null" ], "example": "peppol,b2b" } }, "type": "object" }, "JobSendtype": { "title": "JobSendtype", "description": "JobSendtype", "properties": { "sendtype": { "type": [ "string", "null" ], "example": "b2c" }, "evoice": { "type": [ "string", "null" ], "example": "FI123578612717718" }, "evoiceint": { "type": [ "string", "null" ], "example": "NDEAFIHH" } }, "type": "object" }, "JobStatus": { "title": "JobStatus", "description": "JobStatus", "properties": { "statuscode": { "description": "Code of status", "type": "integer", "example": "0" }, "statusref": { "description": "Short description of the update", "type": "string", "example": "Paid" }, "statustext": { "description": "Additional info of statusref", "type": "number", "example": "Capital paid" }, "statustime": { "description": "Time of status", "type": "string", "example": "2017-10-30 16:27:41" } }, "type": "object" }, "JobTaxRow": { "title": "JobTaxRow", "description": "JobTaxRow", "required": [ "vatamount", "netamount" ], "properties": { "netamount": { "description": "Total amount of the bill without VAT", "type": "number", "example": "16.10" }, "taxpr": { "description": "The VAT percentage of the product in an invoice line or in the VAT breakdown", "type": [ "number", "null" ], "example": "24" }, "totalamount": { "description": "The total price of an invoice line including VAT", "type": [ "number", "null" ], "example": "19.96" }, "vatamount": { "description": "Total VAT amount of the bill", "type": "number", "example": "3.86" }, "vatfreetext": { "description": "Description of VAT", "type": [ "string", "null" ], "example": "ALV 24" }, "vatcode": { "description": "VAT code", "type": [ "string", "null" ], "example": "AE" }, "vatexemptionreasoncode": { "description": "the reason for why the amount is exempted from VAT.\tBT-121", "type": [ "string", "null" ], "example": "REC" } }, "type": "object" }, "JobUsagePlace": { "title": "JobUsagePlace", "description": "JobUsagePlace", "properties": { "address": { "$ref": "#/components/schemas/JobAddAddress" }, "energycontract": { "type": "array", "items": { "$ref": "#/components/schemas/JobEnergyContract" } }, "code": { "type": [ "string", "null" ], "example": "0070100" }, "fuse": { "type": [ "string", "null" ], "example": "25 A" }, "usage_estimate": { "description": "Annual usage estimate", "type": [ "string", "null" ], "example": "20000" }, "usage_estimate_unit": { "description": "Annual usage estimate unit", "type": [ "string", "null" ], "example": "kWh" }, "grid_usageplace": { "type": [ "string", "null" ], "example": "JSE000_2000111" }, "grid_edielno": { "type": [ "string", "null" ], "example": "JSE000" }, "grid_govid": { "type": [ "string", "null" ], "example": "0981408-6" }, "gsrn_code": { "description": "Global Service Relation Number", "type": [ "string", "null" ], "example": "12345749012345678" }, "consumptionhistory": { "type": "array", "items": { "$ref": "#/components/schemas/JobUsagePlaceConsumptionHistory" } }, "freetext": { "type": "array", "items": { "$ref": "#/components/schemas/JobFreetext" } } }, "type": "object" }, "JobUsagePlaceConsumptionHistory": { "title": "JobUsagePlaceConsumptionHistory", "description": "JobUsagePlaceConsumptionHistory", "properties": { "consumption": { "description": "consumption history value between start and end dates", "type": "number", "example": "1234.76" }, "monthly_avg_peak": { "description": "Monthly Average Peak Value", "type": "number", "example": "234.76" }, "startdate": { "type": "string", "example": "2020-06-01" }, "enddate": { "description": "end date", "type": [ "string", "null" ], "example": "2020-07-01" }, "yoy_percentage_change": { "description": "Year-over-year percentage change", "type": [ "number", "null" ], "example": "8.00" } }, "type": "object" }, "JobXmlDetailsRow": { "title": "JobXmlDetailsRow", "description": "JobXmlDetailsRow", "required": [ "source", "text" ], "properties": { "text": { "description": "Name for the additional data conveyed in Finvoice or Teapps invoice message.", "type": "string", "example": "Rekisterinumero" }, "source": { "description": "E-invoice additional data type: finvoice or teapps.", "type": "string", "example": "teapps" }, "code": { "description": "Machine-language name code for the additional data conveyed in Finvoice or Teapps invoice message.", "type": [ "string", "null" ], "example": "rekno" }, "value": { "description": "Value of the additional data entered in Finvoice or Teapps invoice message.", "type": [ "string", "null" ], "example": "ABC-123" }, "group": { "description": "Group value for example delivery site code", "type": [ "string", "null" ], "example": "123456" } }, "type": "object" }, "JobsStatusUpdatesCommonError": { "title": "JobsStatusUpdatesCommonError", "description": "JobsStatusUpdatesCommonError", "properties": { "commonerror": { "description": "Descriptive string of an error.", "type": "string", "example": "Invalid argument error" } }, "type": "object" }, "JobsStatusUpdatesCommonErrorResult": { "title": "JobsStatusUpdatesCommonErrorResult", "description": "JobsStatusUpdatesCommonErrorResult", "properties": { "result": { "$ref": "#/components/schemas/JobsStatusUpdatesCommonError", "description": "object." } }, "type": "object" }, "JobsStatusUpdatesResult": { "title": "JobsStatusUpdatesResult", "description": "JobsStatusUpdatesResult", "properties": { "result": { "$ref": "#/components/schemas/JobsStatusUpdatesStatus" } }, "type": "object" }, "JobsStatusUpdatesStatus": { "title": "JobsStatusUpdatesStatus", "description": "JobsStatusUpdatesStatus", "properties": { "status": { "type": "array", "items": { "$ref": "#/components/schemas/JobsStatusUpdatesStatusRecord" } } }, "type": "object" }, "JobsStatusUpdatesStatusRecord": { "title": "JobsStatusUpdatesStatusRecord", "description": "JobsStatusUpdatesStatusRecord", "properties": { "jobid": { "description": "Job id.", "type": "integer", "example": "1" }, "statusid": { "description": "Id of the status update.", "type": "string", "example": "P12345" }, "billnum": { "description": "Invoice number.", "type": "string", "example": "10123" }, "openamount": { "description": "Current open amount of invoice inclusing costs.", "type": "number", "example": "10.0" }, "origamount": { "description": "Original amount of the invoice including costs.", "type": "number", "example": "15.0" }, "opencapital": { "description": "Open capital.", "type": "number", "example": "6.0" }, "openinterest": { "description": "Open interest.", "type": "number", "example": "3.0" }, "openexpenses": { "description": "Open expenses.", "type": "number", "example": "1.0" }, "statustype": { "description": "Type of the status. Valid values are 'payment' and 'comment'.", "type": "string", "enum": [ "payment", "comment" ], "example": "payment" }, "statustime": { "description": "Time of the status update in 'YYYY-MM-DD HH:mm:ss' format.", "type": "string", "example": "2016-12-30 14:31:26" }, "statusref": { "description": "Short description of the update.", "type": "string", "example": "Sample reason of update" }, "statustext": { "description": "If statustype is 'comment' value contains more informative description of the update. In case statustype is 'payment', this contains payment code.", "type": "string", "example": "Detailed information of update" }, "statuscode": { "description": "If statustype is 'comment' value contains status type code. In case statustype is 'payment', this will be empty.", "type": "integer", "example": "0" }, "paydate": { "description": "Paydate or empty. Format of the value is YYYY-M-DD.", "type": "string", "example": "2016-12-30" }, "amount": { "description": "Paid or canceled amount.", "type": "number", "example": "10.0" } }, "type": "object" }, "JobByEndCustomer": { "properties": { "case_number": { "description": "Case number (internal job ID)", "type": "integer" }, "invoice_number": { "description": "Invoice number", "type": "string" }, "original_invoice_date": { "description": "Original invoice date (origjobdate)", "type": "string" }, "status": { "description": "Current status (invoicing, due, reminder, collection, paid)", "type": "string" }, "open_amount": { "description": "Open amount", "type": "number", "format": "float" }, "group_job": { "description": "Whether this is a group job (0=no, 1=yes)", "type": "integer" }, "group_invoice_numbers": { "description": "Invoice numbers of sub-jobs in the group (only when group_job=1)", "type": "array", "items": { "type": "string" } }, "group_total_payable": { "description": "Total payable amount for the group (only when group_job=1)", "type": "number", "format": "float" }, "my_ropo_link": { "description": "Direct MyRopo link for this invoice", "type": "string" } }, "type": "object" }, "JobsByEndCustomerRequest": { "properties": { "ssn": { "description": "Social security number (HETU). Either ssn or custnum is required.", "type": "string" }, "custnum": { "description": "Customer number. Either ssn or custnum is required.", "type": "string" }, "all_invoices": { "description": "0 = open invoices only (default), 1 = all invoices including paid.", "type": "integer" } }, "type": "object" }, "JobsByEndCustomerResponse": { "properties": { "jobs": { "description": "List of jobs", "type": "array", "items": { "$ref": "#/components/schemas/JobByEndCustomer" } } }, "type": "object" }, "OnlineLinkResponse": { "title": "OnlineLinkResponse", "description": "OnlineLinkResponse", "properties": { "url": { "type": "string", "example": "https://myropo.fi/#/job/5f5b4b4b-7b7b-4b4b-7b7b-5f5b4b4b7b7b" } }, "type": "object" }, "PaylinkResponse": { "title": "PaylinkResponse", "description": "PaylinkResponse", "properties": { "url": { "type": "string", "example": "paylink/pay.php?uuid=5f5b4b4b-7b7b-4b4b-7b7b-5f5b4b4b7b7b" } }, "type": "object" }, "ProductStockError": { "title": "ProductStockError", "description": "ProductStockError", "properties": { "errorId": { "type": "integer", "example": "400" }, "errorText": { "type": "string", "example": "Bad request" } }, "type": "object" }, "ProductStockGroup": { "title": "ProductStockGroup", "description": "ProductStockGroup", "properties": { "name": { "description": "Warehouse name", "type": "string", "example": "Kuopio" }, "totalamount": { "description": "Total amount of the stock item", "type": "number", "example": "99.54" }, "products": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStockRow" } } }, "type": "object" }, "ProductStockResponse": { "title": "ProductStockResponse", "description": "ProductStockResponse", "properties": { "created_at": { "description": "Event creation timestamp in ISO8601 format", "type": "string", "format": "date", "example": "2019-08-12T14:36:00+00:00" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStockResult" } } }, "type": "object" }, "ProductStockResult": { "title": "ProductStockResult", "description": "ProductStockResult", "properties": { "productgroups": { "type": "array", "items": { "$ref": "#/components/schemas/ProductStockGroup" } } }, "type": "object" }, "ProductStockRow": { "title": "ProductStockRow", "description": "ProductStockRow", "properties": { "productId": { "description": "Product id", "type": "integer", "example": "1234567" }, "name": { "description": "Product name", "type": "string", "example": "LAAKERIT" }, "code": { "description": "Product code", "type": "string", "example": "BRS621L1KJ628A" }, "amount": { "description": "Store value", "type": "integer", "example": "120" }, "count": { "description": "Store quantity", "type": "integer", "example": "10" } }, "type": "object" }, "ReceiverResponse": { "title": "ReceiverResponse", "description": "ReceiverResponse", "properties": { "result": { "description": "Result", "type": "string", "example": "success" }, "errors": { "description": "Result", "type": "string", "example": "[['RP_uniqidT140443\\/1','Schema validation failed']]" } }, "type": "object" }, "AmountBreakdown": { "title": "AmountBreakdown", "description": "AmountBreakdown", "properties": { "capital": { "description": "Capital amount", "type": "number", "example": "30.00" }, "interest": { "description": "Interest amount", "type": "number", "example": "1.20" }, "expenses": { "type": [ "number", "null" ], "default": 0, "example": 5 }, "cashdiscount": { "description": "Cash discount amount", "type": "number", "example": "0.50" } }, "type": "object" }, "ContractStatusData": { "title": "ContractStatusData", "description": "ContractStatusData", "properties": { "contract_no": { "description": "Contract number", "type": "string", "example": "123456" }, "jobid": { "description": "Job id", "type": "string", "example": "234567" }, "cid": { "description": "Ropo One identification id for customer / profile", "type": "integer", "example": "12345" }, "name": { "type": [ "string", "null" ], "example": "Network contract" }, "startdate": { "type": [ "string", "null" ], "example": "2017-06-01" }, "enddate": { "description": "Contract end date", "type": [ "string", "null" ], "example": "2018-06-01" }, "contractstatus": { "description": "Status of contract (active, closed, terminated)", "type": [ "string", "null" ], "example": "closed" }, "type": { "description": "Type of contract (insurance)", "type": [ "string", "null" ], "example": "insurance" }, "termination_date": { "description": "Contract termination date", "type": [ "string", "null" ], "example": "2022-06-01" }, "terminationterm": { "description": "Contract termination term. Number of days termination will be done.", "type": [ "integer", "null" ], "example": "14" }, "product": { "description": "Contract product name", "type": [ "string", "null" ], "example": "Home insurance" }, "description": { "description": "Status description", "type": "string", "example": "Termination date was updated" }, "customernumber": { "description": "Customer number from creditor's system", "type": "string" } }, "type": "object" }, "DeliveryStatusData": { "title": "DeliveryStatusData", "description": "DeliveryStatusData", "properties": { "jobid": { "description": "Ropo One identification id for document", "type": "integer", "example": 12345 }, "cid": { "description": "Ropo One identification id for customer / profile", "type": "integer", "example": 12345 }, "documentid": { "description": "Customer own identification id for document if provided", "type": "string", "example": "1568967695dfc8d393a4bd4cc5bb258eff2bb3cea4" }, "status": { "description": "Document status", "type": "string", "example": "delivered" }, "statustime": { "description": "Time when status changed", "type": "string", "example": "2019-08-12T14:36:00+00:00" }, "description": { "description": "Status description", "type": "string", "example": "Recipient not found or not active" }, "distributionchannel": { "description": "Distribution channel", "type": "string", "example": "b2b" }, "notes": { "description": "Delivery status notes.", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryStatusNote" } }, "errors": { "description": "Delivery status errors.", "type": "array", "items": { "$ref": "#/components/schemas/DeliveryStatusError" } }, "invoicenumber": { "description": "get billnum for status", "type": "string", "example": "12345" }, "customernumber": { "description": "Customer number from creditor's system", "type": "string" } }, "type": "object" }, "DeliveryStatusError": { "title": "DeliveryStatusError", "description": "DeliveryStatusError", "type": "object" }, "DeliveryStatusNote": { "title": "DeliveryStatusNote", "description": "DeliveryStatusNote", "properties": { "note": { "description": "Notes reported to customer from the data.", "type": "string", "example": "Check postal address." } }, "type": "object" }, "Invoice": { "title": "Status", "description": "Status information provided from Ropo One.", "properties": { "invoicenumber": { "description": "Invoicenumber", "type": "string", "example": "12345" }, "jobid": { "description": "Ropo One identification id for document", "type": "integer", "example": "12345" }, "cid": { "description": "Ropo One identification id for customer / profile", "type": "integer", "example": "12345" }, "documentid": { "description": "Customer own identification id for document if provided", "type": "string", "example": "1568967695dfc8d393a4bd4cc5bb258eff2bb3cea4" } }, "type": "object" }, "JobCreditNoteData": { "title": "JobCreditNoteData", "description": "JobCreditNoteData", "properties": { "creditjobid": { "description": "Ropo One ID for credit job", "type": "integer", "example": 12345 }, "creditbillnum": { "description": "Credit billnum", "type": "string", "example": "52762781" }, "debitjobid": { "description": "Ropo One ID for debit job", "type": "integer", "example": 12345 }, "debitbillnum": { "description": "Debit billnum", "type": "string", "example": "436323434" }, "cid": { "description": "Ropo One identification id for customer / profile", "type": "integer", "example": 12345 }, "amount": { "description": "Refunded or allocated amount", "type": "string", "example": "100.00" }, "time": { "description": "Time when status changed", "type": "string", "example": "2019-08-12 14:36:00" }, "type": { "description": "Type of credit note change, refund or allocation", "type": "string", "example": "allocated" }, "description": { "description": "Status description", "type": "string", "example": "Recipient not found or not active" }, "customernumber": { "description": "Customer number from creditor's system", "type": "string" } }, "type": "object" }, "JobDisconnectData": { "title": "JobDisconnectData", "description": "JobDisconnectData", "properties": { "customernumber": { "description": "Customernumber", "type": "string", "example": "12345" }, "usageplacecode": { "description": "Usageplacecode", "type": "string", "example": "2728282" }, "contract_no": { "description": "Contractnumber", "type": "string", "example": "co383838" }, "invoices": { "description": "Array of Invoices", "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "time": { "description": "Time when status changed", "type": "string", "example": "2022-05-10 12:36:00" }, "description": { "description": "Description", "type": "string", "example": "Disconnect usage place." }, "disconnectiondate": { "description": "Disconnect Date", "type": "string", "example": "2022-05-10" } }, "type": "object" }, "JobDisconnectTelecomData": { "title": "JobDisconnectTelecomData", "description": "JobDisconnectTelecomData", "properties": { "customernumber": { "description": "Customernumber", "type": "string", "example": "10599938" }, "time": { "description": "Time when status changed", "type": "string", "example": "2026-04-23 03:40:17" } }, "type": "object" }, "JobReconnectData": { "title": "JobReconnectData", "description": "JobReconnectData", "properties": { "customernumber": { "description": "Customernumber", "type": "string", "example": "12345" }, "usageplacecode": { "description": "Usageplacecode", "type": "string", "example": "2728282" }, "contract_no": { "description": "Contractnumber", "type": "string", "example": "co383838" }, "invoices": { "description": "Array of Invoices", "type": "array", "items": { "$ref": "#/components/schemas/Invoice" } }, "time": { "description": "Time when status changed", "type": "string", "example": "2022-05-10 12:36:00" }, "description": { "description": "Description", "type": "string", "example": "Disconnect usage place." } }, "type": "object" }, "JobStatusData": { "title": "JobStatusData", "description": "JobStatusData", "properties": { "jobid": { "description": "Ropo One identification id for document", "type": "integer", "example": "12345" }, "cid": { "description": "Ropo One identification id for customer / profile", "type": "integer", "example": "12345" }, "documentid": { "description": "Customer own identification id for document if provided", "type": "string", "example": "1568967695dfc8d393a4bd4cc5bb258eff2bb3cea4" }, "status": { "description": "Document status", "type": "string", "example": "delivered" }, "code": { "description": "Document status code value", "type": "string", "example": "0" }, "time": { "description": "Time when status changed", "type": "string", "example": "2019-08-12T14:36:00+00:00" }, "description": { "description": "Status description", "type": "string", "example": "Recipient not found or not active" }, "paydate": { "description": "Original duedate", "type": "string", "example": "2022-06-15" }, "currentpaydate": { "description": "Current duedate", "type": "string", "example": "2022-06-30" }, "invoicenumber": { "description": "get billnum for status", "type": "string", "example": "12345" }, "interest": { "description": "current interest", "type": "number", "format": "float", "example": 7 }, "expenses": { "description": "current expenses", "type": "number", "format": "float", "example": 50 }, "opencapital": { "description": "current opencapital", "type": "number", "format": "float", "example": 250 }, "source": { "description": "Source for the status change", "type": "string", "example": "online" }, "contract": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/JobStatusDataContract" } }, "customernumber": { "description": "Customer number from creditor's system", "type": "string" } }, "type": "object" }, "JobStatusDataContract": { "title": "JobStatusDataContract", "description": "JobStatusDataContract", "properties": { "contract_no": { "type": "string" } }, "type": "object" }, "PaymentStatusData": { "title": "PaymentStatusData", "description": "PaymentStatusData", "properties": { "jobid": { "description": "Ropo One identification id for document", "type": "integer", "example": "12345" }, "cid": { "description": "Ropo One identification id for customer / profile", "type": "integer", "example": "12345" }, "documentid": { "description": "Customer own identification id for document if provided", "type": "string", "example": "1568967695dfc8d393a4bd4cc5bb258eff2bb3cea4" }, "amount": { "description": "Paid amount", "type": "number", "example": "30.00" }, "amountbreakdown": { "oneOf": [ { "$ref": "#/components/schemas/AmountBreakdown", "description": "Breakdown of the paid amount." }, { "type": "null" } ], "description": "Breakdown of the paid amount." }, "openamount": { "description": "Open amount of a case in Ropo One. This includes not only the open capital but all the expenses and interest that belong to client.", "type": "number", "example": "30.00" }, "openamountbreakdown": { "oneOf": [ { "$ref": "#/components/schemas/AmountBreakdown", "description": "Breakdown of the current open amount." }, { "type": "null" } ], "description": "Breakdown of the current open amount." }, "type": { "description": "Payment type value", "type": "string", "example": "2" }, "time": { "description": "Time when status changed", "type": "string", "example": "2019-08-12T14:36:00+00:00" }, "description": { "description": "Information about payment", "type": "string", "example": "Paid to Ropo" }, "paydate": { "description": "When payment was done", "type": "string", "example": "2022-06-15", "deprecated": true }, "reference": { "description": "Payment reference", "type": "string", "example": "1234567" }, "invoicenumber": { "description": "Used to get billnum", "type": "string", "example": "1234567" }, "paymentdate": { "description": "Payment registered in bank", "type": "string", "example": "2022-06-15" }, "accountdate": { "description": "Payment received", "type": "string", "example": "2022-06-15" }, "settlementdate": { "description": "Payment settled", "type": "string", "example": "2022-06-15" }, "customernumber": { "description": "Customer number from creditor's system", "type": "string" } }, "type": "object" }, "Status": { "title": "Status", "description": "Status information provided from Ropo One.", "properties": { "created_at": { "description": "Event creation timestamp in ISO8601 format", "type": "string", "format": "date", "example": "2019-08-12T14:36:00+00:00" }, "id": { "description": "Event identification", "type": "string", "example": "e69f55fe-46c4-45cf-ab16-85da60b63884" }, "data": { "oneOf": [ { "$ref": "#/components/schemas/StatusData" }, { "type": "null" } ] } }, "type": "object" }, "StatusData": { "title": "StatusData", "description": "StatusData", "properties": { "contract": { "type": "array", "items": { "$ref": "#/components/schemas/ContractStatusData" } }, "delivery": { "type": "array", "items": { "$ref": "#/components/schemas/DeliveryStatusData" } }, "lcstatus": { "type": "array", "items": { "$ref": "#/components/schemas/JobStatusData" } }, "payment": { "type": "array", "items": { "$ref": "#/components/schemas/PaymentStatusData" } }, "duedateupdate": { "description": "This is used for event type DUEDATETRA.", "type": "array", "items": { "$ref": "#/components/schemas/JobStatusData" } }, "creditnote": { "type": "array", "items": { "$ref": "#/components/schemas/JobCreditNoteData" } }, "disconnect": { "type": "array", "items": { "$ref": "#/components/schemas/JobDisconnectData" } }, "reconnect": { "type": "array", "items": { "$ref": "#/components/schemas/JobReconnectData" } }, "disconnect_telecom": { "type": "array", "items": { "$ref": "#/components/schemas/JobDisconnectTelecomData" } }, "creditloss": { "type": [ "array", "null" ], "items": { "$ref": "#/components/schemas/TimeBasedCreditLossStatusData" }, "default": null } }, "type": "object" }, "TimeBasedCreditLossStatusData": { "title": "TimeBasedCreditLossStatusData", "description": "TimeBasedCreditLossStatusData", "properties": { "jobid": { "description": "Ropo One identification id for document", "type": "integer", "example": "12345" }, "cid": { "description": "Ropo One identification id for customer / profile", "type": "integer", "example": "12345" }, "documentid": { "description": "Customer own identification id for document if provided", "type": "string", "example": "1568967695dfc8d393a4bd4cc5bb258eff2bb3cea4" }, "invoicenumber": { "description": "Billnum", "type": "string", "example": "12345" }, "time": { "description": "Time", "type": "string", "example": "2019-08-12 14:36" }, "amount": { "type": "number", "format": "float", "example": 250 }, "description": { "description": "Status description", "type": "string", "example": "Creditloss happened due to non payment" }, "reason": { "type": "string" }, "reference": { "type": "string" }, "type": { "description": "Type of status update", "type": "string", "enum": [ "creditloss", "suspected", "changed" ], "example": "suspected" }, "amountbreakdown": { "$ref": "#/components/schemas/TimeBasedCreditLossStatusDataAmountBreakdown" }, "customernumber": { "description": "Customer number from creditor's system", "type": "string" } }, "type": "object" }, "TimeBasedCreditLossStatusDataAmountBreakdown": { "title": "TimeBasedCreditLossStatusDataAmountBreakdown", "description": "TimeBasedCreditLossStatusDataAmountBreakdown", "properties": { "capital": { "type": "number", "format": "float", "example": 250 }, "creditloss": { "type": "number", "format": "float", "example": 250 }, "suspected_creditloss": { "type": [ "number", "null" ], "format": "float", "default": null, "example": 250 } }, "type": "object" }, "TelecomSubscriptionEvent": { "title": "TelecomSubscriptionEvent", "description": "TelecomSubscriptionEvent", "properties": { "status": { "description": "Type of event", "type": "string", "example": "disconnected" }, "customernumber": { "description": "Customer number identifying the debtor", "type": "string", "example": "A123456" }, "time": { "description": "Time when the event occurred", "type": "string", "example": "2026-05-06 10:00:00" }, "description": { "description": "Further description of the event", "type": "string", "example": "Subscription closed due to unpaid debt" } }, "type": "object" }, "UEInvoice": { "title": "UEInvoice", "description": "Invoice", "properties": { "jobid": { "description": "Ropo One jobid", "type": "integer", "example": "1234" }, "invoicenumber": { "description": "Invoicenumber", "type": "string", "example": "594294" } }, "type": "object" }, "UsageplaceEvent": { "title": "UsageplaceEvent", "description": "UsageplaceEvent", "properties": { "id": { "description": "Unique id for the event", "type": "string", "example": "1a2b3c4d5" }, "usageplacecode": { "description": "Usageplacecode", "type": "string", "example": "RE12345" }, "customernumber": { "description": "Customernumer", "type": "string", "example": "A123456" }, "contract_no": { "description": "Contractnumber", "type": "string", "example": "555555b" }, "invoices": { "type": "array", "items": { "$ref": "#/components/schemas/UEInvoice" } }, "time": { "description": "Time of event", "type": "string", "example": "2024-01-04 10:41:40" }, "status": { "description": "Type of event", "type": "string", "example": "connected" }, "description": { "description": "Further description of the event", "type": "string", "example": "Usageplace connected" } }, "type": "object" } }, "securitySchemes": { "bearerAuth": { "type": "http", "bearerFormat": "JWT", "scheme": "bearer" } } }, "tags": [ { "name": "auth", "description": "Login and get JWT token" }, { "name": "ibancalculator", "description": "IbanCalculator" }, { "name": "creditinfo", "description": "Credit reports" }, { "name": "creditdecision", "description": "Credit Decision" }, { "name": "control", "description": "Company monitoring" }, { "name": "contract", "description": "Job contracts" }, { "name": "jobs", "description": "Manage Jobs" }, { "name": "receiverproposal", "description": "Receiver Proposal" }, { "name": "usageplace", "description": "Usageplace events" }, { "name": "productstock", "description": "Product stock" }, { "name": "onlinelink", "description": "Online link to MyRopo Job page" }, { "name": "paylink", "description": "Paylink for online payments" }, { "name": "telecomsubscription", "description": "Telecom subscription events" }, { "name": "profile", "description": "profile" } ], "webhooks": { "Status notification service": { "description": "Status notification service", "post": { "summary": "Status notification service", "description": "Status notification service", "operationId": "statusNotificationService", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Status" } } } }, "responses": { "200": { "description": "OK" } }, "x-domain": [ "public" ] }, "servers": [ { "url": "/rest", "description": "Ropo One" } ] } } }