# Models ## The AuthError object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"AuthError":{"title":"AuthError","description":"AuthError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}}} ``` ## The AuthLogin object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"AuthLogin":{"title":"AuthLogin","description":"AuthLogin","required":["cid","apicode"],"properties":{"cid":{"description":"Customer number","type":"string"},"apicode":{"description":"Apicode","type":"string"}},"type":"object"}}}} ``` ## The AuthToken object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"AuthToken":{"title":"AuthToken","description":"AuthToken","properties":{"token":{"type":"string"}},"type":"object"}}}} ``` ## The ContractUpdateRequest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ContractUpdateRequest":{"title":"ContractUpdateRequest","description":"ContractUpdateRequest","properties":{"data":{"$ref":"#/components/schemas/JobContract"}},"type":"object"},"JobContract":{"title":"JobContract","description":"JobContract","required":["contract_no"],"properties":{"contract_no":{"description":"Contract number","type":"string"},"name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"contractstatus":{"description":"Status of contract (active, closed, terminated)","type":["string","null"]},"type":{"description":"Type of contract (insurance)","type":["string","null"]},"termination_date":{"description":"Contract termination date","type":["string","null"]},"terminationterm":{"description":"Contract termination term. Number of days termination will be done.","type":["integer","null"]},"product":{"description":"Contract product name","type":["string","null"]}},"type":"object"}}}} ``` ## The Control object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Control":{"title":"Control","description":"Control","properties":{"controlId":{"type":"integer"},"govId":{"type":"string"},"startTime":{"type":"string"},"controlName":{"type":"string"},"statusCode":{"type":"string"},"statusText":{"type":"string"}},"type":"object"}}}} ``` ## The ControlAddResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ControlAddResponse":{"title":"ControlAddResponse","description":"ControlAddResponse","properties":{"controlId":{"type":"integer"},"govId":{"type":"string"},"startTime":{"type":"string"},"controlName":{"type":"string"},"statusCode":{"type":"string"},"statusText":{"type":"string"}},"type":"object"}}}} ``` ## The ControlError object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ControlError":{"title":"ControlError","description":"ControlError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}}} ``` ## The ControlPdfDataResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ControlPdfDataResponse":{"title":"ControlPdfDataResponse","description":"ControlPdfDataResponse","properties":{"data":{"type":"string","format":"byte"}},"type":"object"}}}} ``` ## The ControlReport object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ControlReport":{"title":"ControlReport","description":"ControlReport","properties":{"reportId":{"type":"integer"},"controlId":{"type":"integer"},"govId":{"type":"string"},"controlName":{"type":"string"},"datetime":{"type":"string"}},"type":"object"}}}} ``` ## The ControlReportExtended object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ControlReportExtended":{"title":"ControlReportExtended","description":"ControlReportExtended","properties":{"reportId":{"type":"integer"},"controlId":{"type":"integer"},"timestamp":{"type":"string"},"control_govid":{"type":"string"},"control_name":{"type":"string"},"control_rating":{"type":"string"},"control_paydex":{"type":"string"},"control_ratingdate":{"type":"string"},"control_scoringchange":{"type":"string"},"control_ratingchange":{"type":"string"},"control_namechange":{"type":"string"},"control_newpaymentfault":{"type":"string"},"control_newaccountingdetails":{"type":"string"},"control_companydel":{"type":"string"},"control_fusion":{"type":"string"},"control_epr":{"type":"string"},"control_prevrating":{"type":"string"},"control_duns":{"type":"string"},"control_receivinggovid":{"type":"string"},"control_score":{"type":"string"},"control_payment_code1":{"type":"string"},"control_payment_date1":{"type":"string"},"control_payment_amount1":{"type":"integer"},"control_payment_ref1":{"type":"string"},"control_payment_receiver1":{"type":"string"},"control_payment_code2":{"type":"string"},"control_payment_date2":{"type":"string"},"control_payment_amount2":{"type":"integer"},"control_payment_ref2":{"type":"string"},"control_payment_receiver2":{"type":"string"},"control_payment_code3":{"type":"string"},"control_payment_date3":{"type":"string"},"control_payment_amount3":{"type":"integer"},"control_payment_ref3":{"type":"string"},"control_payment_receiver3":{"type":"string"},"control_payment_code4":{"type":"string"},"control_payment_date4":{"type":"string"},"control_payment_amount4":{"type":"integer"},"control_payment_ref4":{"type":"string"},"control_payment_receiver4":{"type":"string"},"control_payment_code5":{"type":"string"},"control_payment_date5":{"type":"string"},"control_payment_amount5":{"type":"integer"},"control_payment_ref5":{"type":"string"},"control_payment_receiver5":{"type":"string"},"control_payment_code6":{"type":"string"},"control_payment_date6":{"type":"string"},"control_payment_amount6":{"type":"integer"},"control_payment_ref6":{"type":"string"},"control_payment_receiver6":{"type":"string"},"control_payment_code7":{"type":"string"},"control_payment_date7":{"type":"string"},"control_payment_amount7":{"type":"integer"},"control_payment_ref7":{"type":"string"},"control_payment_receiver7":{"type":"string"},"control_payment_code8":{"type":"string"},"control_payment_date8":{"type":"string"},"control_payment_amount8":{"type":"integer"},"control_payment_ref8":{"type":"string"},"control_payment_receiver8":{"type":"string"},"control_payment_code9":{"type":"string"},"control_payment_date9":{"type":"string"},"control_payment_amount9":{"type":"integer"},"control_payment_ref9":{"type":"string"},"control_payment_receiver9":{"type":"string"}},"type":"object"}}}} ``` ## The ControlReportResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ControlReportResponse":{"title":"ControlReportResponse","description":"ControlReportResponse","properties":{"reportId":{"type":"integer"},"controlId":{"type":"integer"},"timestamp":{"type":"string"},"control_govid":{"type":"string"},"control_name":{"type":"string"},"control_rating":{"type":"string"},"control_paydex":{"type":"string"},"control_ratingdate":{"type":"string"},"control_scoringchange":{"type":"string"},"control_ratingchange":{"type":"string"},"control_namechange":{"type":"string"},"control_newpaymentfault":{"type":"string"},"control_newaccountingdetails":{"type":"string"},"control_companydel":{"type":"string"},"control_fusion":{"type":"string"},"control_epr":{"type":"string"},"control_prevrating":{"type":"string"},"control_duns":{"type":"string"},"control_receivinggovid":{"type":"string"},"control_score":{"type":"string"},"control_payment_code1":{"type":"string"},"control_payment_date1":{"type":"string"},"control_payment_amount1":{"type":"integer"},"control_payment_ref1":{"type":"string"},"control_payment_receiver1":{"type":"string"},"control_payment_code2":{"type":"string"},"control_payment_date2":{"type":"string"},"control_payment_amount2":{"type":"integer"},"control_payment_ref2":{"type":"string"},"control_payment_receiver2":{"type":"string"},"control_payment_code3":{"type":"string"},"control_payment_date3":{"type":"string"},"control_payment_amount3":{"type":"integer"},"control_payment_ref3":{"type":"string"},"control_payment_receiver3":{"type":"string"},"control_payment_code4":{"type":"string"},"control_payment_date4":{"type":"string"},"control_payment_amount4":{"type":"integer"},"control_payment_ref4":{"type":"string"},"control_payment_receiver4":{"type":"string"},"control_payment_code5":{"type":"string"},"control_payment_date5":{"type":"string"},"control_payment_amount5":{"type":"integer"},"control_payment_ref5":{"type":"string"},"control_payment_receiver5":{"type":"string"},"control_payment_code6":{"type":"string"},"control_payment_date6":{"type":"string"},"control_payment_amount6":{"type":"integer"},"control_payment_ref6":{"type":"string"},"control_payment_receiver6":{"type":"string"},"control_payment_code7":{"type":"string"},"control_payment_date7":{"type":"string"},"control_payment_amount7":{"type":"integer"},"control_payment_ref7":{"type":"string"},"control_payment_receiver7":{"type":"string"},"control_payment_code8":{"type":"string"},"control_payment_date8":{"type":"string"},"control_payment_amount8":{"type":"integer"},"control_payment_ref8":{"type":"string"},"control_payment_receiver8":{"type":"string"},"control_payment_code9":{"type":"string"},"control_payment_date9":{"type":"string"},"control_payment_amount9":{"type":"integer"},"control_payment_ref9":{"type":"string"},"control_payment_receiver9":{"type":"string"}},"type":"object"}}}} ``` ## The CreditDecisionCustomer object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionCustomer":{"title":"CreditDecisionCustomer","description":"CreditDecisionCustomer","properties":{"name":{"description":"Customer name","type":["string","null"]},"businessid":{"description":"Company businessid","type":["string","null"]},"ssn":{"description":"Person sosial security number","type":["string","null"]}},"type":"object"}}}} ``` ## The CreditDecisionError object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionError":{"title":"CreditDecisionError","description":"CreditDecisionError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}}} ``` ## The CreditDecisionMetadata object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}},"type":"object"}}}} ``` ## The CreditDecisionModel object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionModel":{"title":"CreditDecisionModel","description":"CreditDecisionModel","properties":{"name":{"description":"Model name","type":"string"},"code":{"description":"Model code","type":"string"}},"type":"object"}}}} ``` ## The CreditDecisionProposal object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionProposal":{"title":"CreditDecisionProposal","description":"CreditDecisionProposal","properties":{"code":{"description":"Decision code. 0 = No, 1 = Consider, 2 = Yes","type":"string"},"text":{"description":"Decision described in text","type":"string"},"factor":{"type":"array","items":{"$ref":"#/components/schemas/CreditDecisionReportFactor"}}},"type":"object"},"CreditDecisionReportFactor":{"title":"CreditDecisionReportResponse","description":"CreditDecisionReportResponse","properties":{"code":{"description":"Factor code","type":"string"},"text":{"description":"Factor described in text.","type":"string"}},"type":"object"}}}} ``` ## The CreditDecisionReportData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionReportData":{"title":"CreditDecisionReportData","description":"CreditDecisionReportData","properties":{"timestamp":{"description":"Decision creation timestamp in ISO8601 format","type":"string"},"proposal":{"$ref":"#/components/schemas/CreditDecisionProposal"},"customer":{"$ref":"#/components/schemas/CreditDecisionCustomer"},"model":{"$ref":"#/components/schemas/CreditDecisionModel"}},"type":"object"},"CreditDecisionProposal":{"title":"CreditDecisionProposal","description":"CreditDecisionProposal","properties":{"code":{"description":"Decision code. 0 = No, 1 = Consider, 2 = Yes","type":"string"},"text":{"description":"Decision described in text","type":"string"},"factor":{"type":"array","items":{"$ref":"#/components/schemas/CreditDecisionReportFactor"}}},"type":"object"},"CreditDecisionReportFactor":{"title":"CreditDecisionReportResponse","description":"CreditDecisionReportResponse","properties":{"code":{"description":"Factor code","type":"string"},"text":{"description":"Factor described in text.","type":"string"}},"type":"object"},"CreditDecisionCustomer":{"title":"CreditDecisionCustomer","description":"CreditDecisionCustomer","properties":{"name":{"description":"Customer name","type":["string","null"]},"businessid":{"description":"Company businessid","type":["string","null"]},"ssn":{"description":"Person sosial security number","type":["string","null"]}},"type":"object"},"CreditDecisionModel":{"title":"CreditDecisionModel","description":"CreditDecisionModel","properties":{"name":{"description":"Model name","type":"string"},"code":{"description":"Model code","type":"string"}},"type":"object"}}}} ``` ## The CreditDecisionReportFactor object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionReportFactor":{"title":"CreditDecisionReportResponse","description":"CreditDecisionReportResponse","properties":{"code":{"description":"Factor code","type":"string"},"text":{"description":"Factor described in text.","type":"string"}},"type":"object"}}}} ``` ## The CreditDecisionReportRequest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionReportRequest":{"title":"CreditDecisionReportRequest","description":"CreditDecisionReportRequest","required":["id"],"properties":{"id":{"description":"Valid sosial security number or business id","type":"string"},"limit":{"description":"Request item limit to be returned. Recommended values are 100 or 200, maximum is 1000.","type":"integer"},"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"},"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"}},"type":"object"}}}} ``` ## The CreditDecisionReportResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionReportResponse":{"title":"CreditDecisionReportResponse","description":"CreditDecisionReportResponse","properties":{"created_at":{"description":"Event creation timestamp in ISO8601 format","type":"string","format":"date"},"data":{"$ref":"#/components/schemas/CreditDecisionReportData"}},"type":"object"},"CreditDecisionReportData":{"title":"CreditDecisionReportData","description":"CreditDecisionReportData","properties":{"timestamp":{"description":"Decision creation timestamp in ISO8601 format","type":"string"},"proposal":{"$ref":"#/components/schemas/CreditDecisionProposal"},"customer":{"$ref":"#/components/schemas/CreditDecisionCustomer"},"model":{"$ref":"#/components/schemas/CreditDecisionModel"}},"type":"object"},"CreditDecisionProposal":{"title":"CreditDecisionProposal","description":"CreditDecisionProposal","properties":{"code":{"description":"Decision code. 0 = No, 1 = Consider, 2 = Yes","type":"string"},"text":{"description":"Decision described in text","type":"string"},"factor":{"type":"array","items":{"$ref":"#/components/schemas/CreditDecisionReportFactor"}}},"type":"object"},"CreditDecisionReportFactor":{"title":"CreditDecisionReportResponse","description":"CreditDecisionReportResponse","properties":{"code":{"description":"Factor code","type":"string"},"text":{"description":"Factor described in text.","type":"string"}},"type":"object"},"CreditDecisionCustomer":{"title":"CreditDecisionCustomer","description":"CreditDecisionCustomer","properties":{"name":{"description":"Customer name","type":["string","null"]},"businessid":{"description":"Company businessid","type":["string","null"]},"ssn":{"description":"Person sosial security number","type":["string","null"]}},"type":"object"},"CreditDecisionModel":{"title":"CreditDecisionModel","description":"CreditDecisionModel","properties":{"name":{"description":"Model name","type":"string"},"code":{"description":"Model code","type":"string"}},"type":"object"}}}} ``` ## The CreditDecisionSearchReportData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionSearchReportData":{"title":"CreditDecisionReportData","description":"CreditDecisionReportData","properties":{"timestamp":{"description":"Decision creation timestamp in ISO8601 format","type":"string"},"proposal":{"$ref":"#/components/schemas/CreditDecisionProposal"},"customer":{"$ref":"#/components/schemas/CreditDecisionCustomer"},"model":{"$ref":"#/components/schemas/CreditDecisionModel"}},"type":"object"},"CreditDecisionProposal":{"title":"CreditDecisionProposal","description":"CreditDecisionProposal","properties":{"code":{"description":"Decision code. 0 = No, 1 = Consider, 2 = Yes","type":"string"},"text":{"description":"Decision described in text","type":"string"},"factor":{"type":"array","items":{"$ref":"#/components/schemas/CreditDecisionReportFactor"}}},"type":"object"},"CreditDecisionReportFactor":{"title":"CreditDecisionReportResponse","description":"CreditDecisionReportResponse","properties":{"code":{"description":"Factor code","type":"string"},"text":{"description":"Factor described in text.","type":"string"}},"type":"object"},"CreditDecisionCustomer":{"title":"CreditDecisionCustomer","description":"CreditDecisionCustomer","properties":{"name":{"description":"Customer name","type":["string","null"]},"businessid":{"description":"Company businessid","type":["string","null"]},"ssn":{"description":"Person sosial security number","type":["string","null"]}},"type":"object"},"CreditDecisionModel":{"title":"CreditDecisionModel","description":"CreditDecisionModel","properties":{"name":{"description":"Model name","type":"string"},"code":{"description":"Model code","type":"string"}},"type":"object"}}}} ``` ## The CreditDecisionSearchReportResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditDecisionSearchReportResponse":{"title":"CreditDecisionSearchReportResponse","description":"CreditDecisionSearchReportResponse","properties":{"created_at":{"description":"Event creation timestamp in ISO8601 format","type":"string","format":"date"},"data":{"type":"array","items":{"$ref":"#/components/schemas/CreditDecisionSearchReportData"}},"metadata":{"oneOf":[{"$ref":"#/components/schemas/CreditDecisionMetadata"},{"type":"null"}]}},"type":"object"},"CreditDecisionSearchReportData":{"title":"CreditDecisionReportData","description":"CreditDecisionReportData","properties":{"timestamp":{"description":"Decision creation timestamp in ISO8601 format","type":"string"},"proposal":{"$ref":"#/components/schemas/CreditDecisionProposal"},"customer":{"$ref":"#/components/schemas/CreditDecisionCustomer"},"model":{"$ref":"#/components/schemas/CreditDecisionModel"}},"type":"object"},"CreditDecisionProposal":{"title":"CreditDecisionProposal","description":"CreditDecisionProposal","properties":{"code":{"description":"Decision code. 0 = No, 1 = Consider, 2 = Yes","type":"string"},"text":{"description":"Decision described in text","type":"string"},"factor":{"type":"array","items":{"$ref":"#/components/schemas/CreditDecisionReportFactor"}}},"type":"object"},"CreditDecisionReportFactor":{"title":"CreditDecisionReportResponse","description":"CreditDecisionReportResponse","properties":{"code":{"description":"Factor code","type":"string"},"text":{"description":"Factor described in text.","type":"string"}},"type":"object"},"CreditDecisionCustomer":{"title":"CreditDecisionCustomer","description":"CreditDecisionCustomer","properties":{"name":{"description":"Customer name","type":["string","null"]},"businessid":{"description":"Company businessid","type":["string","null"]},"ssn":{"description":"Person sosial security number","type":["string","null"]}},"type":"object"},"CreditDecisionModel":{"title":"CreditDecisionModel","description":"CreditDecisionModel","properties":{"name":{"description":"Model name","type":"string"},"code":{"description":"Model code","type":"string"}},"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"}},"type":"object"}}}} ``` ## The CreditInfoCreatedResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditInfoCreatedResponse":{"title":"CreditInfoCreatedResponse","description":"CreditInfoCreatedResponse","properties":{"id":{"type":"integer"}},"type":"object"}}}} ``` ## The CreditInfoCreditRatingResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditInfoCreditRatingResponse":{"title":"CreditInfoCreditRatingResponse","description":"CreditInfoCreditRatingResponse","properties":{"creditrating":{"type":"string"}},"type":"object"}}}} ``` ## The CreditInfoError object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditInfoError":{"title":"CreditInfoError","description":"CreditInfoError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}}} ``` ## The CreditInfoPdfDataResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditInfoPdfDataResponse":{"title":"CreditInfoPdfDataResponse","description":"CreditInfoPdfDataResponse","properties":{"data":{"type":"string","format":"byte"}},"type":"object"}}}} ``` ## The CreditInfoRatingResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditInfoRatingResponse":{"title":"CreditInfoRatingResponse","description":"CreditInfoRatingResponse","properties":{"rating":{"type":"string"},"riskclass":{"type":"integer"}},"type":"object"}}}} ``` ## The CreditInfoReport object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditInfoReport":{"title":"CreditInfoReport","description":"CreditInfoReport","properties":{"id":{"type":"integer"},"name":{"type":"string"},"govid":{"type":"string"},"querytype":{"type":"string"},"queryname":{"type":"string"},"datetime":{"type":"string"},"whodid":{"type":"string"}},"type":"object"}}}} ``` ## The CreditInfoRequest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"CreditInfoRequest":{"title":"CreditInfoRequest","description":"CreditInfoRequest","required":["govid","creditinfo_reason","creditinfo_status"],"properties":{"govid":{"description":"Business Id or Social security number","type":"string"},"creditinfo_reason":{"description":"Reason for query","type":"string","enum":["1","2","3","4","5","6","7","8","9","A","B","C"]},"creditinfo_status":{"description":"Type of report","type":"string","enum":["krbasic","krplus","krplus2","credit","creditcplus","rating"]},"querier_name":{"description":"Querier name","type":"string"},"querier_ssn":{"description":"Querier sosial security number","type":"string"}},"type":"object"}}}} ``` ## The IncompleteCustomerResult object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"IncompleteCustomerResult":{"title":"IncompleteCustomerResult","description":"Response object for incomplete customer creation operations","properties":{"uuid":{"description":"Unique identifier for the incomplete customer record","type":["string","null"]},"status":{"description":"HTTP status code or operation status","type":["string","null"]},"message":{"description":"Human-readable message describing the result","type":["string","null"]},"wizard_url":{"description":"Ropo One URL where to continue the onboarding process","type":["string","null"]}},"type":"object"}}}} ``` ## The NewCustomerResultRest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"NewCustomerResultRest":{"title":"NewCustomerResultRest","description":"NewCustomerResultRest","properties":{"customerId":{"description":"Customer ID of the newly created customer","type":["string","null"]},"message":{"description":"Message regarding the creation result","type":["string","null"]},"status":{"description":"Status of the customer creation process","type":["string","null"]}},"type":"object"}}}} ``` ## The Error object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Error":{"title":"Error","description":"Error","properties":{"Code":{"type":"integer"},"Message":{"type":"string"}},"type":"object"}}}} ``` ## The HttpApiProblem object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The IbanCalculatorError object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"IbanCalculatorError":{"title":"IbanCalculatorError","description":"IbanCalculatorError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}}} ``` ## The IbanCalculatorResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"IbanCalculatorResponse":{"title":"IbanCalculatorResponse","description":"IbanCalculatorResponse","properties":{"iban":{"type":"string"},"bic":{"type":"string"}},"type":"object"}}}} ``` ## The JobByEndCustomer object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobByEndCustomer":{"properties":{"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_case_numbers":{"description":"Related case numbers 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"}}}} ``` ## The JobsByEndCustomerRequest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The JobsByEndCustomerResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobsByEndCustomerResponse":{"properties":{"jobs":{"description":"List of jobs","type":"array","items":{"$ref":"#/components/schemas/JobByEndCustomer"}}},"type":"object"},"JobByEndCustomer":{"properties":{"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_case_numbers":{"description":"Related case numbers 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"}}}} ``` ## The BatchDecisionFile object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"BatchDecisionFile":{"title":"Batch decision file data","description":"Batch decision file data","required":["filename","filetype","data"],"properties":{"filename":{"title":"File name","description":"File name","type":"string"},"filetype":{"title":"File type","description":"File type","type":"string"},"data":{"title":"File data","description":"File data base64 encoded","type":"string"}},"type":"object"}}}} ``` ## The BatchDecisionReceivable object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"BatchDecisionReceivable":{"title":"Batch decision receivable data","description":"Batch decision receivable data","required":["receivabletype","amount"],"properties":{"receivabletype":{"title":"Receivable type","description":"Receivable type","type":"string"},"amount":{"title":"Amount","description":"Amount","type":"string"},"interest_enddate":{"title":"Interest end date","description":"Interest end date","type":"string"}},"type":"object"}}}} ``` ## The Job object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Job":{"title":"Job","description":"Job","properties":{"datastream":{"$ref":"#/components/schemas/JobDataStream"}},"type":"object"},"JobDataStream":{"title":"JobDataStream","description":"JobDataStream","properties":{"debug":{"description":"Testing of the interface, true=on","type":["string","null"]},"noreport":{"description":"Blocks the sending of a transmission emailreport of the assignment, true=on","type":["string","null"]},"operator":{"description":"Operators ID","type":["string","null"]},"origname":{"description":"Original name of the data file. Optional.","type":["string","null"]},"transferkey":{"description":"Transfer key to validate transfer.","type":["string","null"]},"fileid":{"description":"Filekey identifying content file.","type":["string","null"]},"batchid":{"description":"Batch identification.","type":["string","null"]},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/JobDataSet"}}},"type":"object"},"JobDataSet":{"title":"JobDataSet","description":"JobDataSet","required":["jobtype","address","city","customertype"],"properties":{"accountdate":{"description":"Account date","type":["string","null"],"format":"date"},"address":{"description":"The street address of the recipient","type":"string"},"addressaddline1":{"description":"The first additional line of the address card, printed above the name of the recipient","type":["string","null"]},"addressaddline2":{"description":"The second additional line of the address card, printed between the name and the street address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and the street address","type":["string","null"]},"addresscountry":{"description":"The home country of the recipient","type":["string","null"]},"advancepayment":{"description":"Amount of advancepayment","type":["number","null"]},"amount":{"description":"Total amount of the bill","type":["number","null"]},"billcode":{"description":"Reference number or message, by which the payment is delivered to the biller","type":["string","null"]},"billdate":{"description":"The date of the bill","type":["string","null"],"format":"date"},"xmldate":{"description":"The date of the bill on invoices or reminder date","type":["string","null"],"format":"date"},"billnum":{"description":"The current number of the bill in the accounting books of the principal","type":["string","null"]},"billtemplate":{"description":"The layout design of the bill template: CUSTOM, ECOM, BOBCAT, INC","type":["string","null"]},"billtemplateid":{"description":"The layout id of the bill template.","type":["integer","null"]},"cashbill":{"description":"A cash bill is marked as paid directly: 1=cash bill","type":["integer","null"]},"checkbillnum":{"description":"Check if the bill number is unique 1=on, 0=off","type":["integer","null"]},"city":{"description":"The mailing location of the debtor","type":"string"},"claimtext":{"description":"Reason for Recall and Recourse.","type":["string","null"]},"collectionprocess":{"description":"Type of receivable. Influences the collection process","type":["string","null"]},"color":{"description":"1=color, 0=black and white","type":["integer","null"]},"collectioninvoice":{"description":"1=Collection invoice, 0=Single invoice","type":["integer","null"]},"company":{"description":"Name of the corporate customer","type":"string"},"contactperson":{"description":"Contact person","type":["string","null"]},"contactpersontitle":{"description":"Contact person title","type":["string","null"]},"contactpersondepartment":{"description":"Contact person department","type":["string","null"]},"country":{"description":"Country where the corporate customer is registered","type":["string","null"]},"countryname":{"description":"Recipients country name","type":["string","null"]},"currency":{"description":"Currency of job","type":["string","null"]},"custnum":{"description":"The customer number of the customer in the principals system","type":["string","null"]},"customerid":{"description":"The customer number of the customer in Ropo One","type":["integer","null"]},"customertype":{"description":"Type of customer: 1=company, 2=natural person","type":"integer"},"deliverydate":{"description":"Products delivery date on invoice or cover note.","type":["string","null"],"format":"date"},"deliverymethod":{"description":"Products delivery method as text.","type":["string","null"]},"deliveryterm":{"description":"Terms of delivery as text.","type":["string","null"]},"department":{"description":"Recipients department","type":["string","null"]},"doublesided":{"description":"0=singleside(default), 1=use doublesided bill","type":["integer","null"]},"email":{"description":"The e-mail address to which the bill is sent","type":["string","null"]},"email2":{"description":"The second e-mail address to which the bill is sent","type":["string","null"]},"evoice":{"description":"Finnish e-invoice address","type":["string","null"]},"evoiceint":{"description":"The code of the intermediary in the e-invoice","type":["string","null"]},"finance":{"description":"1 = if funding applied from Ropo Finance.","type":["integer","null"]},"foreignamount":{"description":"Total amount of the bill in its original currency.","type":["number","null"]},"foreigncurrency":{"description":"TotalIdentifier of the currency used in the bill.","type":["string","null"]},"freetext":{"description":"Free text field at the end of the bill","type":["string","null"]},"govid":{"description":"The business ID (Y-tunnus) or personal identity code of the customer","type":["string","null"]},"jobtype":{"description":"Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service","type":"integer"},"language":{"description":"Language of the bill: eng, fin, swe, est","type":["string","null"]},"model":{"description":"Make, cost centre in the customers accounting or other reference","type":["string","null"]},"negvat":{"description":"1, if reverse VAT liability is used in the bill","type":["integer","null"]},"netamount":{"description":"Total amount of the bill without VAT","type":["number","null"]},"noticedate":{"description":"Date of the first payment notice.","type":["string","null"],"format":"date"},"noticedate2":{"description":"Date of the second payment notice.","type":["string","null"],"format":"date"},"noticedate3":{"description":"Date of the third payment notice.","type":["string","null"],"format":"date"},"noticedate4":{"description":"Date of the fourth payment notice.","type":["string","null"],"format":"date"},"noticefee":{"description":"Principals notice costs.","type":["number","null"]},"ordernumber":{"description":"Order number","type":["integer","null"]},"ourcode":{"description":"The principals reference","type":["string","null"]},"overdueinterest":{"description":"Delay interest rate","type":["number","null"]},"ovt":{"description":"OrganisationUnitNumber of recipient","type":["string","null"]},"ownref":{"description":"Temporary reference for sending","type":["string","null"]},"origbillnum":{"description":"Billnumber of collection invoices. Compulsory when invoice is sub invoice jobtype = 602.","type":["string","null"]},"paydate":{"description":"The due date of the bill","type":["string","null"],"format":"date"},"payplanamount":{"description":"Amount of one instalment in a payment schedule in euros.","type":["number","null"]},"payplancount":{"description":"The number of instalments in a payment schedule.","type":["integer","null"]},"payplaninterval":{"description":"Interval between instalments of the payment schedule in months.","type":["integer","null"]},"payplan":{"$ref":"#/components/schemas/JobPayplan"},"pdfname":{"description":"Predefined filename. This value is returned in preview and localprint responseheader","type":["string","null"]},"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"},"person":{"description":"The name of the consumer client","type":["string","null"]},"phone":{"description":"The phone number of the customer/buyer/debtor","type":["string","null"]},"postclass":{"description":"Class of the letter in the post: 1 or 2","type":"integer"},"postcode":{"description":"The postal code of the customer","type":["string","null"]},"putonhold":{"description":"Should jobstatus be changed to 100: 1 = yes, 0 = no","type":["integer","null"]},"refundtobillnum":{"description":"Bill number of the principal to which the credit note is allocated.","type":["string","null"]},"refundtojobid":{"description":"Assignment ID generated by Ropo to which the credit note is allocated.","type":["integer","null"]},"refundiban":{"description":"Account number where credit note is payed","type":["string","null"]},"refundmessage":{"description":"Message for payment of credit note","type":["string","null"]},"refundmessagetype":{"description":"Messagetype for payment of credit note: 1=Using reference, 3=Using message","type":["integer","null"]},"salesman":{"description":"The code of the salesman","type":["integer","null"]},"salesmanname":{"description":"Name or initials of the salesman","type":["string","null"]},"sendtype":{"description":"Type of sending of the bill: post, print, email or evoice","type":["string","null"]},"secondarysendtype":{"type":"array","items":{"$ref":"#/components/schemas/JobSendtype"}},"sensible":{"description":"Is a payment notice sent automatically: 1=no, 0=yes","type":["integer","null"]},"servicecode":{"description":"Cost center id","type":["string","null"]},"servicecode_name":{"description":"Cost center Name","type":["string","null"]},"servicecode_dimension":{"description":"Cost center code","type":["string","null"]},"TA0001":{"description":"Site key in construction invoices.","type":["string","null"]},"TA0002":{"description":"Site number in construction invoices.","type":["string","null"]},"TA0003":{"description":"Reported to the site register: Y = yes, N = no","type":["string","null"]},"totalamount":{"description":"Total bill amount including VAT","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":["number","null"]},"vatlayout":{"description":"VAT layout at invoice lines when only one is shown. 0 = Without VAT 1 = VAT included","type":["integer","null"]},"vatid":{"description":"The VAT ID of the customer","type":["string","null"]},"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"},"voucherbatch":{"description":"Voucher batch","type":["string","null"]},"vouchernum":{"description":"Voucher number","type":["string","null"]},"yourcode":{"description":"Reference of the buyer","type":["string","null"]},"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"]},"autogiro":{"description":"Used to determine that invoice is Autogiro type","type":["string","null"]},"subset":{"type":"array","items":{"$ref":"#/components/schemas/JobDataSet"}}},"type":"object"},"JobPayplan":{"title":"JobPayplan","description":"JobPayplan","properties":{"instalment":{"type":"array","items":{"$ref":"#/components/schemas/JobInstalment"}}},"type":"object"},"JobInstalment":{"title":"JobInstalment","description":"JobInstalment","properties":{"date":{"description":"Date of instalment","type":"string","format":"date"},"amount":{"description":"Amount of one instalment in a payment schedule in euros.","type":"number"}},"type":"object"},"JobSendtype":{"title":"JobSendtype","description":"JobSendtype","properties":{"sendtype":{"type":["string","null"]},"evoice":{"type":["string","null"]},"evoiceint":{"type":["string","null"]}},"type":"object"},"JobAddAddress":{"title":"JobAddAddress","description":"JobAddAddress","properties":{"address":{"type":["string","null"]},"city":{"type":["string","null"]},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"addresstype":{"description":"1 = postitusosoite, 2 = toimitusosoite, 3 = laskutusosoite, 4 = rinnakkais, 5 = toissijainen velallinen, 6 = muu, 7 = kayttopaikka, 8 = toimittaja","type":["number","null"]},"person":{"type":["string","null"]},"company":{"type":["string","null"]},"addresscountry":{"type":["string","null"]},"postcode":{"type":["string","null"]},"custnum":{"type":["string","null"]},"govid":{"description":"Identification of seller Business ID (Business Identity Code = Y-tunnus in Finnish or Persons social security number)","type":["string","null"]},"vatid":{"description":"VAT number","type":["string","null"]},"customertype":{"description":"1=comppany, 2=person","type":["integer","null"]},"email":{"description":"Contact email","type":["string","null"]},"phone":{"description":"Contact phone","type":["string","null"]},"partytext":{"description":"Description of address","type":["string","null"]},"partycode":{"description":"Business fields defined type code for address.","type":["string","null"]},"sitecode":{"description":"Code for address.","type":["string","null"]},"contactperson":{"type":["string","null"]},"countryname":{"type":["string","null"]},"ovt":{"description":"OrganisationUnitNumber","type":["string","null"]},"department":{"type":["string","null"]},"contactpersontitle":{"type":["string","null"]},"contactpersondepartment":{"type":["string","null"]}},"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"},"credit":{"description":"Accounting for the sales bill for the principals accounting","type":["number","null"]},"debit":{"description":"Accounting for the sales bill for the principals accounting","type":["number","null"]},"desc":{"description":"Explanation of the export line in the accounting of the sales bill","type":["string","null"]},"servicecode":{"description":"Cost centre","type":["string","null"]},"servicecode_name":{"description":"Cost centter name","type":["string","null"]},"netamount":{"description":"Total amount of the bill without VAT","type":"number"},"taxpr":{"description":"VAT percentage 0-100","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":"number"},"type":{"description":"Business type","type":["string","null"]},"type2":{"description":"Project number","type":["string","null"]},"type3":{"description":"Responsible unit","type":["string","null"]},"type4":{"description":"Business area number","type":["string","null"]},"type5":{"description":"Dimension data 5","type":["string","null"]},"type6":{"description":"Dimension data 6","type":["string","null"]},"type7":{"description":"Dimension data 7","type":["string","null"]},"type8":{"description":"Dimension data 8","type":["string","null"]},"type9":{"description":"Dimension data 9","type":["string","null"]},"type10":{"description":"Dimension data 10","type":["string","null"]},"kwh":{"description":"kWh","type":["number","null"]},"voucherbatch":{"description":"The voucher batch number in the principal's accounting.","type":["string","null"]},"batch":{"description":"The batch of accounting.","type":["string","null"]},"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"]}},"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"},"JobAttachment":{"title":"JobAttachment","description":"JobAttachment","properties":{"attachmentid":{"description":"Preloaded attachment from Ropo One","type":["integer","null"]},"attachmentfile":{"description":"Base64 encoded file","type":["string","null"]},"attachmentname":{"description":"Name of attachment","type":["string","null"]},"securityclass":{"description":"Security class of attachment.","type":["string","null"]},"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"]},"jobid":{"description":"Jobid of attachement","type":["integer","null"]}},"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"},"discountbaseamount":{"description":"Base amount for discount calculation in euros (Finland) or Swedish kronor (Sweden)","type":"number"},"discountdate":{"description":"The last date of validity of the cashiers discount","type":"string","format":"date"},"discountpercent":{"description":"Percentage of the cashiers discount of the bill amount including VAT","type":"number"},"discountfreetext":{"description":"Text displayed on the bill received by the customer to notify the customer of the cashiers discount.","type":["string","null"]}},"type":"object"},"JobContract":{"title":"JobContract","description":"JobContract","required":["contract_no"],"properties":{"contract_no":{"description":"Contract number","type":"string"},"name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"contractstatus":{"description":"Status of contract (active, closed, terminated)","type":["string","null"]},"type":{"description":"Type of contract (insurance)","type":["string","null"]},"termination_date":{"description":"Contract termination date","type":["string","null"]},"terminationterm":{"description":"Contract termination term. Number of days termination will be done.","type":["integer","null"]},"product":{"description":"Contract product name","type":["string","null"]}},"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"},"currency":{"description":"Original currency","type":"string"},"rate":{"description":"Rate of currency","type":"number"},"amount":{"description":"Original amount in target currency","type":"number"},"currency_date":{"description":"Date of currency.","type":["string","null"]}},"type":"object"},"JobDefinitions":{"title":"JobDefinitions","description":"JobDefinitions","properties":{"headertext":{"description":"Definition header text in Finvoice or Teapps invoice message.","type":["string","null"]},"code":{"description":"Defininition code in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcode":{"description":"Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcodeun":{"description":"EU UN Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]}},"type":"object"},"JobImage":{"title":"JobImage","description":"JobImage","required":["file"],"properties":{"file":{"description":"Base64 encoded pdf-file","type":"string"},"pagecount":{"description":"number of pages in the pdf-file","type":["integer","null"]},"fileType":{"description":"Attachment file type","type":["string","null"]}},"type":"object"},"JobLink":{"title":"JobLink","description":"JobAllowance","properties":{"name":{"description":"Name of link","type":["string","null"]},"link":{"description":"Actual link","type":["string","null"]}},"type":"object"},"JobPackageDetails":{"title":"JobPackageDetails","description":"JobPackageDetails","properties":{"packagelength":{"description":"Length of package","type":["string","null"]},"lengthquantityunitcode":{"description":"Length quantity unit code.","type":["string","null"]},"lengthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagewidth":{"description":"Width of package","type":["string","null"]},"widthquantityunitcode":{"description":"Width quantity unit code.","type":["string","null"]},"widthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageheight":{"description":"Height of package","type":["string","null"]},"heightquantityunitcode":{"description":"Height quantity unit code.","type":["string","null"]},"heightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageweight":{"description":"Total weight","type":["string","null"]},"weightquantityunitcode":{"description":"Total weight unit code","type":["string","null"]},"weightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagenetweight":{"description":"Net weight","type":["string","null"]},"netweightquantityunitcode":{"description":"Net weight unit code","type":["string","null"]},"netweightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagevolume":{"description":"Volume","type":["string","null"]},"volumequantityunitcode":{"description":"Volume unit code","type":["string","null"]},"volumequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"transportcarriagequantity":{"description":"Number of transport carriages","type":["string","null"]},"carriagequantityunitcode":{"description":"Number of items ( eg. Pcs, unit, piece)","type":["string","null"]},"carriagequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]}},"type":"object"},"JobPayee":{"title":"JobPayee","description":"JobPayee","required":["address","city","name","postcode","govid"],"properties":{"address":{"description":"Address of the payee","type":"string"},"address2":{"description":"Address line 2 of the payee","type":"string"},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"city":{"description":"City of the payee","type":"string"},"countryname":{"description":"Country of the payee","type":"string"},"countrycode":{"description":"Country code of the payee","type":"string"},"contact_email":{"description":"Contact email address of payee","type":["string","null"]},"contact_name":{"description":"Contact name of payee","type":["string","null"]},"contact_phone":{"description":"Contact phone of payee","type":["string","null"]},"govid":{"description":"y-tunnus","type":"string"},"name":{"description":"Name of payee","type":"string"},"name_extension":{"description":"Extension for payeename","type":["string","null"]},"ovt":{"description":"OVT of payee","type":["string","null"]},"postcode":{"description":"Postcode of payee","type":"string"},"vatid":{"description":"VAT number of payee","type":"string"},"www":{"description":"www-address of payee","type":["string","null"]},"fax":{"description":"fax number","type":["string","null"]},"bankinfos":{"type":"array","items":{"$ref":"#/components/schemas/JobBankInfo"}}},"type":"object"},"JobBankInfo":{"title":"JobBankInfo","description":"JobBankInfo","properties":{"name":{"description":"Name of the bank","type":"string"},"iban":{"description":"International Bank Account Number","type":"string"},"bic":{"description":"Bank Identification Code","type":"string"},"bban":{"description":"Basic Bank Account Number","type":"string"},"bankgiro":{"description":"Bankgiro","type":"string"},"plusgirot":{"description":"Plusgirot","type":"string"}},"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"]},"allownullvalues":{"description":"1=true, row does not have to have desc, count, amount, taxpr, vatamount, netamount, totalamount values","type":["boolean","null"]},"amount":{"description":"Unit price without VAT","type":["number","null"]},"count":{"description":"Number of units","type":["number","null"]},"desc":{"description":"Name of the product","type":["string","null"]},"discount":{"description":"Discount rate","type":["number","null"]},"eancode":{"description":"The EAN code","type":["string","null"]},"enddate":{"description":"The period end date (e.g. the hotel room check-out date)","type":["string","null"],"format":"date"},"freetext":{"description":"An explanation added to the product; may include several lines","type":["string","null"]},"invoicerowtype":{"description":"0 = normal, 25600 = Sub total row (does not affect invoice total), 25601 = Header row","type":["integer","null"]},"itemtype":{"description":"The unit of amount, e.g. pcs, h or m3","type":["string","null"]},"netamount":{"description":"Amount of the invoice line without VAT","type":["number","null"]},"priceunit":{"description":"Unit of unit price","type":["string","null"]},"productid":{"description":"Product ID","type":["string","null"]},"rowline":{"description":"The VAT amount of the invoice line","type":["integer","null"]},"rowtype":{"description":"Identifies invoice row debt type. 3 = capital, 6 = customer fee, 12 = customer reminder fee, etc.","type":["integer","null"]},"salesman":{"description":"The code of the salesman","type":["integer","null"]},"salesmanname":{"description":"Name or initials of the salesman","type":["string","null"]},"servicecode":{"description":"Cost centre","type":["string","null"]},"startdate":{"description":"The start date of the period (e.g. the hotel room check-in date)","type":["string","null"],"format":"date"},"storage":{"description":"Id of product in Ropo One storage. Need separate contract","type":["integer","null"]},"TA0001":{"description":"Site key in construction invoices.","type":["string","null"]},"TA0002":{"description":"Site number in construction invoices.","type":["string","null"]},"TA0003":{"description":"Reported to the site register: Y = yes, N = no","type":["string","null"]},"taxpr":{"description":"VAT percentage 0-100","type":["number","null"]},"totalamount":{"description":"The total price of an invoice line including VAT","type":["number","null"]},"itemprice":{"description":"Item price","type":["number","null"]},"totalitemprice":{"description":"Unit price including VAT","type":["number","null"]},"vatamount":{"description":"The VAT amount of the invoice line","type":["number","null"]},"vatcode":{"description":"VAT-code from Finvoice or CAB","type":["string","null"]},"vatfreetext":{"description":"Taxfree reason","type":["string","null"]},"subidentifier":{"description":"Finvoice RowSubIdentifier or SubIdentifier: Identifies invoice row in SubInvoicerow. Technical identifier if Sub invoice row is used","type":["string","null"]},"identifier":{"description":"Identifies invoice row capital or expence.","type":["string","null"]},"rowpositionidentifier":{"description":"Finvoice RowPositionIdentifier or SubRowPositionIdentifier: Identifies the invoice row","type":["string","null"]},"usageplacecode":{"description":"Usage place code","type":["string","null"]},"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"},"JobPropertyRow":{"title":"JobPropertyRow","description":"JobPropertyRow","required":["propname","propvalue"],"properties":{"propname":{"description":"Control data for invoice layout or debt recovery.","type":"string"},"propvalue":{"description":"Control data value provided with propname tag. ","type":"string"}},"type":"object"},"JobAllowance":{"title":"JobAllowance","description":"JobAllowance","required":["percent","amount","baseamount"],"properties":{"freetext":{"description":"Information in text format","type":["string","null"]},"reasoncode":{"description":"Check instructions from EU Norm BT-98","type":["string","null"]},"percent":{"description":"Percent","type":"number"},"amount":{"description":"Amount excluding VAT","type":"number"},"vatamount":{"description":"VAT amount","type":"number"},"baseamount":{"description":"Base amount, excluding VAT","type":"number"},"vatcategorycode":{"description":"VAT code","type":["string","null"]},"vatratepercent":{"description":"VAT percent","type":["number","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"},"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"},"JobMarks":{"title":"JobMarks","description":"JobMarks","properties":{"jobid":{"description":"Job ID","type":["integer","null"]},"statustime":{"description":"","type":["string","null"],"format":"datetime"},"text":{"description":"","type":["string","null"]},"whodid":{"description":"","type":["integer","null"]},"specialmark":{"description":"","type":["boolean","null"]},"customermark":{"description":"","type":["boolean","null"]},"restricted":{"description":"","type":["boolean","null"]}},"type":"object"},"JobTaxRow":{"title":"JobTaxRow","description":"JobTaxRow","required":["vatamount","netamount"],"properties":{"netamount":{"description":"Total amount of the bill without VAT","type":"number"},"taxpr":{"description":"The VAT percentage of the product in an invoice line or in the VAT breakdown","type":["number","null"]},"totalamount":{"description":"The total price of an invoice line including VAT","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":"number"},"vatfreetext":{"description":"Description of VAT","type":["string","null"]},"vatcode":{"description":"VAT code","type":["string","null"]},"vatexemptionreasoncode":{"description":"the reason for why the amount is exempted from VAT.\tBT-121","type":["string","null"]}},"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"},"source":{"description":"E-invoice additional data type: finvoice or teapps.","type":"string"},"code":{"description":"Machine-language name code for the additional data conveyed in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"group":{"description":"Group value for example delivery site code","type":["string","null"]}},"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"]},"fuse":{"type":["string","null"]},"usage_estimate":{"description":"Annual usage estimate","type":["string","null"]},"usage_estimate_unit":{"description":"Annual usage estimate unit","type":["string","null"]},"grid_usageplace":{"type":["string","null"]},"grid_edielno":{"type":["string","null"]},"grid_govid":{"type":["string","null"]},"gsrn_code":{"description":"Global Service Relation Number","type":["string","null"]},"consumptionhistory":{"type":"array","items":{"$ref":"#/components/schemas/JobUsagePlaceConsumptionHistory"}},"freetext":{"type":"array","items":{"$ref":"#/components/schemas/JobFreetext"}}},"type":"object"},"JobEnergyContract":{"title":"JobEnergyContract","description":"JobEnergyContract","properties":{"contract_no":{"description":"Contract number","type":["string","null"]},"name":{"type":["string","null"]},"vendor_name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"expdate":{"description":"Contract period end date.","type":["string","null"]}},"type":"object"},"JobUsagePlaceConsumptionHistory":{"title":"JobUsagePlaceConsumptionHistory","description":"JobUsagePlaceConsumptionHistory","properties":{"consumption":{"description":"consumption history value between start and end dates","type":"number"},"monthly_avg_peak":{"description":"Monthly Average Peak Value","type":"number"},"startdate":{"type":"string"},"enddate":{"description":"end date","type":["string","null"]},"yoy_percentage_change":{"description":"Year-over-year percentage change","type":["number","null"]}},"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"]},"textname":{"description":"Freetext name or header","type":["string","null"]},"textvalue":{"description":"Freetext","type":["string","null"]}},"type":"object"},"JobOriginalInvoiceReference":{"title":"JobOriginalInvoiceReference","description":"JobOriginalInvoiceReference","properties":{"invoicenumber":{"description":"Previous invoice number","type":"string"},"invoicedate":{"description":"Previous invoice date","type":"string"},"netamount":{"description":"Amount of the invoice without VAT","type":["number","null"]},"totalamount":{"description":"The total amount of an invoice including VAT","type":["number","null"]}},"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"},"real_annual_rate":{"description":"Real annual interest rate","type":"number"},"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"},"JobClassification":{"title":"JobClassification","description":"JobClassification","properties":{"documenttype":{"description":"Type of the document","type":["string","null"]}},"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"]},"delivery_channel_priority":{"description":"Comma separated list of delivery channels","type":["string","null"]}},"type":"object"}}}} ``` ## The JobAccountRow object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"credit":{"description":"Accounting for the sales bill for the principals accounting","type":["number","null"]},"debit":{"description":"Accounting for the sales bill for the principals accounting","type":["number","null"]},"desc":{"description":"Explanation of the export line in the accounting of the sales bill","type":["string","null"]},"servicecode":{"description":"Cost centre","type":["string","null"]},"servicecode_name":{"description":"Cost centter name","type":["string","null"]},"netamount":{"description":"Total amount of the bill without VAT","type":"number"},"taxpr":{"description":"VAT percentage 0-100","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":"number"},"type":{"description":"Business type","type":["string","null"]},"type2":{"description":"Project number","type":["string","null"]},"type3":{"description":"Responsible unit","type":["string","null"]},"type4":{"description":"Business area number","type":["string","null"]},"type5":{"description":"Dimension data 5","type":["string","null"]},"type6":{"description":"Dimension data 6","type":["string","null"]},"type7":{"description":"Dimension data 7","type":["string","null"]},"type8":{"description":"Dimension data 8","type":["string","null"]},"type9":{"description":"Dimension data 9","type":["string","null"]},"type10":{"description":"Dimension data 10","type":["string","null"]},"kwh":{"description":"kWh","type":["number","null"]},"voucherbatch":{"description":"The voucher batch number in the principal's accounting.","type":["string","null"]},"batch":{"description":"The batch of accounting.","type":["string","null"]},"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"]}},"type":"object"}}}} ``` ## The JobAddAddress object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobAddAddress":{"title":"JobAddAddress","description":"JobAddAddress","properties":{"address":{"type":["string","null"]},"city":{"type":["string","null"]},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"addresstype":{"description":"1 = postitusosoite, 2 = toimitusosoite, 3 = laskutusosoite, 4 = rinnakkais, 5 = toissijainen velallinen, 6 = muu, 7 = kayttopaikka, 8 = toimittaja","type":["number","null"]},"person":{"type":["string","null"]},"company":{"type":["string","null"]},"addresscountry":{"type":["string","null"]},"postcode":{"type":["string","null"]},"custnum":{"type":["string","null"]},"govid":{"description":"Identification of seller Business ID (Business Identity Code = Y-tunnus in Finnish or Persons social security number)","type":["string","null"]},"vatid":{"description":"VAT number","type":["string","null"]},"customertype":{"description":"1=comppany, 2=person","type":["integer","null"]},"email":{"description":"Contact email","type":["string","null"]},"phone":{"description":"Contact phone","type":["string","null"]},"partytext":{"description":"Description of address","type":["string","null"]},"partycode":{"description":"Business fields defined type code for address.","type":["string","null"]},"sitecode":{"description":"Code for address.","type":["string","null"]},"contactperson":{"type":["string","null"]},"countryname":{"type":["string","null"]},"ovt":{"description":"OrganisationUnitNumber","type":["string","null"]},"department":{"type":["string","null"]},"contactpersontitle":{"type":["string","null"]},"contactpersondepartment":{"type":["string","null"]}},"type":"object"}}}} ``` ## The JobAddCreditNote object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobAddCreditNote":{"title":"JobAddCreditNote","description":"JobAddCreditNote","required":["amount","date"],"properties":{"amount":{"description":"Amount of credit note","type":"number"},"billcode":{"description":"Reference of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)","type":"string"},"billnum":{"description":"Billnum of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)","type":"string"},"jobid":{"description":"Id of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)","type":"integer"},"date":{"description":"Date","type":"string"},"type":{"description":"Credit note type","type":"string"},"creditnotebillnum":{"description":"Credit note invoice number","type":"string"},"description":{"description":"Description of credit note","type":"string"}},"type":"object"}}}} ``` ## The JobAddCreditNoteResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobAddCreditNoteResponse":{"title":"JobAddCreditNoteResponse","description":"JobAddCreditNoteResponse","properties":{"jobid":{"description":"Id of job","type":"integer"},"billnum":{"description":"Billnum of job","type":"string"},"billcode":{"description":"Reference of job","type":"string"},"date":{"description":"Date of credit note","type":"string"},"amount":{"description":"Amount of credit note","type":"number"},"statusid":{"description":"0 : UNDONE, 1 : FAIL, 2 : OLD, 8 : IGNORE, 10 : NOT FOUND, 11 : CANCELLED, 12 = OLD CANCEL.","type":"number"},"statustext":{"description":"additional information","type":"number"}},"type":"object"}}}} ``` ## The JobAddPayment object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobAddPayment":{"title":"JobAddPayment","description":"JobAddPayment","required":["amount","paydate"],"properties":{"amount":{"description":"Amount of payment","type":"number"},"billcode":{"description":"Reference of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)","type":"string"},"billnum":{"description":"Billnum of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)","type":"string"},"jobid":{"description":"Id of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)","type":"integer"},"paydate":{"description":"Date of payment","type":"string"},"identifier":{"description":"Payment targeting identifier","type":"string"},"type":{"description":"Payment type","type":"string"},"creditnotebillnum":{"description":"Credit note invoice number","type":"string"},"description":{"description":"Description of payment","type":"string"}},"type":"object"}}}} ``` ## The JobAddPaymentResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobAddPaymentResponse":{"title":"JobAddPaymentResponse","description":"JobAddPaymentResponse","properties":{"jobid":{"description":"Id of job","type":"integer"},"billnum":{"description":"Billnum of job","type":"string"},"billcode":{"description":"Reference of job","type":"string"},"paydate":{"description":"Date of payment","type":"string"},"amount":{"description":"Amount of payment","type":"number"},"capitalbefore":{"description":"Open capital before payment","type":"number"},"capitalafter":{"description":"Open capital after payment","type":"number"},"focusedtocapital":{"description":"Amount focused to opencapital","type":"number"},"interestbefore":{"description":"Amount before to interest","type":"number"},"interestafter":{"description":"Amount after to interest","type":"number"},"focusedtointerest":{"description":"Amount focused to interest","type":"number"},"noticefeebefore":{"description":"Amount after to customer notice fee","type":"number"},"noticefeeafter":{"description":"Amount before to customer notice fee","type":"number"},"focusedtonoticefee":{"description":"Amount focused to customer notice fee","type":"number"},"unfocused":{"description":"Unfocused amount","type":"number"},"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"},"statustext":{"description":"additional information","type":"number"}},"type":"object"}}}} ``` ## The JobAllocated object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobAllocated":{"title":"JobAllocated","description":"JobAllocated","required":["allocated","billnum","jobid"],"properties":{"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"allocated":{"description":"Allocated amount of credit note","type":"number"}},"type":"object"}}}} ``` ## The JobAllowance object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobAllowance":{"title":"JobAllowance","description":"JobAllowance","required":["percent","amount","baseamount"],"properties":{"freetext":{"description":"Information in text format","type":["string","null"]},"reasoncode":{"description":"Check instructions from EU Norm BT-98","type":["string","null"]},"percent":{"description":"Percent","type":"number"},"amount":{"description":"Amount excluding VAT","type":"number"},"vatamount":{"description":"VAT amount","type":"number"},"baseamount":{"description":"Base amount, excluding VAT","type":"number"},"vatcategorycode":{"description":"VAT code","type":["string","null"]},"vatratepercent":{"description":"VAT percent","type":["number","null"]}},"type":"object"}}}} ``` ## The JobAttachment object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobAttachment":{"title":"JobAttachment","description":"JobAttachment","properties":{"attachmentid":{"description":"Preloaded attachment from Ropo One","type":["integer","null"]},"attachmentfile":{"description":"Base64 encoded file","type":["string","null"]},"attachmentname":{"description":"Name of attachment","type":["string","null"]},"securityclass":{"description":"Security class of attachment.","type":["string","null"]},"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"]},"jobid":{"description":"Jobid of attachement","type":["integer","null"]}},"type":"object"}}}} ``` ## The JobBankInfo object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobBankInfo":{"title":"JobBankInfo","description":"JobBankInfo","properties":{"name":{"description":"Name of the bank","type":"string"},"iban":{"description":"International Bank Account Number","type":"string"},"bic":{"description":"Bank Identification Code","type":"string"},"bban":{"description":"Basic Bank Account Number","type":"string"},"bankgiro":{"description":"Bankgiro","type":"string"},"plusgirot":{"description":"Plusgirot","type":"string"}},"type":"object"}}}} ``` ## The JobBreakdown object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobBreakdown":{"title":"JobBreakdown","description":"JobBreakdown","properties":{"billnum":{"description":"Laskunnumero","type":"string"},"origpaydate":{"description":"Original paydate","type":"string"},"capital":{"description":"Total amount of original capital","type":"number"},"interest":{"description":"Total amount of interests","type":"number"},"expenses":{"description":"Total amount of expenses","type":"number"},"netamount":{"description":"Total amount of open capital without VAT","type":"number"},"opencapital":{"description":"Total amount of open capital","type":"number"},"title":{"description":"Breakdown title","type":"string"},"vatamount":{"description":"Total VAT amount of open capital","type":"number"},"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"},"overdueinterest":{"description":"Overdueinterestpercentage","type":"number"}},"type":"object"},"JobCreditNotes":{"title":"JobCreditNotes","description":"JobCreditNotes","properties":{"creditnote":{"description":"List of credit invoices / notes","type":"array","items":{"$ref":"#/components/schemas/JobCreditNote"}}},"type":"object"},"JobCreditNote":{"title":"JobCreditNote","description":"JobCreditNote","required":["amount","date"],"properties":{"amount":{"description":"Amount of credit note","type":"number"},"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"billdate":{"description":"Date","type":"string"},"duedate":{"description":"Date","type":"string"},"allocated":{"description":"Allocated amount of credit note","type":"number"},"unallocated":{"description":"Unallocated amount of credit note","type":"number"},"job_allocated":{"type":"array","items":{"$ref":"#/components/schemas/JobAllocated"}}},"type":"object"},"JobAllocated":{"title":"JobAllocated","description":"JobAllocated","required":["allocated","billnum","jobid"],"properties":{"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"allocated":{"description":"Allocated amount of credit note","type":"number"}},"type":"object"}}}} ``` ## The JobCashDiscountRow object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"discountbaseamount":{"description":"Base amount for discount calculation in euros (Finland) or Swedish kronor (Sweden)","type":"number"},"discountdate":{"description":"The last date of validity of the cashiers discount","type":"string","format":"date"},"discountpercent":{"description":"Percentage of the cashiers discount of the bill amount including VAT","type":"number"},"discountfreetext":{"description":"Text displayed on the bill received by the customer to notify the customer of the cashiers discount.","type":["string","null"]}},"type":"object"}}}} ``` ## The JobClaim object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobClaim":{"title":"JobClaim","description":"Definition class for claiming eviction","required":["address.address","address.city","address.postcode"],"properties":{"address":{"$ref":"#/components/schemas/JobAddAddress"},"date":{"description":"Apartment date","type":["string","null"]},"eviction":{"description":"1 = Apply eviction, 0 = do not apply","type":["integer","null"]},"rent":{"description":"Monthly rent in job currency","type":["number","null"]},"information":{"description":"Additional information about apartment.","type":["string","null"]}},"type":"object"},"JobAddAddress":{"title":"JobAddAddress","description":"JobAddAddress","properties":{"address":{"type":["string","null"]},"city":{"type":["string","null"]},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"addresstype":{"description":"1 = postitusosoite, 2 = toimitusosoite, 3 = laskutusosoite, 4 = rinnakkais, 5 = toissijainen velallinen, 6 = muu, 7 = kayttopaikka, 8 = toimittaja","type":["number","null"]},"person":{"type":["string","null"]},"company":{"type":["string","null"]},"addresscountry":{"type":["string","null"]},"postcode":{"type":["string","null"]},"custnum":{"type":["string","null"]},"govid":{"description":"Identification of seller Business ID (Business Identity Code = Y-tunnus in Finnish or Persons social security number)","type":["string","null"]},"vatid":{"description":"VAT number","type":["string","null"]},"customertype":{"description":"1=comppany, 2=person","type":["integer","null"]},"email":{"description":"Contact email","type":["string","null"]},"phone":{"description":"Contact phone","type":["string","null"]},"partytext":{"description":"Description of address","type":["string","null"]},"partycode":{"description":"Business fields defined type code for address.","type":["string","null"]},"sitecode":{"description":"Code for address.","type":["string","null"]},"contactperson":{"type":["string","null"]},"countryname":{"type":["string","null"]},"ovt":{"description":"OrganisationUnitNumber","type":["string","null"]},"department":{"type":["string","null"]},"contactpersontitle":{"type":["string","null"]},"contactpersondepartment":{"type":["string","null"]}},"type":"object"}}}} ``` ## The JobClassification object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobClassification":{"title":"JobClassification","description":"JobClassification","properties":{"documenttype":{"description":"Type of the document","type":["string","null"]}},"type":"object"}}}} ``` ## The JobContract object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobContract":{"title":"JobContract","description":"JobContract","required":["contract_no"],"properties":{"contract_no":{"description":"Contract number","type":"string"},"name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"contractstatus":{"description":"Status of contract (active, closed, terminated)","type":["string","null"]},"type":{"description":"Type of contract (insurance)","type":["string","null"]},"termination_date":{"description":"Contract termination date","type":["string","null"]},"terminationterm":{"description":"Contract termination term. Number of days termination will be done.","type":["integer","null"]},"product":{"description":"Contract product name","type":["string","null"]}},"type":"object"}}}} ``` ## The JobCreditNote object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobCreditNote":{"title":"JobCreditNote","description":"JobCreditNote","required":["amount","date"],"properties":{"amount":{"description":"Amount of credit note","type":"number"},"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"billdate":{"description":"Date","type":"string"},"duedate":{"description":"Date","type":"string"},"allocated":{"description":"Allocated amount of credit note","type":"number"},"unallocated":{"description":"Unallocated amount of credit note","type":"number"},"job_allocated":{"type":"array","items":{"$ref":"#/components/schemas/JobAllocated"}}},"type":"object"},"JobAllocated":{"title":"JobAllocated","description":"JobAllocated","required":["allocated","billnum","jobid"],"properties":{"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"allocated":{"description":"Allocated amount of credit note","type":"number"}},"type":"object"}}}} ``` ## The JobCreditNotes object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobCreditNotes":{"title":"JobCreditNotes","description":"JobCreditNotes","properties":{"creditnote":{"description":"List of credit invoices / notes","type":"array","items":{"$ref":"#/components/schemas/JobCreditNote"}}},"type":"object"},"JobCreditNote":{"title":"JobCreditNote","description":"JobCreditNote","required":["amount","date"],"properties":{"amount":{"description":"Amount of credit note","type":"number"},"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"billdate":{"description":"Date","type":"string"},"duedate":{"description":"Date","type":"string"},"allocated":{"description":"Allocated amount of credit note","type":"number"},"unallocated":{"description":"Unallocated amount of credit note","type":"number"},"job_allocated":{"type":"array","items":{"$ref":"#/components/schemas/JobAllocated"}}},"type":"object"},"JobAllocated":{"title":"JobAllocated","description":"JobAllocated","required":["allocated","billnum","jobid"],"properties":{"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"allocated":{"description":"Allocated amount of credit note","type":"number"}},"type":"object"}}}} ``` ## The JobCurrency object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"currency":{"description":"Original currency","type":"string"},"rate":{"description":"Rate of currency","type":"number"},"amount":{"description":"Original amount in target currency","type":"number"},"currency_date":{"description":"Date of currency.","type":["string","null"]}},"type":"object"}}}} ``` ## The JobDataSet object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobDataSet":{"title":"JobDataSet","description":"JobDataSet","required":["jobtype","address","city","customertype"],"properties":{"accountdate":{"description":"Account date","type":["string","null"],"format":"date"},"address":{"description":"The street address of the recipient","type":"string"},"addressaddline1":{"description":"The first additional line of the address card, printed above the name of the recipient","type":["string","null"]},"addressaddline2":{"description":"The second additional line of the address card, printed between the name and the street address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and the street address","type":["string","null"]},"addresscountry":{"description":"The home country of the recipient","type":["string","null"]},"advancepayment":{"description":"Amount of advancepayment","type":["number","null"]},"amount":{"description":"Total amount of the bill","type":["number","null"]},"billcode":{"description":"Reference number or message, by which the payment is delivered to the biller","type":["string","null"]},"billdate":{"description":"The date of the bill","type":["string","null"],"format":"date"},"xmldate":{"description":"The date of the bill on invoices or reminder date","type":["string","null"],"format":"date"},"billnum":{"description":"The current number of the bill in the accounting books of the principal","type":["string","null"]},"billtemplate":{"description":"The layout design of the bill template: CUSTOM, ECOM, BOBCAT, INC","type":["string","null"]},"billtemplateid":{"description":"The layout id of the bill template.","type":["integer","null"]},"cashbill":{"description":"A cash bill is marked as paid directly: 1=cash bill","type":["integer","null"]},"checkbillnum":{"description":"Check if the bill number is unique 1=on, 0=off","type":["integer","null"]},"city":{"description":"The mailing location of the debtor","type":"string"},"claimtext":{"description":"Reason for Recall and Recourse.","type":["string","null"]},"collectionprocess":{"description":"Type of receivable. Influences the collection process","type":["string","null"]},"color":{"description":"1=color, 0=black and white","type":["integer","null"]},"collectioninvoice":{"description":"1=Collection invoice, 0=Single invoice","type":["integer","null"]},"company":{"description":"Name of the corporate customer","type":"string"},"contactperson":{"description":"Contact person","type":["string","null"]},"contactpersontitle":{"description":"Contact person title","type":["string","null"]},"contactpersondepartment":{"description":"Contact person department","type":["string","null"]},"country":{"description":"Country where the corporate customer is registered","type":["string","null"]},"countryname":{"description":"Recipients country name","type":["string","null"]},"currency":{"description":"Currency of job","type":["string","null"]},"custnum":{"description":"The customer number of the customer in the principals system","type":["string","null"]},"customerid":{"description":"The customer number of the customer in Ropo One","type":["integer","null"]},"customertype":{"description":"Type of customer: 1=company, 2=natural person","type":"integer"},"deliverydate":{"description":"Products delivery date on invoice or cover note.","type":["string","null"],"format":"date"},"deliverymethod":{"description":"Products delivery method as text.","type":["string","null"]},"deliveryterm":{"description":"Terms of delivery as text.","type":["string","null"]},"department":{"description":"Recipients department","type":["string","null"]},"doublesided":{"description":"0=singleside(default), 1=use doublesided bill","type":["integer","null"]},"email":{"description":"The e-mail address to which the bill is sent","type":["string","null"]},"email2":{"description":"The second e-mail address to which the bill is sent","type":["string","null"]},"evoice":{"description":"Finnish e-invoice address","type":["string","null"]},"evoiceint":{"description":"The code of the intermediary in the e-invoice","type":["string","null"]},"finance":{"description":"1 = if funding applied from Ropo Finance.","type":["integer","null"]},"foreignamount":{"description":"Total amount of the bill in its original currency.","type":["number","null"]},"foreigncurrency":{"description":"TotalIdentifier of the currency used in the bill.","type":["string","null"]},"freetext":{"description":"Free text field at the end of the bill","type":["string","null"]},"govid":{"description":"The business ID (Y-tunnus) or personal identity code of the customer","type":["string","null"]},"jobtype":{"description":"Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service","type":"integer"},"language":{"description":"Language of the bill: eng, fin, swe, est","type":["string","null"]},"model":{"description":"Make, cost centre in the customers accounting or other reference","type":["string","null"]},"negvat":{"description":"1, if reverse VAT liability is used in the bill","type":["integer","null"]},"netamount":{"description":"Total amount of the bill without VAT","type":["number","null"]},"noticedate":{"description":"Date of the first payment notice.","type":["string","null"],"format":"date"},"noticedate2":{"description":"Date of the second payment notice.","type":["string","null"],"format":"date"},"noticedate3":{"description":"Date of the third payment notice.","type":["string","null"],"format":"date"},"noticedate4":{"description":"Date of the fourth payment notice.","type":["string","null"],"format":"date"},"noticefee":{"description":"Principals notice costs.","type":["number","null"]},"ordernumber":{"description":"Order number","type":["integer","null"]},"ourcode":{"description":"The principals reference","type":["string","null"]},"overdueinterest":{"description":"Delay interest rate","type":["number","null"]},"ovt":{"description":"OrganisationUnitNumber of recipient","type":["string","null"]},"ownref":{"description":"Temporary reference for sending","type":["string","null"]},"origbillnum":{"description":"Billnumber of collection invoices. Compulsory when invoice is sub invoice jobtype = 602.","type":["string","null"]},"paydate":{"description":"The due date of the bill","type":["string","null"],"format":"date"},"payplanamount":{"description":"Amount of one instalment in a payment schedule in euros.","type":["number","null"]},"payplancount":{"description":"The number of instalments in a payment schedule.","type":["integer","null"]},"payplaninterval":{"description":"Interval between instalments of the payment schedule in months.","type":["integer","null"]},"payplan":{"$ref":"#/components/schemas/JobPayplan"},"pdfname":{"description":"Predefined filename. This value is returned in preview and localprint responseheader","type":["string","null"]},"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"},"person":{"description":"The name of the consumer client","type":["string","null"]},"phone":{"description":"The phone number of the customer/buyer/debtor","type":["string","null"]},"postclass":{"description":"Class of the letter in the post: 1 or 2","type":"integer"},"postcode":{"description":"The postal code of the customer","type":["string","null"]},"putonhold":{"description":"Should jobstatus be changed to 100: 1 = yes, 0 = no","type":["integer","null"]},"refundtobillnum":{"description":"Bill number of the principal to which the credit note is allocated.","type":["string","null"]},"refundtojobid":{"description":"Assignment ID generated by Ropo to which the credit note is allocated.","type":["integer","null"]},"refundiban":{"description":"Account number where credit note is payed","type":["string","null"]},"refundmessage":{"description":"Message for payment of credit note","type":["string","null"]},"refundmessagetype":{"description":"Messagetype for payment of credit note: 1=Using reference, 3=Using message","type":["integer","null"]},"salesman":{"description":"The code of the salesman","type":["integer","null"]},"salesmanname":{"description":"Name or initials of the salesman","type":["string","null"]},"sendtype":{"description":"Type of sending of the bill: post, print, email or evoice","type":["string","null"]},"secondarysendtype":{"type":"array","items":{"$ref":"#/components/schemas/JobSendtype"}},"sensible":{"description":"Is a payment notice sent automatically: 1=no, 0=yes","type":["integer","null"]},"servicecode":{"description":"Cost center id","type":["string","null"]},"servicecode_name":{"description":"Cost center Name","type":["string","null"]},"servicecode_dimension":{"description":"Cost center code","type":["string","null"]},"TA0001":{"description":"Site key in construction invoices.","type":["string","null"]},"TA0002":{"description":"Site number in construction invoices.","type":["string","null"]},"TA0003":{"description":"Reported to the site register: Y = yes, N = no","type":["string","null"]},"totalamount":{"description":"Total bill amount including VAT","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":["number","null"]},"vatlayout":{"description":"VAT layout at invoice lines when only one is shown. 0 = Without VAT 1 = VAT included","type":["integer","null"]},"vatid":{"description":"The VAT ID of the customer","type":["string","null"]},"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"},"voucherbatch":{"description":"Voucher batch","type":["string","null"]},"vouchernum":{"description":"Voucher number","type":["string","null"]},"yourcode":{"description":"Reference of the buyer","type":["string","null"]},"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"]},"autogiro":{"description":"Used to determine that invoice is Autogiro type","type":["string","null"]},"subset":{"type":"array","items":{"$ref":"#/components/schemas/JobDataSet"}}},"type":"object"},"JobPayplan":{"title":"JobPayplan","description":"JobPayplan","properties":{"instalment":{"type":"array","items":{"$ref":"#/components/schemas/JobInstalment"}}},"type":"object"},"JobInstalment":{"title":"JobInstalment","description":"JobInstalment","properties":{"date":{"description":"Date of instalment","type":"string","format":"date"},"amount":{"description":"Amount of one instalment in a payment schedule in euros.","type":"number"}},"type":"object"},"JobSendtype":{"title":"JobSendtype","description":"JobSendtype","properties":{"sendtype":{"type":["string","null"]},"evoice":{"type":["string","null"]},"evoiceint":{"type":["string","null"]}},"type":"object"},"JobAddAddress":{"title":"JobAddAddress","description":"JobAddAddress","properties":{"address":{"type":["string","null"]},"city":{"type":["string","null"]},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"addresstype":{"description":"1 = postitusosoite, 2 = toimitusosoite, 3 = laskutusosoite, 4 = rinnakkais, 5 = toissijainen velallinen, 6 = muu, 7 = kayttopaikka, 8 = toimittaja","type":["number","null"]},"person":{"type":["string","null"]},"company":{"type":["string","null"]},"addresscountry":{"type":["string","null"]},"postcode":{"type":["string","null"]},"custnum":{"type":["string","null"]},"govid":{"description":"Identification of seller Business ID (Business Identity Code = Y-tunnus in Finnish or Persons social security number)","type":["string","null"]},"vatid":{"description":"VAT number","type":["string","null"]},"customertype":{"description":"1=comppany, 2=person","type":["integer","null"]},"email":{"description":"Contact email","type":["string","null"]},"phone":{"description":"Contact phone","type":["string","null"]},"partytext":{"description":"Description of address","type":["string","null"]},"partycode":{"description":"Business fields defined type code for address.","type":["string","null"]},"sitecode":{"description":"Code for address.","type":["string","null"]},"contactperson":{"type":["string","null"]},"countryname":{"type":["string","null"]},"ovt":{"description":"OrganisationUnitNumber","type":["string","null"]},"department":{"type":["string","null"]},"contactpersontitle":{"type":["string","null"]},"contactpersondepartment":{"type":["string","null"]}},"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"},"credit":{"description":"Accounting for the sales bill for the principals accounting","type":["number","null"]},"debit":{"description":"Accounting for the sales bill for the principals accounting","type":["number","null"]},"desc":{"description":"Explanation of the export line in the accounting of the sales bill","type":["string","null"]},"servicecode":{"description":"Cost centre","type":["string","null"]},"servicecode_name":{"description":"Cost centter name","type":["string","null"]},"netamount":{"description":"Total amount of the bill without VAT","type":"number"},"taxpr":{"description":"VAT percentage 0-100","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":"number"},"type":{"description":"Business type","type":["string","null"]},"type2":{"description":"Project number","type":["string","null"]},"type3":{"description":"Responsible unit","type":["string","null"]},"type4":{"description":"Business area number","type":["string","null"]},"type5":{"description":"Dimension data 5","type":["string","null"]},"type6":{"description":"Dimension data 6","type":["string","null"]},"type7":{"description":"Dimension data 7","type":["string","null"]},"type8":{"description":"Dimension data 8","type":["string","null"]},"type9":{"description":"Dimension data 9","type":["string","null"]},"type10":{"description":"Dimension data 10","type":["string","null"]},"kwh":{"description":"kWh","type":["number","null"]},"voucherbatch":{"description":"The voucher batch number in the principal's accounting.","type":["string","null"]},"batch":{"description":"The batch of accounting.","type":["string","null"]},"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"]}},"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"},"JobAttachment":{"title":"JobAttachment","description":"JobAttachment","properties":{"attachmentid":{"description":"Preloaded attachment from Ropo One","type":["integer","null"]},"attachmentfile":{"description":"Base64 encoded file","type":["string","null"]},"attachmentname":{"description":"Name of attachment","type":["string","null"]},"securityclass":{"description":"Security class of attachment.","type":["string","null"]},"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"]},"jobid":{"description":"Jobid of attachement","type":["integer","null"]}},"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"},"discountbaseamount":{"description":"Base amount for discount calculation in euros (Finland) or Swedish kronor (Sweden)","type":"number"},"discountdate":{"description":"The last date of validity of the cashiers discount","type":"string","format":"date"},"discountpercent":{"description":"Percentage of the cashiers discount of the bill amount including VAT","type":"number"},"discountfreetext":{"description":"Text displayed on the bill received by the customer to notify the customer of the cashiers discount.","type":["string","null"]}},"type":"object"},"JobContract":{"title":"JobContract","description":"JobContract","required":["contract_no"],"properties":{"contract_no":{"description":"Contract number","type":"string"},"name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"contractstatus":{"description":"Status of contract (active, closed, terminated)","type":["string","null"]},"type":{"description":"Type of contract (insurance)","type":["string","null"]},"termination_date":{"description":"Contract termination date","type":["string","null"]},"terminationterm":{"description":"Contract termination term. Number of days termination will be done.","type":["integer","null"]},"product":{"description":"Contract product name","type":["string","null"]}},"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"},"currency":{"description":"Original currency","type":"string"},"rate":{"description":"Rate of currency","type":"number"},"amount":{"description":"Original amount in target currency","type":"number"},"currency_date":{"description":"Date of currency.","type":["string","null"]}},"type":"object"},"JobDefinitions":{"title":"JobDefinitions","description":"JobDefinitions","properties":{"headertext":{"description":"Definition header text in Finvoice or Teapps invoice message.","type":["string","null"]},"code":{"description":"Defininition code in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcode":{"description":"Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcodeun":{"description":"EU UN Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]}},"type":"object"},"JobImage":{"title":"JobImage","description":"JobImage","required":["file"],"properties":{"file":{"description":"Base64 encoded pdf-file","type":"string"},"pagecount":{"description":"number of pages in the pdf-file","type":["integer","null"]},"fileType":{"description":"Attachment file type","type":["string","null"]}},"type":"object"},"JobLink":{"title":"JobLink","description":"JobAllowance","properties":{"name":{"description":"Name of link","type":["string","null"]},"link":{"description":"Actual link","type":["string","null"]}},"type":"object"},"JobPackageDetails":{"title":"JobPackageDetails","description":"JobPackageDetails","properties":{"packagelength":{"description":"Length of package","type":["string","null"]},"lengthquantityunitcode":{"description":"Length quantity unit code.","type":["string","null"]},"lengthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagewidth":{"description":"Width of package","type":["string","null"]},"widthquantityunitcode":{"description":"Width quantity unit code.","type":["string","null"]},"widthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageheight":{"description":"Height of package","type":["string","null"]},"heightquantityunitcode":{"description":"Height quantity unit code.","type":["string","null"]},"heightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageweight":{"description":"Total weight","type":["string","null"]},"weightquantityunitcode":{"description":"Total weight unit code","type":["string","null"]},"weightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagenetweight":{"description":"Net weight","type":["string","null"]},"netweightquantityunitcode":{"description":"Net weight unit code","type":["string","null"]},"netweightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagevolume":{"description":"Volume","type":["string","null"]},"volumequantityunitcode":{"description":"Volume unit code","type":["string","null"]},"volumequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"transportcarriagequantity":{"description":"Number of transport carriages","type":["string","null"]},"carriagequantityunitcode":{"description":"Number of items ( eg. Pcs, unit, piece)","type":["string","null"]},"carriagequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]}},"type":"object"},"JobPayee":{"title":"JobPayee","description":"JobPayee","required":["address","city","name","postcode","govid"],"properties":{"address":{"description":"Address of the payee","type":"string"},"address2":{"description":"Address line 2 of the payee","type":"string"},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"city":{"description":"City of the payee","type":"string"},"countryname":{"description":"Country of the payee","type":"string"},"countrycode":{"description":"Country code of the payee","type":"string"},"contact_email":{"description":"Contact email address of payee","type":["string","null"]},"contact_name":{"description":"Contact name of payee","type":["string","null"]},"contact_phone":{"description":"Contact phone of payee","type":["string","null"]},"govid":{"description":"y-tunnus","type":"string"},"name":{"description":"Name of payee","type":"string"},"name_extension":{"description":"Extension for payeename","type":["string","null"]},"ovt":{"description":"OVT of payee","type":["string","null"]},"postcode":{"description":"Postcode of payee","type":"string"},"vatid":{"description":"VAT number of payee","type":"string"},"www":{"description":"www-address of payee","type":["string","null"]},"fax":{"description":"fax number","type":["string","null"]},"bankinfos":{"type":"array","items":{"$ref":"#/components/schemas/JobBankInfo"}}},"type":"object"},"JobBankInfo":{"title":"JobBankInfo","description":"JobBankInfo","properties":{"name":{"description":"Name of the bank","type":"string"},"iban":{"description":"International Bank Account Number","type":"string"},"bic":{"description":"Bank Identification Code","type":"string"},"bban":{"description":"Basic Bank Account Number","type":"string"},"bankgiro":{"description":"Bankgiro","type":"string"},"plusgirot":{"description":"Plusgirot","type":"string"}},"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"]},"allownullvalues":{"description":"1=true, row does not have to have desc, count, amount, taxpr, vatamount, netamount, totalamount values","type":["boolean","null"]},"amount":{"description":"Unit price without VAT","type":["number","null"]},"count":{"description":"Number of units","type":["number","null"]},"desc":{"description":"Name of the product","type":["string","null"]},"discount":{"description":"Discount rate","type":["number","null"]},"eancode":{"description":"The EAN code","type":["string","null"]},"enddate":{"description":"The period end date (e.g. the hotel room check-out date)","type":["string","null"],"format":"date"},"freetext":{"description":"An explanation added to the product; may include several lines","type":["string","null"]},"invoicerowtype":{"description":"0 = normal, 25600 = Sub total row (does not affect invoice total), 25601 = Header row","type":["integer","null"]},"itemtype":{"description":"The unit of amount, e.g. pcs, h or m3","type":["string","null"]},"netamount":{"description":"Amount of the invoice line without VAT","type":["number","null"]},"priceunit":{"description":"Unit of unit price","type":["string","null"]},"productid":{"description":"Product ID","type":["string","null"]},"rowline":{"description":"The VAT amount of the invoice line","type":["integer","null"]},"rowtype":{"description":"Identifies invoice row debt type. 3 = capital, 6 = customer fee, 12 = customer reminder fee, etc.","type":["integer","null"]},"salesman":{"description":"The code of the salesman","type":["integer","null"]},"salesmanname":{"description":"Name or initials of the salesman","type":["string","null"]},"servicecode":{"description":"Cost centre","type":["string","null"]},"startdate":{"description":"The start date of the period (e.g. the hotel room check-in date)","type":["string","null"],"format":"date"},"storage":{"description":"Id of product in Ropo One storage. Need separate contract","type":["integer","null"]},"TA0001":{"description":"Site key in construction invoices.","type":["string","null"]},"TA0002":{"description":"Site number in construction invoices.","type":["string","null"]},"TA0003":{"description":"Reported to the site register: Y = yes, N = no","type":["string","null"]},"taxpr":{"description":"VAT percentage 0-100","type":["number","null"]},"totalamount":{"description":"The total price of an invoice line including VAT","type":["number","null"]},"itemprice":{"description":"Item price","type":["number","null"]},"totalitemprice":{"description":"Unit price including VAT","type":["number","null"]},"vatamount":{"description":"The VAT amount of the invoice line","type":["number","null"]},"vatcode":{"description":"VAT-code from Finvoice or CAB","type":["string","null"]},"vatfreetext":{"description":"Taxfree reason","type":["string","null"]},"subidentifier":{"description":"Finvoice RowSubIdentifier or SubIdentifier: Identifies invoice row in SubInvoicerow. Technical identifier if Sub invoice row is used","type":["string","null"]},"identifier":{"description":"Identifies invoice row capital or expence.","type":["string","null"]},"rowpositionidentifier":{"description":"Finvoice RowPositionIdentifier or SubRowPositionIdentifier: Identifies the invoice row","type":["string","null"]},"usageplacecode":{"description":"Usage place code","type":["string","null"]},"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"},"JobPropertyRow":{"title":"JobPropertyRow","description":"JobPropertyRow","required":["propname","propvalue"],"properties":{"propname":{"description":"Control data for invoice layout or debt recovery.","type":"string"},"propvalue":{"description":"Control data value provided with propname tag. ","type":"string"}},"type":"object"},"JobAllowance":{"title":"JobAllowance","description":"JobAllowance","required":["percent","amount","baseamount"],"properties":{"freetext":{"description":"Information in text format","type":["string","null"]},"reasoncode":{"description":"Check instructions from EU Norm BT-98","type":["string","null"]},"percent":{"description":"Percent","type":"number"},"amount":{"description":"Amount excluding VAT","type":"number"},"vatamount":{"description":"VAT amount","type":"number"},"baseamount":{"description":"Base amount, excluding VAT","type":"number"},"vatcategorycode":{"description":"VAT code","type":["string","null"]},"vatratepercent":{"description":"VAT percent","type":["number","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"},"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"},"JobMarks":{"title":"JobMarks","description":"JobMarks","properties":{"jobid":{"description":"Job ID","type":["integer","null"]},"statustime":{"description":"","type":["string","null"],"format":"datetime"},"text":{"description":"","type":["string","null"]},"whodid":{"description":"","type":["integer","null"]},"specialmark":{"description":"","type":["boolean","null"]},"customermark":{"description":"","type":["boolean","null"]},"restricted":{"description":"","type":["boolean","null"]}},"type":"object"},"JobTaxRow":{"title":"JobTaxRow","description":"JobTaxRow","required":["vatamount","netamount"],"properties":{"netamount":{"description":"Total amount of the bill without VAT","type":"number"},"taxpr":{"description":"The VAT percentage of the product in an invoice line or in the VAT breakdown","type":["number","null"]},"totalamount":{"description":"The total price of an invoice line including VAT","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":"number"},"vatfreetext":{"description":"Description of VAT","type":["string","null"]},"vatcode":{"description":"VAT code","type":["string","null"]},"vatexemptionreasoncode":{"description":"the reason for why the amount is exempted from VAT.\tBT-121","type":["string","null"]}},"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"},"source":{"description":"E-invoice additional data type: finvoice or teapps.","type":"string"},"code":{"description":"Machine-language name code for the additional data conveyed in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"group":{"description":"Group value for example delivery site code","type":["string","null"]}},"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"]},"fuse":{"type":["string","null"]},"usage_estimate":{"description":"Annual usage estimate","type":["string","null"]},"usage_estimate_unit":{"description":"Annual usage estimate unit","type":["string","null"]},"grid_usageplace":{"type":["string","null"]},"grid_edielno":{"type":["string","null"]},"grid_govid":{"type":["string","null"]},"gsrn_code":{"description":"Global Service Relation Number","type":["string","null"]},"consumptionhistory":{"type":"array","items":{"$ref":"#/components/schemas/JobUsagePlaceConsumptionHistory"}},"freetext":{"type":"array","items":{"$ref":"#/components/schemas/JobFreetext"}}},"type":"object"},"JobEnergyContract":{"title":"JobEnergyContract","description":"JobEnergyContract","properties":{"contract_no":{"description":"Contract number","type":["string","null"]},"name":{"type":["string","null"]},"vendor_name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"expdate":{"description":"Contract period end date.","type":["string","null"]}},"type":"object"},"JobUsagePlaceConsumptionHistory":{"title":"JobUsagePlaceConsumptionHistory","description":"JobUsagePlaceConsumptionHistory","properties":{"consumption":{"description":"consumption history value between start and end dates","type":"number"},"monthly_avg_peak":{"description":"Monthly Average Peak Value","type":"number"},"startdate":{"type":"string"},"enddate":{"description":"end date","type":["string","null"]},"yoy_percentage_change":{"description":"Year-over-year percentage change","type":["number","null"]}},"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"]},"textname":{"description":"Freetext name or header","type":["string","null"]},"textvalue":{"description":"Freetext","type":["string","null"]}},"type":"object"},"JobOriginalInvoiceReference":{"title":"JobOriginalInvoiceReference","description":"JobOriginalInvoiceReference","properties":{"invoicenumber":{"description":"Previous invoice number","type":"string"},"invoicedate":{"description":"Previous invoice date","type":"string"},"netamount":{"description":"Amount of the invoice without VAT","type":["number","null"]},"totalamount":{"description":"The total amount of an invoice including VAT","type":["number","null"]}},"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"},"real_annual_rate":{"description":"Real annual interest rate","type":"number"},"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"},"JobClassification":{"title":"JobClassification","description":"JobClassification","properties":{"documenttype":{"description":"Type of the document","type":["string","null"]}},"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"]},"delivery_channel_priority":{"description":"Comma separated list of delivery channels","type":["string","null"]}},"type":"object"}}}} ``` ## The JobDataStream object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobDataStream":{"title":"JobDataStream","description":"JobDataStream","properties":{"debug":{"description":"Testing of the interface, true=on","type":["string","null"]},"noreport":{"description":"Blocks the sending of a transmission emailreport of the assignment, true=on","type":["string","null"]},"operator":{"description":"Operators ID","type":["string","null"]},"origname":{"description":"Original name of the data file. Optional.","type":["string","null"]},"transferkey":{"description":"Transfer key to validate transfer.","type":["string","null"]},"fileid":{"description":"Filekey identifying content file.","type":["string","null"]},"batchid":{"description":"Batch identification.","type":["string","null"]},"dataset":{"type":"array","items":{"$ref":"#/components/schemas/JobDataSet"}}},"type":"object"},"JobDataSet":{"title":"JobDataSet","description":"JobDataSet","required":["jobtype","address","city","customertype"],"properties":{"accountdate":{"description":"Account date","type":["string","null"],"format":"date"},"address":{"description":"The street address of the recipient","type":"string"},"addressaddline1":{"description":"The first additional line of the address card, printed above the name of the recipient","type":["string","null"]},"addressaddline2":{"description":"The second additional line of the address card, printed between the name and the street address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and the street address","type":["string","null"]},"addresscountry":{"description":"The home country of the recipient","type":["string","null"]},"advancepayment":{"description":"Amount of advancepayment","type":["number","null"]},"amount":{"description":"Total amount of the bill","type":["number","null"]},"billcode":{"description":"Reference number or message, by which the payment is delivered to the biller","type":["string","null"]},"billdate":{"description":"The date of the bill","type":["string","null"],"format":"date"},"xmldate":{"description":"The date of the bill on invoices or reminder date","type":["string","null"],"format":"date"},"billnum":{"description":"The current number of the bill in the accounting books of the principal","type":["string","null"]},"billtemplate":{"description":"The layout design of the bill template: CUSTOM, ECOM, BOBCAT, INC","type":["string","null"]},"billtemplateid":{"description":"The layout id of the bill template.","type":["integer","null"]},"cashbill":{"description":"A cash bill is marked as paid directly: 1=cash bill","type":["integer","null"]},"checkbillnum":{"description":"Check if the bill number is unique 1=on, 0=off","type":["integer","null"]},"city":{"description":"The mailing location of the debtor","type":"string"},"claimtext":{"description":"Reason for Recall and Recourse.","type":["string","null"]},"collectionprocess":{"description":"Type of receivable. Influences the collection process","type":["string","null"]},"color":{"description":"1=color, 0=black and white","type":["integer","null"]},"collectioninvoice":{"description":"1=Collection invoice, 0=Single invoice","type":["integer","null"]},"company":{"description":"Name of the corporate customer","type":"string"},"contactperson":{"description":"Contact person","type":["string","null"]},"contactpersontitle":{"description":"Contact person title","type":["string","null"]},"contactpersondepartment":{"description":"Contact person department","type":["string","null"]},"country":{"description":"Country where the corporate customer is registered","type":["string","null"]},"countryname":{"description":"Recipients country name","type":["string","null"]},"currency":{"description":"Currency of job","type":["string","null"]},"custnum":{"description":"The customer number of the customer in the principals system","type":["string","null"]},"customerid":{"description":"The customer number of the customer in Ropo One","type":["integer","null"]},"customertype":{"description":"Type of customer: 1=company, 2=natural person","type":"integer"},"deliverydate":{"description":"Products delivery date on invoice or cover note.","type":["string","null"],"format":"date"},"deliverymethod":{"description":"Products delivery method as text.","type":["string","null"]},"deliveryterm":{"description":"Terms of delivery as text.","type":["string","null"]},"department":{"description":"Recipients department","type":["string","null"]},"doublesided":{"description":"0=singleside(default), 1=use doublesided bill","type":["integer","null"]},"email":{"description":"The e-mail address to which the bill is sent","type":["string","null"]},"email2":{"description":"The second e-mail address to which the bill is sent","type":["string","null"]},"evoice":{"description":"Finnish e-invoice address","type":["string","null"]},"evoiceint":{"description":"The code of the intermediary in the e-invoice","type":["string","null"]},"finance":{"description":"1 = if funding applied from Ropo Finance.","type":["integer","null"]},"foreignamount":{"description":"Total amount of the bill in its original currency.","type":["number","null"]},"foreigncurrency":{"description":"TotalIdentifier of the currency used in the bill.","type":["string","null"]},"freetext":{"description":"Free text field at the end of the bill","type":["string","null"]},"govid":{"description":"The business ID (Y-tunnus) or personal identity code of the customer","type":["string","null"]},"jobtype":{"description":"Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service","type":"integer"},"language":{"description":"Language of the bill: eng, fin, swe, est","type":["string","null"]},"model":{"description":"Make, cost centre in the customers accounting or other reference","type":["string","null"]},"negvat":{"description":"1, if reverse VAT liability is used in the bill","type":["integer","null"]},"netamount":{"description":"Total amount of the bill without VAT","type":["number","null"]},"noticedate":{"description":"Date of the first payment notice.","type":["string","null"],"format":"date"},"noticedate2":{"description":"Date of the second payment notice.","type":["string","null"],"format":"date"},"noticedate3":{"description":"Date of the third payment notice.","type":["string","null"],"format":"date"},"noticedate4":{"description":"Date of the fourth payment notice.","type":["string","null"],"format":"date"},"noticefee":{"description":"Principals notice costs.","type":["number","null"]},"ordernumber":{"description":"Order number","type":["integer","null"]},"ourcode":{"description":"The principals reference","type":["string","null"]},"overdueinterest":{"description":"Delay interest rate","type":["number","null"]},"ovt":{"description":"OrganisationUnitNumber of recipient","type":["string","null"]},"ownref":{"description":"Temporary reference for sending","type":["string","null"]},"origbillnum":{"description":"Billnumber of collection invoices. Compulsory when invoice is sub invoice jobtype = 602.","type":["string","null"]},"paydate":{"description":"The due date of the bill","type":["string","null"],"format":"date"},"payplanamount":{"description":"Amount of one instalment in a payment schedule in euros.","type":["number","null"]},"payplancount":{"description":"The number of instalments in a payment schedule.","type":["integer","null"]},"payplaninterval":{"description":"Interval between instalments of the payment schedule in months.","type":["integer","null"]},"payplan":{"$ref":"#/components/schemas/JobPayplan"},"pdfname":{"description":"Predefined filename. This value is returned in preview and localprint responseheader","type":["string","null"]},"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"},"person":{"description":"The name of the consumer client","type":["string","null"]},"phone":{"description":"The phone number of the customer/buyer/debtor","type":["string","null"]},"postclass":{"description":"Class of the letter in the post: 1 or 2","type":"integer"},"postcode":{"description":"The postal code of the customer","type":["string","null"]},"putonhold":{"description":"Should jobstatus be changed to 100: 1 = yes, 0 = no","type":["integer","null"]},"refundtobillnum":{"description":"Bill number of the principal to which the credit note is allocated.","type":["string","null"]},"refundtojobid":{"description":"Assignment ID generated by Ropo to which the credit note is allocated.","type":["integer","null"]},"refundiban":{"description":"Account number where credit note is payed","type":["string","null"]},"refundmessage":{"description":"Message for payment of credit note","type":["string","null"]},"refundmessagetype":{"description":"Messagetype for payment of credit note: 1=Using reference, 3=Using message","type":["integer","null"]},"salesman":{"description":"The code of the salesman","type":["integer","null"]},"salesmanname":{"description":"Name or initials of the salesman","type":["string","null"]},"sendtype":{"description":"Type of sending of the bill: post, print, email or evoice","type":["string","null"]},"secondarysendtype":{"type":"array","items":{"$ref":"#/components/schemas/JobSendtype"}},"sensible":{"description":"Is a payment notice sent automatically: 1=no, 0=yes","type":["integer","null"]},"servicecode":{"description":"Cost center id","type":["string","null"]},"servicecode_name":{"description":"Cost center Name","type":["string","null"]},"servicecode_dimension":{"description":"Cost center code","type":["string","null"]},"TA0001":{"description":"Site key in construction invoices.","type":["string","null"]},"TA0002":{"description":"Site number in construction invoices.","type":["string","null"]},"TA0003":{"description":"Reported to the site register: Y = yes, N = no","type":["string","null"]},"totalamount":{"description":"Total bill amount including VAT","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":["number","null"]},"vatlayout":{"description":"VAT layout at invoice lines when only one is shown. 0 = Without VAT 1 = VAT included","type":["integer","null"]},"vatid":{"description":"The VAT ID of the customer","type":["string","null"]},"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"},"voucherbatch":{"description":"Voucher batch","type":["string","null"]},"vouchernum":{"description":"Voucher number","type":["string","null"]},"yourcode":{"description":"Reference of the buyer","type":["string","null"]},"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"]},"autogiro":{"description":"Used to determine that invoice is Autogiro type","type":["string","null"]},"subset":{"type":"array","items":{"$ref":"#/components/schemas/JobDataSet"}}},"type":"object"},"JobPayplan":{"title":"JobPayplan","description":"JobPayplan","properties":{"instalment":{"type":"array","items":{"$ref":"#/components/schemas/JobInstalment"}}},"type":"object"},"JobInstalment":{"title":"JobInstalment","description":"JobInstalment","properties":{"date":{"description":"Date of instalment","type":"string","format":"date"},"amount":{"description":"Amount of one instalment in a payment schedule in euros.","type":"number"}},"type":"object"},"JobSendtype":{"title":"JobSendtype","description":"JobSendtype","properties":{"sendtype":{"type":["string","null"]},"evoice":{"type":["string","null"]},"evoiceint":{"type":["string","null"]}},"type":"object"},"JobAddAddress":{"title":"JobAddAddress","description":"JobAddAddress","properties":{"address":{"type":["string","null"]},"city":{"type":["string","null"]},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"addresstype":{"description":"1 = postitusosoite, 2 = toimitusosoite, 3 = laskutusosoite, 4 = rinnakkais, 5 = toissijainen velallinen, 6 = muu, 7 = kayttopaikka, 8 = toimittaja","type":["number","null"]},"person":{"type":["string","null"]},"company":{"type":["string","null"]},"addresscountry":{"type":["string","null"]},"postcode":{"type":["string","null"]},"custnum":{"type":["string","null"]},"govid":{"description":"Identification of seller Business ID (Business Identity Code = Y-tunnus in Finnish or Persons social security number)","type":["string","null"]},"vatid":{"description":"VAT number","type":["string","null"]},"customertype":{"description":"1=comppany, 2=person","type":["integer","null"]},"email":{"description":"Contact email","type":["string","null"]},"phone":{"description":"Contact phone","type":["string","null"]},"partytext":{"description":"Description of address","type":["string","null"]},"partycode":{"description":"Business fields defined type code for address.","type":["string","null"]},"sitecode":{"description":"Code for address.","type":["string","null"]},"contactperson":{"type":["string","null"]},"countryname":{"type":["string","null"]},"ovt":{"description":"OrganisationUnitNumber","type":["string","null"]},"department":{"type":["string","null"]},"contactpersontitle":{"type":["string","null"]},"contactpersondepartment":{"type":["string","null"]}},"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"},"credit":{"description":"Accounting for the sales bill for the principals accounting","type":["number","null"]},"debit":{"description":"Accounting for the sales bill for the principals accounting","type":["number","null"]},"desc":{"description":"Explanation of the export line in the accounting of the sales bill","type":["string","null"]},"servicecode":{"description":"Cost centre","type":["string","null"]},"servicecode_name":{"description":"Cost centter name","type":["string","null"]},"netamount":{"description":"Total amount of the bill without VAT","type":"number"},"taxpr":{"description":"VAT percentage 0-100","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":"number"},"type":{"description":"Business type","type":["string","null"]},"type2":{"description":"Project number","type":["string","null"]},"type3":{"description":"Responsible unit","type":["string","null"]},"type4":{"description":"Business area number","type":["string","null"]},"type5":{"description":"Dimension data 5","type":["string","null"]},"type6":{"description":"Dimension data 6","type":["string","null"]},"type7":{"description":"Dimension data 7","type":["string","null"]},"type8":{"description":"Dimension data 8","type":["string","null"]},"type9":{"description":"Dimension data 9","type":["string","null"]},"type10":{"description":"Dimension data 10","type":["string","null"]},"kwh":{"description":"kWh","type":["number","null"]},"voucherbatch":{"description":"The voucher batch number in the principal's accounting.","type":["string","null"]},"batch":{"description":"The batch of accounting.","type":["string","null"]},"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"]}},"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"},"JobAttachment":{"title":"JobAttachment","description":"JobAttachment","properties":{"attachmentid":{"description":"Preloaded attachment from Ropo One","type":["integer","null"]},"attachmentfile":{"description":"Base64 encoded file","type":["string","null"]},"attachmentname":{"description":"Name of attachment","type":["string","null"]},"securityclass":{"description":"Security class of attachment.","type":["string","null"]},"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"]},"jobid":{"description":"Jobid of attachement","type":["integer","null"]}},"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"},"discountbaseamount":{"description":"Base amount for discount calculation in euros (Finland) or Swedish kronor (Sweden)","type":"number"},"discountdate":{"description":"The last date of validity of the cashiers discount","type":"string","format":"date"},"discountpercent":{"description":"Percentage of the cashiers discount of the bill amount including VAT","type":"number"},"discountfreetext":{"description":"Text displayed on the bill received by the customer to notify the customer of the cashiers discount.","type":["string","null"]}},"type":"object"},"JobContract":{"title":"JobContract","description":"JobContract","required":["contract_no"],"properties":{"contract_no":{"description":"Contract number","type":"string"},"name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"contractstatus":{"description":"Status of contract (active, closed, terminated)","type":["string","null"]},"type":{"description":"Type of contract (insurance)","type":["string","null"]},"termination_date":{"description":"Contract termination date","type":["string","null"]},"terminationterm":{"description":"Contract termination term. Number of days termination will be done.","type":["integer","null"]},"product":{"description":"Contract product name","type":["string","null"]}},"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"},"currency":{"description":"Original currency","type":"string"},"rate":{"description":"Rate of currency","type":"number"},"amount":{"description":"Original amount in target currency","type":"number"},"currency_date":{"description":"Date of currency.","type":["string","null"]}},"type":"object"},"JobDefinitions":{"title":"JobDefinitions","description":"JobDefinitions","properties":{"headertext":{"description":"Definition header text in Finvoice or Teapps invoice message.","type":["string","null"]},"code":{"description":"Defininition code in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcode":{"description":"Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcodeun":{"description":"EU UN Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]}},"type":"object"},"JobImage":{"title":"JobImage","description":"JobImage","required":["file"],"properties":{"file":{"description":"Base64 encoded pdf-file","type":"string"},"pagecount":{"description":"number of pages in the pdf-file","type":["integer","null"]},"fileType":{"description":"Attachment file type","type":["string","null"]}},"type":"object"},"JobLink":{"title":"JobLink","description":"JobAllowance","properties":{"name":{"description":"Name of link","type":["string","null"]},"link":{"description":"Actual link","type":["string","null"]}},"type":"object"},"JobPackageDetails":{"title":"JobPackageDetails","description":"JobPackageDetails","properties":{"packagelength":{"description":"Length of package","type":["string","null"]},"lengthquantityunitcode":{"description":"Length quantity unit code.","type":["string","null"]},"lengthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagewidth":{"description":"Width of package","type":["string","null"]},"widthquantityunitcode":{"description":"Width quantity unit code.","type":["string","null"]},"widthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageheight":{"description":"Height of package","type":["string","null"]},"heightquantityunitcode":{"description":"Height quantity unit code.","type":["string","null"]},"heightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageweight":{"description":"Total weight","type":["string","null"]},"weightquantityunitcode":{"description":"Total weight unit code","type":["string","null"]},"weightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagenetweight":{"description":"Net weight","type":["string","null"]},"netweightquantityunitcode":{"description":"Net weight unit code","type":["string","null"]},"netweightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagevolume":{"description":"Volume","type":["string","null"]},"volumequantityunitcode":{"description":"Volume unit code","type":["string","null"]},"volumequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"transportcarriagequantity":{"description":"Number of transport carriages","type":["string","null"]},"carriagequantityunitcode":{"description":"Number of items ( eg. Pcs, unit, piece)","type":["string","null"]},"carriagequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]}},"type":"object"},"JobPayee":{"title":"JobPayee","description":"JobPayee","required":["address","city","name","postcode","govid"],"properties":{"address":{"description":"Address of the payee","type":"string"},"address2":{"description":"Address line 2 of the payee","type":"string"},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"city":{"description":"City of the payee","type":"string"},"countryname":{"description":"Country of the payee","type":"string"},"countrycode":{"description":"Country code of the payee","type":"string"},"contact_email":{"description":"Contact email address of payee","type":["string","null"]},"contact_name":{"description":"Contact name of payee","type":["string","null"]},"contact_phone":{"description":"Contact phone of payee","type":["string","null"]},"govid":{"description":"y-tunnus","type":"string"},"name":{"description":"Name of payee","type":"string"},"name_extension":{"description":"Extension for payeename","type":["string","null"]},"ovt":{"description":"OVT of payee","type":["string","null"]},"postcode":{"description":"Postcode of payee","type":"string"},"vatid":{"description":"VAT number of payee","type":"string"},"www":{"description":"www-address of payee","type":["string","null"]},"fax":{"description":"fax number","type":["string","null"]},"bankinfos":{"type":"array","items":{"$ref":"#/components/schemas/JobBankInfo"}}},"type":"object"},"JobBankInfo":{"title":"JobBankInfo","description":"JobBankInfo","properties":{"name":{"description":"Name of the bank","type":"string"},"iban":{"description":"International Bank Account Number","type":"string"},"bic":{"description":"Bank Identification Code","type":"string"},"bban":{"description":"Basic Bank Account Number","type":"string"},"bankgiro":{"description":"Bankgiro","type":"string"},"plusgirot":{"description":"Plusgirot","type":"string"}},"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"]},"allownullvalues":{"description":"1=true, row does not have to have desc, count, amount, taxpr, vatamount, netamount, totalamount values","type":["boolean","null"]},"amount":{"description":"Unit price without VAT","type":["number","null"]},"count":{"description":"Number of units","type":["number","null"]},"desc":{"description":"Name of the product","type":["string","null"]},"discount":{"description":"Discount rate","type":["number","null"]},"eancode":{"description":"The EAN code","type":["string","null"]},"enddate":{"description":"The period end date (e.g. the hotel room check-out date)","type":["string","null"],"format":"date"},"freetext":{"description":"An explanation added to the product; may include several lines","type":["string","null"]},"invoicerowtype":{"description":"0 = normal, 25600 = Sub total row (does not affect invoice total), 25601 = Header row","type":["integer","null"]},"itemtype":{"description":"The unit of amount, e.g. pcs, h or m3","type":["string","null"]},"netamount":{"description":"Amount of the invoice line without VAT","type":["number","null"]},"priceunit":{"description":"Unit of unit price","type":["string","null"]},"productid":{"description":"Product ID","type":["string","null"]},"rowline":{"description":"The VAT amount of the invoice line","type":["integer","null"]},"rowtype":{"description":"Identifies invoice row debt type. 3 = capital, 6 = customer fee, 12 = customer reminder fee, etc.","type":["integer","null"]},"salesman":{"description":"The code of the salesman","type":["integer","null"]},"salesmanname":{"description":"Name or initials of the salesman","type":["string","null"]},"servicecode":{"description":"Cost centre","type":["string","null"]},"startdate":{"description":"The start date of the period (e.g. the hotel room check-in date)","type":["string","null"],"format":"date"},"storage":{"description":"Id of product in Ropo One storage. Need separate contract","type":["integer","null"]},"TA0001":{"description":"Site key in construction invoices.","type":["string","null"]},"TA0002":{"description":"Site number in construction invoices.","type":["string","null"]},"TA0003":{"description":"Reported to the site register: Y = yes, N = no","type":["string","null"]},"taxpr":{"description":"VAT percentage 0-100","type":["number","null"]},"totalamount":{"description":"The total price of an invoice line including VAT","type":["number","null"]},"itemprice":{"description":"Item price","type":["number","null"]},"totalitemprice":{"description":"Unit price including VAT","type":["number","null"]},"vatamount":{"description":"The VAT amount of the invoice line","type":["number","null"]},"vatcode":{"description":"VAT-code from Finvoice or CAB","type":["string","null"]},"vatfreetext":{"description":"Taxfree reason","type":["string","null"]},"subidentifier":{"description":"Finvoice RowSubIdentifier or SubIdentifier: Identifies invoice row in SubInvoicerow. Technical identifier if Sub invoice row is used","type":["string","null"]},"identifier":{"description":"Identifies invoice row capital or expence.","type":["string","null"]},"rowpositionidentifier":{"description":"Finvoice RowPositionIdentifier or SubRowPositionIdentifier: Identifies the invoice row","type":["string","null"]},"usageplacecode":{"description":"Usage place code","type":["string","null"]},"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"},"JobPropertyRow":{"title":"JobPropertyRow","description":"JobPropertyRow","required":["propname","propvalue"],"properties":{"propname":{"description":"Control data for invoice layout or debt recovery.","type":"string"},"propvalue":{"description":"Control data value provided with propname tag. ","type":"string"}},"type":"object"},"JobAllowance":{"title":"JobAllowance","description":"JobAllowance","required":["percent","amount","baseamount"],"properties":{"freetext":{"description":"Information in text format","type":["string","null"]},"reasoncode":{"description":"Check instructions from EU Norm BT-98","type":["string","null"]},"percent":{"description":"Percent","type":"number"},"amount":{"description":"Amount excluding VAT","type":"number"},"vatamount":{"description":"VAT amount","type":"number"},"baseamount":{"description":"Base amount, excluding VAT","type":"number"},"vatcategorycode":{"description":"VAT code","type":["string","null"]},"vatratepercent":{"description":"VAT percent","type":["number","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"},"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"},"JobMarks":{"title":"JobMarks","description":"JobMarks","properties":{"jobid":{"description":"Job ID","type":["integer","null"]},"statustime":{"description":"","type":["string","null"],"format":"datetime"},"text":{"description":"","type":["string","null"]},"whodid":{"description":"","type":["integer","null"]},"specialmark":{"description":"","type":["boolean","null"]},"customermark":{"description":"","type":["boolean","null"]},"restricted":{"description":"","type":["boolean","null"]}},"type":"object"},"JobTaxRow":{"title":"JobTaxRow","description":"JobTaxRow","required":["vatamount","netamount"],"properties":{"netamount":{"description":"Total amount of the bill without VAT","type":"number"},"taxpr":{"description":"The VAT percentage of the product in an invoice line or in the VAT breakdown","type":["number","null"]},"totalamount":{"description":"The total price of an invoice line including VAT","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":"number"},"vatfreetext":{"description":"Description of VAT","type":["string","null"]},"vatcode":{"description":"VAT code","type":["string","null"]},"vatexemptionreasoncode":{"description":"the reason for why the amount is exempted from VAT.\tBT-121","type":["string","null"]}},"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"},"source":{"description":"E-invoice additional data type: finvoice or teapps.","type":"string"},"code":{"description":"Machine-language name code for the additional data conveyed in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"group":{"description":"Group value for example delivery site code","type":["string","null"]}},"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"]},"fuse":{"type":["string","null"]},"usage_estimate":{"description":"Annual usage estimate","type":["string","null"]},"usage_estimate_unit":{"description":"Annual usage estimate unit","type":["string","null"]},"grid_usageplace":{"type":["string","null"]},"grid_edielno":{"type":["string","null"]},"grid_govid":{"type":["string","null"]},"gsrn_code":{"description":"Global Service Relation Number","type":["string","null"]},"consumptionhistory":{"type":"array","items":{"$ref":"#/components/schemas/JobUsagePlaceConsumptionHistory"}},"freetext":{"type":"array","items":{"$ref":"#/components/schemas/JobFreetext"}}},"type":"object"},"JobEnergyContract":{"title":"JobEnergyContract","description":"JobEnergyContract","properties":{"contract_no":{"description":"Contract number","type":["string","null"]},"name":{"type":["string","null"]},"vendor_name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"expdate":{"description":"Contract period end date.","type":["string","null"]}},"type":"object"},"JobUsagePlaceConsumptionHistory":{"title":"JobUsagePlaceConsumptionHistory","description":"JobUsagePlaceConsumptionHistory","properties":{"consumption":{"description":"consumption history value between start and end dates","type":"number"},"monthly_avg_peak":{"description":"Monthly Average Peak Value","type":"number"},"startdate":{"type":"string"},"enddate":{"description":"end date","type":["string","null"]},"yoy_percentage_change":{"description":"Year-over-year percentage change","type":["number","null"]}},"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"]},"textname":{"description":"Freetext name or header","type":["string","null"]},"textvalue":{"description":"Freetext","type":["string","null"]}},"type":"object"},"JobOriginalInvoiceReference":{"title":"JobOriginalInvoiceReference","description":"JobOriginalInvoiceReference","properties":{"invoicenumber":{"description":"Previous invoice number","type":"string"},"invoicedate":{"description":"Previous invoice date","type":"string"},"netamount":{"description":"Amount of the invoice without VAT","type":["number","null"]},"totalamount":{"description":"The total amount of an invoice including VAT","type":["number","null"]}},"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"},"real_annual_rate":{"description":"Real annual interest rate","type":"number"},"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"},"JobClassification":{"title":"JobClassification","description":"JobClassification","properties":{"documenttype":{"description":"Type of the document","type":["string","null"]}},"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"]},"delivery_channel_priority":{"description":"Comma separated list of delivery channels","type":["string","null"]}},"type":"object"}}}} ``` ## The JobDefinitions object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobDefinitions":{"title":"JobDefinitions","description":"JobDefinitions","properties":{"headertext":{"description":"Definition header text in Finvoice or Teapps invoice message.","type":["string","null"]},"code":{"description":"Defininition code in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcode":{"description":"Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcodeun":{"description":"EU UN Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]}},"type":"object"}}}} ``` ## The JobDeliveryStatusRequest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The JobDeliveryStatusRequestData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobDeliveryStatusRequestData":{"title":"JobDeliveryStatusRequestData","description":"JobDeliveryStatusRequestData","properties":{"reporterid":{"type":"string"},"documentid":{"type":"string"},"status":{"type":"string"},"statustime":{"type":"string"},"description":{"type":"string"}},"type":"object"}}}} ``` ## The JobDisputeRequest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobDisputeRequest":{"title":"JobDisputeRequest","description":"JobDisputeRequest","properties":{"data":{"$ref":"#/components/schemas/JobDisputeRequestData"}},"type":"object"},"JobDisputeRequestData":{"title":"JobDisputeRequestData","description":"JobDisputeRequestData","properties":{"description":{"type":"string"}},"type":"object"}}}} ``` ## The JobDisputeRequestData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobDisputeRequestData":{"title":"JobDisputeRequestData","description":"JobDisputeRequestData","properties":{"description":{"type":"string"}},"type":"object"}}}} ``` ## The JobDisputeResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The JobDisputeResponseData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The JobEnergyContract object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobEnergyContract":{"title":"JobEnergyContract","description":"JobEnergyContract","properties":{"contract_no":{"description":"Contract number","type":["string","null"]},"name":{"type":["string","null"]},"vendor_name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"expdate":{"description":"Contract period end date.","type":["string","null"]}},"type":"object"}}}} ``` ## The JobFreetext object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"]},"textname":{"description":"Freetext name or header","type":["string","null"]},"textvalue":{"description":"Freetext","type":["string","null"]}},"type":"object"}}}} ``` ## The JobImage object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobImage":{"title":"JobImage","description":"JobImage","required":["file"],"properties":{"file":{"description":"Base64 encoded pdf-file","type":"string"},"pagecount":{"description":"number of pages in the pdf-file","type":["integer","null"]},"fileType":{"description":"Attachment file type","type":["string","null"]}},"type":"object"}}}} ``` ## The JobInstalment object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobInstalment":{"title":"JobInstalment","description":"JobInstalment","properties":{"date":{"description":"Date of instalment","type":"string","format":"date"},"amount":{"description":"Amount of one instalment in a payment schedule in euros.","type":"number"}},"type":"object"}}}} ``` ## The JobInterestRate object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"real_annual_rate":{"description":"Real annual interest rate","type":"number"},"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"}}}} ``` ## The JobInvoicerowAddress object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The JobInvoicerowOverDue object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The JobJobInfo object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobJobInfo":{"title":"JobJobInfo","description":"JobJobInfo","properties":{"accountdate":{"description":"The date job was added","type":["string","null"],"format":"date"},"address":{"description":"The street address of the recipient","type":"string"},"addressaddline1":{"description":"The first additional line of the address card, printed above the name of the recipient","type":"string"},"addressaddline2":{"description":"The second additional line of the address card, printed between the name and the street address","type":"string"},"billcode":{"description":"Reference number or message, by which the payment is delivered to the biller","type":"string"},"billnum":{"description":"The current number of the bill in the accounting books of the principal","type":"string"},"city":{"description":"The mailing location of the debtor","type":"string"},"company":{"description":"Name of the corporate customer","type":"string"},"country":{"description":"Country where the corporate customer is registered","type":"string"},"currentpaydate":{"description":"Current paydate","type":"string"},"currentstatus":{"description":"Current status","type":"integer"},"currentstatustext":{"description":"Current statustext","type":"string"},"custnum":{"description":"The customer number of the customer in the principals system","type":"string"},"govid":{"description":"The business ID (Y-tunnus) or personal identity code of the customer","type":"string"},"jobid":{"description":"Job id","type":"integer"},"nextstatus":{"description":"Next status (-1 if next status is not available)","type":"integer"},"nextstatusdate":{"description":"Date when next status occurs","type":"string"},"nextstatustext":{"description":"Next status text","type":"string"},"origjobdate":{"description":"Date when job was originally received","type":"string"},"origjobtext":{"description":"Original status text","type":"string"},"origjobtype":{"description":"Jobtype when job was originally received","type":"integer"},"paydate":{"description":"Original duedate of the bill","type":"string"},"person":{"description":"The name of the consumer client","type":"string"},"postcode":{"description":"The postal code of the customer","type":"string"},"reference":{"description":"Reference number or message, by which the payment is delivered to the biller","type":"string"},"refundtojobid":{"description":"Assignment ID generated by Ropo to which the credit note is allocated.","type":"integer"},"vatid":{"description":"The VAT ID of the customer","type":"string"},"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"},"JobBreakdown":{"title":"JobBreakdown","description":"JobBreakdown","properties":{"billnum":{"description":"Laskunnumero","type":"string"},"origpaydate":{"description":"Original paydate","type":"string"},"capital":{"description":"Total amount of original capital","type":"number"},"interest":{"description":"Total amount of interests","type":"number"},"expenses":{"description":"Total amount of expenses","type":"number"},"netamount":{"description":"Total amount of open capital without VAT","type":"number"},"opencapital":{"description":"Total amount of open capital","type":"number"},"title":{"description":"Breakdown title","type":"string"},"vatamount":{"description":"Total VAT amount of open capital","type":"number"},"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"},"overdueinterest":{"description":"Overdueinterestpercentage","type":"number"}},"type":"object"},"JobCreditNotes":{"title":"JobCreditNotes","description":"JobCreditNotes","properties":{"creditnote":{"description":"List of credit invoices / notes","type":"array","items":{"$ref":"#/components/schemas/JobCreditNote"}}},"type":"object"},"JobCreditNote":{"title":"JobCreditNote","description":"JobCreditNote","required":["amount","date"],"properties":{"amount":{"description":"Amount of credit note","type":"number"},"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"billdate":{"description":"Date","type":"string"},"duedate":{"description":"Date","type":"string"},"allocated":{"description":"Allocated amount of credit note","type":"number"},"unallocated":{"description":"Unallocated amount of credit note","type":"number"},"job_allocated":{"type":"array","items":{"$ref":"#/components/schemas/JobAllocated"}}},"type":"object"},"JobAllocated":{"title":"JobAllocated","description":"JobAllocated","required":["allocated","billnum","jobid"],"properties":{"billnum":{"description":"Bill number of job.","type":"string"},"jobid":{"description":"Id of job.","type":"integer"},"allocated":{"description":"Allocated amount of credit note","type":"number"}},"type":"object"},"JobPayment":{"title":"JobPayment","description":"JobPayment","properties":{"amount":{"description":"Amount of payment","type":"number"},"desc":{"description":"Visible description to customer","type":"string"},"paydate":{"description":"Date of payment","type":"string"},"rowtype":{"description":"Type of row","type":"integer"},"rowtypetext":{"description":"Description of rowtype in text","type":"string"},"returndesc":{"description":"Type of returndesc","type":"integer"},"returndesctext":{"description":"Description of returndesc in text","type":"string"},"rowtime":{"description":"Timestamp of rowinsert","type":"string"},"statusid":{"description":"Id of payment","type":"integer"}},"type":"object"},"JobRefund":{"title":"JobRefund","description":"JobRefund","properties":{"amount":{"description":"Amount of refund","type":"number"},"date":{"description":"Date of refund","type":"string"},"jobid":{"description":"Assignment ID generated by Ropo to which the credit note is allocated.","type":"integer"}},"type":"object"},"JobStatus":{"title":"JobStatus","description":"JobStatus","properties":{"statuscode":{"description":"Code of status","type":"integer"},"statusref":{"description":"Short description of the update","type":"string"},"statustext":{"description":"Additional info of statusref","type":"number"},"statustime":{"description":"Time of status","type":"string"}},"type":"object"}}}} ``` ## The JobLink object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobLink":{"title":"JobLink","description":"JobAllowance","properties":{"name":{"description":"Name of link","type":["string","null"]},"link":{"description":"Actual link","type":["string","null"]}},"type":"object"}}}} ``` ## The JobMarks object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobMarks":{"title":"JobMarks","description":"JobMarks","properties":{"jobid":{"description":"Job ID","type":["integer","null"]},"statustime":{"description":"","type":["string","null"],"format":"datetime"},"text":{"description":"","type":["string","null"]},"whodid":{"description":"","type":["integer","null"]},"specialmark":{"description":"","type":["boolean","null"]},"customermark":{"description":"","type":["boolean","null"]},"restricted":{"description":"","type":["boolean","null"]}},"type":"object"}}}} ``` ## The JobOriginalInvoiceReference object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobOriginalInvoiceReference":{"title":"JobOriginalInvoiceReference","description":"JobOriginalInvoiceReference","properties":{"invoicenumber":{"description":"Previous invoice number","type":"string"},"invoicedate":{"description":"Previous invoice date","type":"string"},"netamount":{"description":"Amount of the invoice without VAT","type":["number","null"]},"totalamount":{"description":"The total amount of an invoice including VAT","type":["number","null"]}},"type":"object"}}}} ``` ## The JobPackageDetails object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobPackageDetails":{"title":"JobPackageDetails","description":"JobPackageDetails","properties":{"packagelength":{"description":"Length of package","type":["string","null"]},"lengthquantityunitcode":{"description":"Length quantity unit code.","type":["string","null"]},"lengthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagewidth":{"description":"Width of package","type":["string","null"]},"widthquantityunitcode":{"description":"Width quantity unit code.","type":["string","null"]},"widthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageheight":{"description":"Height of package","type":["string","null"]},"heightquantityunitcode":{"description":"Height quantity unit code.","type":["string","null"]},"heightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageweight":{"description":"Total weight","type":["string","null"]},"weightquantityunitcode":{"description":"Total weight unit code","type":["string","null"]},"weightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagenetweight":{"description":"Net weight","type":["string","null"]},"netweightquantityunitcode":{"description":"Net weight unit code","type":["string","null"]},"netweightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagevolume":{"description":"Volume","type":["string","null"]},"volumequantityunitcode":{"description":"Volume unit code","type":["string","null"]},"volumequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"transportcarriagequantity":{"description":"Number of transport carriages","type":["string","null"]},"carriagequantityunitcode":{"description":"Number of items ( eg. Pcs, unit, piece)","type":["string","null"]},"carriagequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]}},"type":"object"}}}} ``` ## The JobPartialPayment object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}}}} ``` ## The JobPatchOpenSalesInvoicesResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"billnum":{"description":"Bill number","type":"string"}},"type":"object"}}}} ``` ## The JobPatchOpenSalesInvoicesResponseResult object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobPatchOpenSalesInvoicesResponseResult":{"title":"JobPatchOpenSalesInvoicesResponseResult","description":"JobPatchOpenSalesInvoicesResponseResult","properties":{"jobid":{"description":"Job ID","type":"integer"},"billnum":{"description":"Bill number","type":"string"}},"type":"object"}}}} ``` ## The JobPayRow object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobPayRow":{"title":"JobPayRow","description":"JobPayRow","properties":{"accountid":{"description":"Account ID for the accounting of the company that uses the interface","type":["integer","null"]},"allownullvalues":{"description":"1=true, row does not have to have desc, count, amount, taxpr, vatamount, netamount, totalamount values","type":["boolean","null"]},"amount":{"description":"Unit price without VAT","type":["number","null"]},"count":{"description":"Number of units","type":["number","null"]},"desc":{"description":"Name of the product","type":["string","null"]},"discount":{"description":"Discount rate","type":["number","null"]},"eancode":{"description":"The EAN code","type":["string","null"]},"enddate":{"description":"The period end date (e.g. the hotel room check-out date)","type":["string","null"],"format":"date"},"freetext":{"description":"An explanation added to the product; may include several lines","type":["string","null"]},"invoicerowtype":{"description":"0 = normal, 25600 = Sub total row (does not affect invoice total), 25601 = Header row","type":["integer","null"]},"itemtype":{"description":"The unit of amount, e.g. pcs, h or m3","type":["string","null"]},"netamount":{"description":"Amount of the invoice line without VAT","type":["number","null"]},"priceunit":{"description":"Unit of unit price","type":["string","null"]},"productid":{"description":"Product ID","type":["string","null"]},"rowline":{"description":"The VAT amount of the invoice line","type":["integer","null"]},"rowtype":{"description":"Identifies invoice row debt type. 3 = capital, 6 = customer fee, 12 = customer reminder fee, etc.","type":["integer","null"]},"salesman":{"description":"The code of the salesman","type":["integer","null"]},"salesmanname":{"description":"Name or initials of the salesman","type":["string","null"]},"servicecode":{"description":"Cost centre","type":["string","null"]},"startdate":{"description":"The start date of the period (e.g. the hotel room check-in date)","type":["string","null"],"format":"date"},"storage":{"description":"Id of product in Ropo One storage. Need separate contract","type":["integer","null"]},"TA0001":{"description":"Site key in construction invoices.","type":["string","null"]},"TA0002":{"description":"Site number in construction invoices.","type":["string","null"]},"TA0003":{"description":"Reported to the site register: Y = yes, N = no","type":["string","null"]},"taxpr":{"description":"VAT percentage 0-100","type":["number","null"]},"totalamount":{"description":"The total price of an invoice line including VAT","type":["number","null"]},"itemprice":{"description":"Item price","type":["number","null"]},"totalitemprice":{"description":"Unit price including VAT","type":["number","null"]},"vatamount":{"description":"The VAT amount of the invoice line","type":["number","null"]},"vatcode":{"description":"VAT-code from Finvoice or CAB","type":["string","null"]},"vatfreetext":{"description":"Taxfree reason","type":["string","null"]},"subidentifier":{"description":"Finvoice RowSubIdentifier or SubIdentifier: Identifies invoice row in SubInvoicerow. Technical identifier if Sub invoice row is used","type":["string","null"]},"identifier":{"description":"Identifies invoice row capital or expence.","type":["string","null"]},"rowpositionidentifier":{"description":"Finvoice RowPositionIdentifier or SubRowPositionIdentifier: Identifies the invoice row","type":["string","null"]},"usageplacecode":{"description":"Usage place code","type":["string","null"]},"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"},"JobDefinitions":{"title":"JobDefinitions","description":"JobDefinitions","properties":{"headertext":{"description":"Definition header text in Finvoice or Teapps invoice message.","type":["string","null"]},"code":{"description":"Defininition code in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcode":{"description":"Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"unitcodeun":{"description":"EU UN Unit code for value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]}},"type":"object"},"JobPackageDetails":{"title":"JobPackageDetails","description":"JobPackageDetails","properties":{"packagelength":{"description":"Length of package","type":["string","null"]},"lengthquantityunitcode":{"description":"Length quantity unit code.","type":["string","null"]},"lengthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagewidth":{"description":"Width of package","type":["string","null"]},"widthquantityunitcode":{"description":"Width quantity unit code.","type":["string","null"]},"widthquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageheight":{"description":"Height of package","type":["string","null"]},"heightquantityunitcode":{"description":"Height quantity unit code.","type":["string","null"]},"heightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packageweight":{"description":"Total weight","type":["string","null"]},"weightquantityunitcode":{"description":"Total weight unit code","type":["string","null"]},"weightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagenetweight":{"description":"Net weight","type":["string","null"]},"netweightquantityunitcode":{"description":"Net weight unit code","type":["string","null"]},"netweightquantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"packagevolume":{"description":"Volume","type":["string","null"]},"volumequantityunitcode":{"description":"Volume unit code","type":["string","null"]},"volumequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]},"transportcarriagequantity":{"description":"Number of transport carriages","type":["string","null"]},"carriagequantityunitcode":{"description":"Number of items ( eg. Pcs, unit, piece)","type":["string","null"]},"carriagequantityunitcodeun":{"description":"Check instructions from EU Norm","type":["string","null"]}},"type":"object"},"JobPropertyRow":{"title":"JobPropertyRow","description":"JobPropertyRow","required":["propname","propvalue"],"properties":{"propname":{"description":"Control data for invoice layout or debt recovery.","type":"string"},"propvalue":{"description":"Control data value provided with propname tag. ","type":"string"}},"type":"object"},"JobAllowance":{"title":"JobAllowance","description":"JobAllowance","required":["percent","amount","baseamount"],"properties":{"freetext":{"description":"Information in text format","type":["string","null"]},"reasoncode":{"description":"Check instructions from EU Norm BT-98","type":["string","null"]},"percent":{"description":"Percent","type":"number"},"amount":{"description":"Amount excluding VAT","type":"number"},"vatamount":{"description":"VAT amount","type":"number"},"baseamount":{"description":"Base amount, excluding VAT","type":"number"},"vatcategorycode":{"description":"VAT code","type":["string","null"]},"vatratepercent":{"description":"VAT percent","type":["number","null"]}},"type":"object"},"JobLink":{"title":"JobLink","description":"JobAllowance","properties":{"name":{"description":"Name of link","type":["string","null"]},"link":{"description":"Actual link","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"},"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"}}}} ``` ## The JobPayee object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobPayee":{"title":"JobPayee","description":"JobPayee","required":["address","city","name","postcode","govid"],"properties":{"address":{"description":"Address of the payee","type":"string"},"address2":{"description":"Address line 2 of the payee","type":"string"},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"city":{"description":"City of the payee","type":"string"},"countryname":{"description":"Country of the payee","type":"string"},"countrycode":{"description":"Country code of the payee","type":"string"},"contact_email":{"description":"Contact email address of payee","type":["string","null"]},"contact_name":{"description":"Contact name of payee","type":["string","null"]},"contact_phone":{"description":"Contact phone of payee","type":["string","null"]},"govid":{"description":"y-tunnus","type":"string"},"name":{"description":"Name of payee","type":"string"},"name_extension":{"description":"Extension for payeename","type":["string","null"]},"ovt":{"description":"OVT of payee","type":["string","null"]},"postcode":{"description":"Postcode of payee","type":"string"},"vatid":{"description":"VAT number of payee","type":"string"},"www":{"description":"www-address of payee","type":["string","null"]},"fax":{"description":"fax number","type":["string","null"]},"bankinfos":{"type":"array","items":{"$ref":"#/components/schemas/JobBankInfo"}}},"type":"object"},"JobBankInfo":{"title":"JobBankInfo","description":"JobBankInfo","properties":{"name":{"description":"Name of the bank","type":"string"},"iban":{"description":"International Bank Account Number","type":"string"},"bic":{"description":"Bank Identification Code","type":"string"},"bban":{"description":"Basic Bank Account Number","type":"string"},"bankgiro":{"description":"Bankgiro","type":"string"},"plusgirot":{"description":"Plusgirot","type":"string"}},"type":"object"}}}} ``` ## The JobPayment object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobPayment":{"title":"JobPayment","description":"JobPayment","properties":{"amount":{"description":"Amount of payment","type":"number"},"desc":{"description":"Visible description to customer","type":"string"},"paydate":{"description":"Date of payment","type":"string"},"rowtype":{"description":"Type of row","type":"integer"},"rowtypetext":{"description":"Description of rowtype in text","type":"string"},"returndesc":{"description":"Type of returndesc","type":"integer"},"returndesctext":{"description":"Description of returndesc in text","type":"string"},"rowtime":{"description":"Timestamp of rowinsert","type":"string"},"statusid":{"description":"Id of payment","type":"integer"}},"type":"object"}}}} ``` ## The JobPayplan object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobPayplan":{"title":"JobPayplan","description":"JobPayplan","properties":{"instalment":{"type":"array","items":{"$ref":"#/components/schemas/JobInstalment"}}},"type":"object"},"JobInstalment":{"title":"JobInstalment","description":"JobInstalment","properties":{"date":{"description":"Date of instalment","type":"string","format":"date"},"amount":{"description":"Amount of one instalment in a payment schedule in euros.","type":"number"}},"type":"object"}}}} ``` ## The JobPropertyRow object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobPropertyRow":{"title":"JobPropertyRow","description":"JobPropertyRow","required":["propname","propvalue"],"properties":{"propname":{"description":"Control data for invoice layout or debt recovery.","type":"string"},"propvalue":{"description":"Control data value provided with propname tag. ","type":"string"}},"type":"object"}}}} ``` ## The JobRefund object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobRefund":{"title":"JobRefund","description":"JobRefund","properties":{"amount":{"description":"Amount of refund","type":"number"},"date":{"description":"Date of refund","type":"string"},"jobid":{"description":"Assignment ID generated by Ropo to which the credit note is allocated.","type":"integer"}},"type":"object"}}}} ``` ## The JobResolveDisputeRequest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobResolveDisputeRequest":{"title":"JobResolveDisputeRequest","description":"JobResolveDisputeRequest","properties":{"data":{"$ref":"#/components/schemas/JobResolveDisputeRequestData"}},"type":"object"},"JobResolveDisputeRequestData":{"title":"JobResolveDisputeRequestData","description":"JobResolveDisputeRequestData","properties":{"description":{"type":"string"}},"type":"object"}}}} ``` ## The JobResolveDisputeRequestData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobResolveDisputeRequestData":{"title":"JobResolveDisputeRequestData","description":"JobResolveDisputeRequestData","properties":{"description":{"type":"string"}},"type":"object"}}}} ``` ## The JobResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}},"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"},"amount":{"description":"","type":["number","null"]},"billnum":{"description":"The current number of the bill in the accounting books of the principal","type":"string"},"billcode":{"description":"The reference number generated by client","type":"string"},"error":{"description":"Reason for not accepting job","type":["string","null"]},"evoicetype":{"description":"More detail information if sendtype is evoice. Possible values are: elasku, suoramaksu, finvoice","type":["string","null"]},"jobid":{"description":"Task number created by Ropo One for the job","type":["integer","null"]},"jobstatus":{"description":"","type":"string"},"jobtype":{"description":"Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service","type":"string"},"notice":{"description":"Job is accepted but might need attention.","type":["array","null"],"items":{"type":"string"},"xml":{"name":"notes"}},"origbillnum":{"description":"Aggregate invoicing (jobtype=602) requires origbillnum.","type":["string","null"]},"ownref":{"description":"Temporary reference for sending","type":"integer"},"print":{"description":"If sendtype is print this returns same value as jobid. Else null.","type":["string","null"]},"receiver":{"type":"string"},"reference":{"description":"The reference number generated by Ropo One","type":"string"},"sendtype":{"description":"Type of sending of the bill: post, print, email or evoice","type":"string"}},"type":"object"},"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}}} ``` ## The JobResponseErrors object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}}} ``` ## The JobResponseResult object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"amount":{"description":"","type":["number","null"]},"billnum":{"description":"The current number of the bill in the accounting books of the principal","type":"string"},"billcode":{"description":"The reference number generated by client","type":"string"},"error":{"description":"Reason for not accepting job","type":["string","null"]},"evoicetype":{"description":"More detail information if sendtype is evoice. Possible values are: elasku, suoramaksu, finvoice","type":["string","null"]},"jobid":{"description":"Task number created by Ropo One for the job","type":["integer","null"]},"jobstatus":{"description":"","type":"string"},"jobtype":{"description":"Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service","type":"string"},"notice":{"description":"Job is accepted but might need attention.","type":["array","null"],"items":{"type":"string"},"xml":{"name":"notes"}},"origbillnum":{"description":"Aggregate invoicing (jobtype=602) requires origbillnum.","type":["string","null"]},"ownref":{"description":"Temporary reference for sending","type":"integer"},"print":{"description":"If sendtype is print this returns same value as jobid. Else null.","type":["string","null"]},"receiver":{"type":"string"},"reference":{"description":"The reference number generated by Ropo One","type":"string"},"sendtype":{"description":"Type of sending of the bill: post, print, email or evoice","type":"string"}},"type":"object"}}}} ``` ## The JobSendParameters object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"]},"delivery_channel_priority":{"description":"Comma separated list of delivery channels","type":["string","null"]}},"type":"object"}}}} ``` ## The JobSendtype object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobSendtype":{"title":"JobSendtype","description":"JobSendtype","properties":{"sendtype":{"type":["string","null"]},"evoice":{"type":["string","null"]},"evoiceint":{"type":["string","null"]}},"type":"object"}}}} ``` ## The JobStatus object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobStatus":{"title":"JobStatus","description":"JobStatus","properties":{"statuscode":{"description":"Code of status","type":"integer"},"statusref":{"description":"Short description of the update","type":"string"},"statustext":{"description":"Additional info of statusref","type":"number"},"statustime":{"description":"Time of status","type":"string"}},"type":"object"}}}} ``` ## The JobTaxRow object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobTaxRow":{"title":"JobTaxRow","description":"JobTaxRow","required":["vatamount","netamount"],"properties":{"netamount":{"description":"Total amount of the bill without VAT","type":"number"},"taxpr":{"description":"The VAT percentage of the product in an invoice line or in the VAT breakdown","type":["number","null"]},"totalamount":{"description":"The total price of an invoice line including VAT","type":["number","null"]},"vatamount":{"description":"Total VAT amount of the bill","type":"number"},"vatfreetext":{"description":"Description of VAT","type":["string","null"]},"vatcode":{"description":"VAT code","type":["string","null"]},"vatexemptionreasoncode":{"description":"the reason for why the amount is exempted from VAT.\tBT-121","type":["string","null"]}},"type":"object"}}}} ``` ## The JobUsagePlace object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobUsagePlace":{"title":"JobUsagePlace","description":"JobUsagePlace","properties":{"address":{"$ref":"#/components/schemas/JobAddAddress"},"energycontract":{"type":"array","items":{"$ref":"#/components/schemas/JobEnergyContract"}},"code":{"type":["string","null"]},"fuse":{"type":["string","null"]},"usage_estimate":{"description":"Annual usage estimate","type":["string","null"]},"usage_estimate_unit":{"description":"Annual usage estimate unit","type":["string","null"]},"grid_usageplace":{"type":["string","null"]},"grid_edielno":{"type":["string","null"]},"grid_govid":{"type":["string","null"]},"gsrn_code":{"description":"Global Service Relation Number","type":["string","null"]},"consumptionhistory":{"type":"array","items":{"$ref":"#/components/schemas/JobUsagePlaceConsumptionHistory"}},"freetext":{"type":"array","items":{"$ref":"#/components/schemas/JobFreetext"}}},"type":"object"},"JobAddAddress":{"title":"JobAddAddress","description":"JobAddAddress","properties":{"address":{"type":["string","null"]},"city":{"type":["string","null"]},"addressaddline1":{"description":"Line above name","type":["string","null"]},"addressaddline2":{"description":"Line between receivers name and address","type":["string","null"]},"addressaddline3":{"description":"Line between receivers name and address","type":["string","null"]},"addresstype":{"description":"1 = postitusosoite, 2 = toimitusosoite, 3 = laskutusosoite, 4 = rinnakkais, 5 = toissijainen velallinen, 6 = muu, 7 = kayttopaikka, 8 = toimittaja","type":["number","null"]},"person":{"type":["string","null"]},"company":{"type":["string","null"]},"addresscountry":{"type":["string","null"]},"postcode":{"type":["string","null"]},"custnum":{"type":["string","null"]},"govid":{"description":"Identification of seller Business ID (Business Identity Code = Y-tunnus in Finnish or Persons social security number)","type":["string","null"]},"vatid":{"description":"VAT number","type":["string","null"]},"customertype":{"description":"1=comppany, 2=person","type":["integer","null"]},"email":{"description":"Contact email","type":["string","null"]},"phone":{"description":"Contact phone","type":["string","null"]},"partytext":{"description":"Description of address","type":["string","null"]},"partycode":{"description":"Business fields defined type code for address.","type":["string","null"]},"sitecode":{"description":"Code for address.","type":["string","null"]},"contactperson":{"type":["string","null"]},"countryname":{"type":["string","null"]},"ovt":{"description":"OrganisationUnitNumber","type":["string","null"]},"department":{"type":["string","null"]},"contactpersontitle":{"type":["string","null"]},"contactpersondepartment":{"type":["string","null"]}},"type":"object"},"JobEnergyContract":{"title":"JobEnergyContract","description":"JobEnergyContract","properties":{"contract_no":{"description":"Contract number","type":["string","null"]},"name":{"type":["string","null"]},"vendor_name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"expdate":{"description":"Contract period end date.","type":["string","null"]}},"type":"object"},"JobUsagePlaceConsumptionHistory":{"title":"JobUsagePlaceConsumptionHistory","description":"JobUsagePlaceConsumptionHistory","properties":{"consumption":{"description":"consumption history value between start and end dates","type":"number"},"monthly_avg_peak":{"description":"Monthly Average Peak Value","type":"number"},"startdate":{"type":"string"},"enddate":{"description":"end date","type":["string","null"]},"yoy_percentage_change":{"description":"Year-over-year percentage change","type":["number","null"]}},"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"]},"textname":{"description":"Freetext name or header","type":["string","null"]},"textvalue":{"description":"Freetext","type":["string","null"]}},"type":"object"}}}} ``` ## The JobUsagePlaceConsumptionHistory object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobUsagePlaceConsumptionHistory":{"title":"JobUsagePlaceConsumptionHistory","description":"JobUsagePlaceConsumptionHistory","properties":{"consumption":{"description":"consumption history value between start and end dates","type":"number"},"monthly_avg_peak":{"description":"Monthly Average Peak Value","type":"number"},"startdate":{"type":"string"},"enddate":{"description":"end date","type":["string","null"]},"yoy_percentage_change":{"description":"Year-over-year percentage change","type":["number","null"]}},"type":"object"}}}} ``` ## The JobUsageplacePeaks object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobUsageplacePeaks":{"title":"JobUsageplacePeaks","description":"JobUsageplacePeaks","type":"object"}}}} ``` ## The JobXmlDetailsRow object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"source":{"description":"E-invoice additional data type: finvoice or teapps.","type":"string"},"code":{"description":"Machine-language name code for the additional data conveyed in Finvoice or Teapps invoice message.","type":["string","null"]},"value":{"description":"Value of the additional data entered in Finvoice or Teapps invoice message.","type":["string","null"]},"group":{"description":"Group value for example delivery site code","type":["string","null"]}},"type":"object"}}}} ``` ## The JobsStatusUpdatesCommonError object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobsStatusUpdatesCommonError":{"title":"JobsStatusUpdatesCommonError","description":"JobsStatusUpdatesCommonError","properties":{"commonerror":{"description":"Descriptive string of an error.","type":"string"}},"type":"object"}}}} ``` ## The JobsStatusUpdatesCommonErrorResult object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobsStatusUpdatesCommonErrorResult":{"title":"JobsStatusUpdatesCommonErrorResult","description":"JobsStatusUpdatesCommonErrorResult","properties":{"result":{"$ref":"#/components/schemas/JobsStatusUpdatesCommonError","description":"object."}},"type":"object"},"JobsStatusUpdatesCommonError":{"title":"JobsStatusUpdatesCommonError","description":"JobsStatusUpdatesCommonError","properties":{"commonerror":{"description":"Descriptive string of an error.","type":"string"}},"type":"object"}}}} ``` ## The JobsStatusUpdatesResult object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"statusid":{"description":"Id of the status update.","type":"string"},"billnum":{"description":"Invoice number.","type":"string"},"openamount":{"description":"Current open amount of invoice inclusing costs.","type":"number"},"origamount":{"description":"Original amount of the invoice including costs.","type":"number"},"opencapital":{"description":"Open capital.","type":"number"},"openinterest":{"description":"Open interest.","type":"number"},"openexpenses":{"description":"Open expenses.","type":"number"},"statustype":{"description":"Type of the status. Valid values are 'payment' and 'comment'.","type":"string","enum":["payment","comment"]},"statustime":{"description":"Time of the status update in 'YYYY-MM-DD HH:mm:ss' format.","type":"string"},"statusref":{"description":"Short description of the update.","type":"string"},"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"},"statuscode":{"description":"If statustype is 'comment' value contains status type code. In case statustype is 'payment', this will be empty.","type":"integer"},"paydate":{"description":"Paydate or empty. Format of the value is YYYY-M-DD.","type":"string"},"amount":{"description":"Paid or canceled amount.","type":"number"}},"type":"object"}}}} ``` ## The JobsStatusUpdatesStatus object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"},"statusid":{"description":"Id of the status update.","type":"string"},"billnum":{"description":"Invoice number.","type":"string"},"openamount":{"description":"Current open amount of invoice inclusing costs.","type":"number"},"origamount":{"description":"Original amount of the invoice including costs.","type":"number"},"opencapital":{"description":"Open capital.","type":"number"},"openinterest":{"description":"Open interest.","type":"number"},"openexpenses":{"description":"Open expenses.","type":"number"},"statustype":{"description":"Type of the status. Valid values are 'payment' and 'comment'.","type":"string","enum":["payment","comment"]},"statustime":{"description":"Time of the status update in 'YYYY-MM-DD HH:mm:ss' format.","type":"string"},"statusref":{"description":"Short description of the update.","type":"string"},"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"},"statuscode":{"description":"If statustype is 'comment' value contains status type code. In case statustype is 'payment', this will be empty.","type":"integer"},"paydate":{"description":"Paydate or empty. Format of the value is YYYY-M-DD.","type":"string"},"amount":{"description":"Paid or canceled amount.","type":"number"}},"type":"object"}}}} ``` ## The JobsStatusUpdatesStatusRecord object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobsStatusUpdatesStatusRecord":{"title":"JobsStatusUpdatesStatusRecord","description":"JobsStatusUpdatesStatusRecord","properties":{"jobid":{"description":"Job id.","type":"integer"},"statusid":{"description":"Id of the status update.","type":"string"},"billnum":{"description":"Invoice number.","type":"string"},"openamount":{"description":"Current open amount of invoice inclusing costs.","type":"number"},"origamount":{"description":"Original amount of the invoice including costs.","type":"number"},"opencapital":{"description":"Open capital.","type":"number"},"openinterest":{"description":"Open interest.","type":"number"},"openexpenses":{"description":"Open expenses.","type":"number"},"statustype":{"description":"Type of the status. Valid values are 'payment' and 'comment'.","type":"string","enum":["payment","comment"]},"statustime":{"description":"Time of the status update in 'YYYY-MM-DD HH:mm:ss' format.","type":"string"},"statusref":{"description":"Short description of the update.","type":"string"},"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"},"statuscode":{"description":"If statustype is 'comment' value contains status type code. In case statustype is 'payment', this will be empty.","type":"integer"},"paydate":{"description":"Paydate or empty. Format of the value is YYYY-M-DD.","type":"string"},"amount":{"description":"Paid or canceled amount.","type":"number"}},"type":"object"}}}} ``` ## The ReminderJobRowOverDue object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ReminderJobRowOverDue":{"title":"ReminderJobRowOverDue","description":"ReminderJobRowOverDue","properties":{"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"},"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_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"}}}} ``` ## The JobHandlerResponses object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobHandlerResponses":{"title":"JobHandlerResponses","description":"JobHandlerResponses","properties":{"allResponses":{"type":"array","items":{"$ref":"#/components/schemas/JobResponse"}}},"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"}},"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"},"amount":{"description":"","type":["number","null"]},"billnum":{"description":"The current number of the bill in the accounting books of the principal","type":"string"},"billcode":{"description":"The reference number generated by client","type":"string"},"error":{"description":"Reason for not accepting job","type":["string","null"]},"evoicetype":{"description":"More detail information if sendtype is evoice. Possible values are: elasku, suoramaksu, finvoice","type":["string","null"]},"jobid":{"description":"Task number created by Ropo One for the job","type":["integer","null"]},"jobstatus":{"description":"","type":"string"},"jobtype":{"description":"Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service","type":"string"},"notice":{"description":"Job is accepted but might need attention.","type":["array","null"],"items":{"type":"string"},"xml":{"name":"notes"}},"origbillnum":{"description":"Aggregate invoicing (jobtype=602) requires origbillnum.","type":["string","null"]},"ownref":{"description":"Temporary reference for sending","type":"integer"},"print":{"description":"If sendtype is print this returns same value as jobid. Else null.","type":["string","null"]},"receiver":{"type":"string"},"reference":{"description":"The reference number generated by Ropo One","type":"string"},"sendtype":{"description":"Type of sending of the bill: post, print, email or evoice","type":"string"}},"type":"object"},"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}}} ``` ## The Address object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Address":{"title":"Address","description":"Address","properties":{"isForeignAddress":{"description":"Is a foreign address","type":"boolean"},"Careof":{"description":"Care of","type":"string"},"Address1":{"description":"Delivery address 1","type":"string"},"Address2":{"description":"Delivery address 2","type":"string"},"CityCode":{"description":"Postal code (10000-99999), mandatory","type":"string"},"City":{"description":"City, mandatory","type":"string"},"Address3":{"description":"Delivery address 3","type":"string"},"CountryCode":{"description":"Country code (ISO 3166-1 alpha-2)","type":"string"},"CountryName":{"description":"Country name","type":"string"}},"type":"object"}}}} ``` ## The ApplicationAgency object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationAgency":{"title":"Agency","description":"Agency","properties":{"AgencyCode":{"description":"Agent's code","type":"string"},"AgencyName":{"description":"Agent's name","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Agent's contact information"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"}}}} ``` ## The ApplicationApplicant object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationApplicant":{"title":"Applicant","description":"Applicant","properties":{"OrganizationNo":{"description":"Applicant's personal/organization number","type":"string"},"Name":{"description":"Applicant's name","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Agent's contact information"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"}}}} ``` ## The ApplicationResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationResponse":{"title":"ApplicationResponse","description":"ApplicationResponse","properties":{"FileDate":{"description":"Date when the file is submitted to the authority.","type":"string"},"FileNo":{"description":"Incremental number that uniquely identifies the file.","type":"string"},"ReferenceNo":{"description":"The agent's reference number for the case.","type":"string"},"PartiesService":{"description":"Applicant/agent requests party service.","type":"boolean"},"PartiesServiceCost":{"description":"Compensation is claimed for any incurred service costs.","type":"boolean"},"PrimaryStatement":{"description":"Mandatory field if the document only contains certain types of partial claims.","type":"string"},"Agency":{"$ref":"#/components/schemas/ApplicationAgency","description":"Agency details."},"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialClaim":{"$ref":"#/components/schemas/PartialClaim","description":"Partial claims."},"Attachments":{"$ref":"#/components/schemas/Attachment","description":"List of attachments."}},"type":"object"},"ApplicationAgency":{"title":"Agency","description":"Agency","properties":{"AgencyCode":{"description":"Agent's code","type":"string"},"AgencyName":{"description":"Agent's name","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Agent's contact information"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"},"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"PartialClaim":{"title":"PartialClaim","description":"PartialClaim","properties":{"CapitalClaims":{"description":"Capital claims.","type":"array","items":{"$ref":"#/components/schemas/ApplicationCapital"}},"DelaymentFeeClaim":{"$ref":"#/components/schemas/ApplicationDelaymentFee","description":"Delay fee claim."}},"type":"object"},"ApplicationCapital":{"title":"Capital","description":"Capital","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialCaimNo":{"description":"The serial number of the partial claim in the order they are stated in the application document","type":"integer"},"ProofOfClaim":{"description":"Indicates if the claim contains a promissory note","type":"boolean"},"FormerCreditor":{"description":"Information about the original creditor, if any","type":"string"},"FormerCreditorSpecified":{"description":"If the field FormerCreditor is used or not","type":"boolean"},"HasAmountSpecified":{"description":"Indicates if the amount is specified","type":"boolean"},"Amount":{"description":"Claimed capital amount","type":"number"},"CurrencyCode":{"description":"Currency according to ISO-4217","type":"string"},"DueDate":{"description":"Claim's due date","type":"string"},"PrimaryStatement":{"description":"Basis of the claim","type":"string"},"HasAmountCalcInterestSpecified":{"description":"Indicates if the interest is specified","type":"boolean"},"AmountCalcInterest":{"description":"Amount on which interest is calculated","type":"number"},"Interest":{"$ref":"#/components/schemas/Interest","description":"Interest details."}},"type":"object"},"Interest":{"title":"Interest","description":"Interest","properties":{"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Accrued interest amount.","type":"number"},"HasFromDateSpecified":{"description":"Indicates if the from date is specified.","type":"boolean"},"FromDate":{"description":"From date for additional interest calculation.","type":"string"},"HasToDateSpecified":{"description":"Indicates if the to date is specified.","type":"boolean"},"ToDate":{"description":"To date for accrued interest calculation.","type":"string"},"HasInterestDateSpecified":{"description":"Indicates if the interest rate is specified.","type":"boolean"},"InterestRate":{"description":"Interest rate.","type":"number"},"InterestType":{"description":"Type of interest [1, 2, 3, 4, 5, 6, 7, 8].","type":"integer"},"OtherInterest":{"description":"Description of the interest, required if interest type = 6.","type":"integer"},"IsInterestAgreed":{"description":"Indicates if the interest is agreed upon.","type":"boolean"},"IssuanceDate":{"description":"Issuance date of the mortgage deed.","type":"string"}},"type":"object"},"ApplicationDelaymentFee":{"title":"DelaymentFee","description":"DelaymentFee","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialClaimNo":{"description":"The serial number of the partial claim in the order they are listed.","type":"integer"},"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Claimed amount.","type":"number","format":"float"},"PrimaryStatement":{"description":"Basic text for the claimed delay compensation.","type":"string"},"Interest":{"$ref":"#/components/schemas/Interest","description":"Interest details."}},"type":"object"},"Attachment":{"title":"Attachment","description":"Attachment","properties":{"AttachmentNo":{"description":"Numbering of specified attachments starting from 1","type":"integer"},"AttachmentName":{"description":"Naming/title for the attachment","type":"string"},"Document":{"description":"The document in PDF/A ? 1a converted to base64binary encoding","type":"string"}},"type":"object"}}}} ``` ## The ApplicationAssistance object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationAssistance":{"title":"Assistance","description":"Assistance","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialClaimNo":{"description":"The serial number of the partial claim in the order they are stated in the application document","type":"integer"},"AssistanceType":{"description":"Type of assistance, 1-7","type":"integer"},"ClaimText":{"description":"Information about what the defendant is requested to do, such as move, retrieve property","type":"string"},"StatementText":{"description":"Specifies the basis for the eviction/assistance claim","type":"string"}},"type":"object"},"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"}}}} ``` ## The Attachment object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Attachment":{"title":"Attachment","description":"Attachment","properties":{"AttachmentNo":{"description":"Numbering of specified attachments starting from 1","type":"integer"},"AttachmentName":{"description":"Naming/title for the attachment","type":"string"},"Document":{"description":"The document in PDF/A ? 1a converted to base64binary encoding","type":"string"}},"type":"object"}}}} ``` ## The ApplicationCapital object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationCapital":{"title":"Capital","description":"Capital","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialCaimNo":{"description":"The serial number of the partial claim in the order they are stated in the application document","type":"integer"},"ProofOfClaim":{"description":"Indicates if the claim contains a promissory note","type":"boolean"},"FormerCreditor":{"description":"Information about the original creditor, if any","type":"string"},"FormerCreditorSpecified":{"description":"If the field FormerCreditor is used or not","type":"boolean"},"HasAmountSpecified":{"description":"Indicates if the amount is specified","type":"boolean"},"Amount":{"description":"Claimed capital amount","type":"number"},"CurrencyCode":{"description":"Currency according to ISO-4217","type":"string"},"DueDate":{"description":"Claim's due date","type":"string"},"PrimaryStatement":{"description":"Basis of the claim","type":"string"},"HasAmountCalcInterestSpecified":{"description":"Indicates if the interest is specified","type":"boolean"},"AmountCalcInterest":{"description":"Amount on which interest is calculated","type":"number"},"Interest":{"$ref":"#/components/schemas/Interest","description":"Interest details."}},"type":"object"},"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"},"Interest":{"title":"Interest","description":"Interest","properties":{"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Accrued interest amount.","type":"number"},"HasFromDateSpecified":{"description":"Indicates if the from date is specified.","type":"boolean"},"FromDate":{"description":"From date for additional interest calculation.","type":"string"},"HasToDateSpecified":{"description":"Indicates if the to date is specified.","type":"boolean"},"ToDate":{"description":"To date for accrued interest calculation.","type":"string"},"HasInterestDateSpecified":{"description":"Indicates if the interest rate is specified.","type":"boolean"},"InterestRate":{"description":"Interest rate.","type":"number"},"InterestType":{"description":"Type of interest [1, 2, 3, 4, 5, 6, 7, 8].","type":"integer"},"OtherInterest":{"description":"Description of the interest, required if interest type = 6.","type":"integer"},"IsInterestAgreed":{"description":"Indicates if the interest is agreed upon.","type":"boolean"},"IssuanceDate":{"description":"Issuance date of the mortgage deed.","type":"string"}},"type":"object"}}}} ``` ## The ApplicationCollectionClaim object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationCollectionClaim":{"title":"CollectionClaim","description":"CollectionClaim","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialClaimNo":{"description":"The serial number of the partial claim in the order they are stated in the application document","type":"integer"},"HasPaymentPlanClaimAmountSpecified":{"description":"Is the claimed amount specified","type":"boolean"},"PaymentPlanClaimAmount":{"description":"Claimed amount for installment cost","type":"integer"},"HasRemainderClaimAmountSpecified":{"description":"Has the claimed amount for reminder fee been specified","type":"boolean"},"RemainderClaimAmount":{"description":"Claimed amount for reminder fee","type":"integer"},"HasCollectionCostClaimAmountSpecified":{"description":"Has the claimed amount for collection cost been specified","type":"boolean"},"CollectionCostClaimAmount":{"description":"Claimed capital amount","type":"integer"},"CollectionClaimDateList":{"description":"A list of all defendants responsible for the partial claim.","type":"array","items":{"$ref":"#/components/schemas/DateList"}},"Interest":{"$ref":"#/components/schemas/Interest","description":"Interest."}},"type":"object"},"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"},"DateList":{"title":"DateList","description":"DateList","properties":{"CollectionDate":{"description":"Collection date","type":"string"}},"type":"object"},"Interest":{"title":"Interest","description":"Interest","properties":{"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Accrued interest amount.","type":"number"},"HasFromDateSpecified":{"description":"Indicates if the from date is specified.","type":"boolean"},"FromDate":{"description":"From date for additional interest calculation.","type":"string"},"HasToDateSpecified":{"description":"Indicates if the to date is specified.","type":"boolean"},"ToDate":{"description":"To date for accrued interest calculation.","type":"string"},"HasInterestDateSpecified":{"description":"Indicates if the interest rate is specified.","type":"boolean"},"InterestRate":{"description":"Interest rate.","type":"number"},"InterestType":{"description":"Type of interest [1, 2, 3, 4, 5, 6, 7, 8].","type":"integer"},"OtherInterest":{"description":"Description of the interest, required if interest type = 6.","type":"integer"},"IsInterestAgreed":{"description":"Indicates if the interest is agreed upon.","type":"boolean"},"IssuanceDate":{"description":"Issuance date of the mortgage deed.","type":"string"}},"type":"object"}}}} ``` ## The Contact object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"}}}} ``` ## The DateList object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DateList":{"title":"DateList","description":"DateList","properties":{"CollectionDate":{"description":"Collection date","type":"string"}},"type":"object"}}}} ``` ## The ApplicationDefendant object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"}}}} ``` ## The ApplicationDelaymentFee object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationDelaymentFee":{"title":"DelaymentFee","description":"DelaymentFee","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialClaimNo":{"description":"The serial number of the partial claim in the order they are listed.","type":"integer"},"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Claimed amount.","type":"number","format":"float"},"PrimaryStatement":{"description":"Basic text for the claimed delay compensation.","type":"string"},"Interest":{"$ref":"#/components/schemas/Interest","description":"Interest details."}},"type":"object"},"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"},"Interest":{"title":"Interest","description":"Interest","properties":{"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Accrued interest amount.","type":"number"},"HasFromDateSpecified":{"description":"Indicates if the from date is specified.","type":"boolean"},"FromDate":{"description":"From date for additional interest calculation.","type":"string"},"HasToDateSpecified":{"description":"Indicates if the to date is specified.","type":"boolean"},"ToDate":{"description":"To date for accrued interest calculation.","type":"string"},"HasInterestDateSpecified":{"description":"Indicates if the interest rate is specified.","type":"boolean"},"InterestRate":{"description":"Interest rate.","type":"number"},"InterestType":{"description":"Type of interest [1, 2, 3, 4, 5, 6, 7, 8].","type":"integer"},"OtherInterest":{"description":"Description of the interest, required if interest type = 6.","type":"integer"},"IsInterestAgreed":{"description":"Indicates if the interest is agreed upon.","type":"boolean"},"IssuanceDate":{"description":"Issuance date of the mortgage deed.","type":"string"}},"type":"object"}}}} ``` ## The Interest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Interest":{"title":"Interest","description":"Interest","properties":{"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Accrued interest amount.","type":"number"},"HasFromDateSpecified":{"description":"Indicates if the from date is specified.","type":"boolean"},"FromDate":{"description":"From date for additional interest calculation.","type":"string"},"HasToDateSpecified":{"description":"Indicates if the to date is specified.","type":"boolean"},"ToDate":{"description":"To date for accrued interest calculation.","type":"string"},"HasInterestDateSpecified":{"description":"Indicates if the interest rate is specified.","type":"boolean"},"InterestRate":{"description":"Interest rate.","type":"number"},"InterestType":{"description":"Type of interest [1, 2, 3, 4, 5, 6, 7, 8].","type":"integer"},"OtherInterest":{"description":"Description of the interest, required if interest type = 6.","type":"integer"},"IsInterestAgreed":{"description":"Indicates if the interest is agreed upon.","type":"boolean"},"IssuanceDate":{"description":"Issuance date of the mortgage deed.","type":"string"}},"type":"object"}}}} ``` ## The MortgageDeed object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"MortgageDeed":{"title":"MortgageDeed","description":"MortgageDeed","properties":{"IssuanceDate":{"description":"Issuance date of the mortgage deed.","type":"string"},"MortgageDeedNo":{"description":"Mortgage deed number.","type":"string"},"SubMortgage":{"description":"Indicates if there is a sub-mortgage on the current mortgage deed.","type":"boolean"}},"type":"object"}}}} ``` ## The PartialClaim object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"PartialClaim":{"title":"PartialClaim","description":"PartialClaim","properties":{"CapitalClaims":{"description":"Capital claims.","type":"array","items":{"$ref":"#/components/schemas/ApplicationCapital"}},"DelaymentFeeClaim":{"$ref":"#/components/schemas/ApplicationDelaymentFee","description":"Delay fee claim."}},"type":"object"},"ApplicationCapital":{"title":"Capital","description":"Capital","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialCaimNo":{"description":"The serial number of the partial claim in the order they are stated in the application document","type":"integer"},"ProofOfClaim":{"description":"Indicates if the claim contains a promissory note","type":"boolean"},"FormerCreditor":{"description":"Information about the original creditor, if any","type":"string"},"FormerCreditorSpecified":{"description":"If the field FormerCreditor is used or not","type":"boolean"},"HasAmountSpecified":{"description":"Indicates if the amount is specified","type":"boolean"},"Amount":{"description":"Claimed capital amount","type":"number"},"CurrencyCode":{"description":"Currency according to ISO-4217","type":"string"},"DueDate":{"description":"Claim's due date","type":"string"},"PrimaryStatement":{"description":"Basis of the claim","type":"string"},"HasAmountCalcInterestSpecified":{"description":"Indicates if the interest is specified","type":"boolean"},"AmountCalcInterest":{"description":"Amount on which interest is calculated","type":"number"},"Interest":{"$ref":"#/components/schemas/Interest","description":"Interest details."}},"type":"object"},"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"},"Interest":{"title":"Interest","description":"Interest","properties":{"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Accrued interest amount.","type":"number"},"HasFromDateSpecified":{"description":"Indicates if the from date is specified.","type":"boolean"},"FromDate":{"description":"From date for additional interest calculation.","type":"string"},"HasToDateSpecified":{"description":"Indicates if the to date is specified.","type":"boolean"},"ToDate":{"description":"To date for accrued interest calculation.","type":"string"},"HasInterestDateSpecified":{"description":"Indicates if the interest rate is specified.","type":"boolean"},"InterestRate":{"description":"Interest rate.","type":"number"},"InterestType":{"description":"Type of interest [1, 2, 3, 4, 5, 6, 7, 8].","type":"integer"},"OtherInterest":{"description":"Description of the interest, required if interest type = 6.","type":"integer"},"IsInterestAgreed":{"description":"Indicates if the interest is agreed upon.","type":"boolean"},"IssuanceDate":{"description":"Issuance date of the mortgage deed.","type":"string"}},"type":"object"},"ApplicationDelaymentFee":{"title":"DelaymentFee","description":"DelaymentFee","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialClaimNo":{"description":"The serial number of the partial claim in the order they are listed.","type":"integer"},"HasAmountSpecified":{"description":"Indicates if the amount is specified.","type":"boolean"},"Amount":{"description":"Claimed amount.","type":"number","format":"float"},"PrimaryStatement":{"description":"Basic text for the claimed delay compensation.","type":"string"},"Interest":{"$ref":"#/components/schemas/Interest","description":"Interest details."}},"type":"object"}}}} ``` ## The ApplicationProcessCost object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationProcessCost":{"title":"ProcessCost","description":"ProcessCost","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialClaimNo":{"description":"The serial number of the partial claim in the order they are listed.","type":"integer"},"HasAgencyFeeSpecified":{"description":"Indicates if the agency fee is specified.","type":"boolean"},"AgencyFee":{"description":"Claimed amount for agency fee.","type":"number","format":"float"},"HasApplicationFeeSpecified":{"description":"Indicates if the application fee is specified.","type":"boolean"},"ApplicationFee":{"description":"Claimed amount for application fee.","type":"integer"},"HasOtherFeeSpecified":{"description":"Indicates if other fees are specified.","type":"boolean"},"OtherFee":{"description":"Claimed amount for other costs.","type":"integer"},"OtherFeeDescription":{"description":"Description of other costs claimed.","type":"string"}},"type":"object"},"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"}}}} ``` ## The ApplicationProperty object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ApplicationProperty":{"title":"Property","description":"Property","properties":{"Defendants":{"description":"List of defendants.","type":"array","items":{"$ref":"#/components/schemas/ApplicationDefendant"}},"PartialClaimNo":{"description":"The serial number of the partial claim in the order they are listed.","type":"integer"},"PropertyType":{"description":"Type of property [1, 2, 3, 4].","type":"integer"},"Description":{"description":"Details of the property to be established as collateral.","type":"string"}},"type":"object"},"ApplicationDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantIndex":{"description":"Defendant's index","type":"integer"},"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18,19or20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1","type":"string"},"Name2":{"description":"Defendant's name, Name field 2","type":"string"},"ContactInfo":{"$ref":"#/components/schemas/Contact","description":"Contact information for the defendant"},"AssignedProperty":{"description":"Description of assigned property","type":"string"},"ExecutionType":{"description":"Type of execution desired: ExecutionNotRequested, Esum [0-3]","type":"integer"}},"type":"object"},"Contact":{"title":"Contact","description":"Contact","properties":{"ContactType":{"description":"Contact type 0 or 1","type":"integer"},"Address":{"description":"Contact address","type":"string"},"Phone1":{"description":"Phone number 1","type":"string"},"Phone2":{"description":"Phone number 2","type":"string"},"Phone3":{"description":"Phone number 3","type":"string"},"Email":{"description":"Email","type":"string"},"Bankgiro":{"description":"Bankgiro, only for the applicant","type":"string"},"Plusgiro":{"description":"Plusgiro, only for the applicant","type":"string"},"Collector":{"description":"Applicant/agent's handler/department","type":"string"}},"type":"object"}}}} ``` ## The Responsible object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Responsible":{"title":"Responsible","description":"Responsible","properties":{"DefendantIndex":{"description":"Index of the defendant.","type":"integer"},"DefendantGuid":{"description":"GUID for a specific defendant.","type":"string"}},"type":"object"}}}} ``` ## The DeductionAgency object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionAgency":{"title":"Agency","description":"Agency","properties":{"AgencyCode":{"description":"The agent's code.","type":"string"},"AgencyName":{"description":"The agent's name.","type":"string"}},"type":"object"}}}} ``` ## The applicant\_deduction object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"applicant_deduction":{"title":"Applicant","description":"Applicant","properties":{"OrganizationNo":{"description":"Applicant's personal/organization number - N12, starts with 16, 18, 19, or 20.","type":"string"},"Name":{"description":"Applicant's name.","type":"string"}},"type":"object"}}}} ``` ## The DeductionAssistance object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionAssistance":{"title":"Assistance","description":"Assistance","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"},"ExecutionType":{"description":"Type of execution desired: 0 (ExecutionNotRequested), 1 (ExecutionRequested), 2 (ExecutionRequestedAndAssistance), 3 (Assistance)","type":"string"}},"type":"object"}}}} ``` ## The DeductionCapital object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionCapital":{"title":"Capital","description":"Capital","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasAmountSpecified":{"description":"Has claim amount been specified.","type":"boolean"},"Amount":{"description":"Claimed capital amount.","type":"number"},"HasAmountCalcInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AmountCalcInterest":{"description":"Amount on which interest is to be calculated.","type":"number"},"HasAccruedInterestSpecified":{"description":"Has interest rate been specified.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the amount is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in Amount, AmountCalcInterest, and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"},"ExecutionType":{"description":"Type of execution desired: 0 (ExecutionNotRequested), 1 (ExecutionRequested), 2 (ExecutionRequestedAndAssistance), 3 (Assistance)","type":"string"}},"type":"object"}}}} ``` ## The DeductionCollectionClaim object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionCollectionClaim":{"title":"CollectionClaim","description":"CollectionClaim","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasPaymentPlanClaimAmountSpecified":{"description":"Has claimed amount been specified.","type":"boolean"},"PaymentPlanClaimAmount":{"description":"Claimed amount for installment cost.","type":"integer"},"HasRemainderClaimAmountSpecified":{"description":"Has remainder claim amount been specified.","type":"boolean"},"RemainderClaimAmount":{"description":"Claimed amount for reminder fee.","type":"integer"},"HasCollectionCostClaimAmountSpecified":{"description":"Has collection cost claim amount been specified.","type":"boolean"},"CollectionCostClaimAmount":{"description":"Claimed amount for collection cost.","type":"integer"},"HasAccruedInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the collection cost is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in PaymentPlanClaimAmount, RemainderClaimAmount, CollectionCostClaimAmount, and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"},"ExecutionType":{"description":"Type of execution desired: 0 (ExecutionNotRequested), 1 (ExecutionRequested), 2 (ExecutionRequestedAndAssistance), 3 (Assistance)","type":"string"}},"type":"object"}}}} ``` ## The DeductionResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionResponse":{"title":"DeductionResponse","description":"DeductionResponse","properties":{"FileDate":{"description":"Date when the file is submitted to KFM.","type":"string"},"FileNo":{"description":"Incremental number that, together with the submitter code and file date, uniquely identifies the file. Should be a combination of three values: [SubmitterCode][FileDate][FileIncrementalNumber].","type":"string"},"ReferenceNo":{"description":"The agent's reference number for the case.","type":"string"},"JournalNo":{"description":"KFM case number. Specified as NN-NNNNNN-NN [0- 9]{2}-[0-9]{1,6}-[0-9]{2} or null.","type":"string"},"Agency":{"$ref":"#/components/schemas/DeductionAgency","description":"Agency details."},"Applicants":{"description":"List of applicants.","type":"array","items":{"$ref":"#/components/schemas/applicant_deduction"}},"PartialReductionClaim":{"$ref":"#/components/schemas/PartialReductionClaim","description":"Partial reduction claims."},"RevokeRequestedServiceOfProcess":{"description":"True/False if the requested service of process should be revoked.","type":"boolean"}},"type":"object"},"DeductionAgency":{"title":"Agency","description":"Agency","properties":{"AgencyCode":{"description":"The agent's code.","type":"string"},"AgencyName":{"description":"The agent's name.","type":"string"}},"type":"object"},"applicant_deduction":{"title":"Applicant","description":"Applicant","properties":{"OrganizationNo":{"description":"Applicant's personal/organization number - N12, starts with 16, 18, 19, or 20.","type":"string"},"Name":{"description":"Applicant's name.","type":"string"}},"type":"object"},"PartialReductionClaim":{"title":"PartialReductionClaim","description":"PartialReductionClaim","properties":{"CapitalClaims":{"description":"Items: Capital","type":"array","items":{"$ref":"#/components/schemas/DeductionCapital"}},"DelaymentFeeClaim":{"$ref":"#/components/schemas/DeductionDelaymentFee"},"CollectionClaims":{"description":"Items: CollectionClaim","type":"array","items":{"$ref":"#/components/schemas/DeductionCollectionClaim"}},"ProcessCostClaims":{"description":"Items: ProcessCost","type":"array","items":{"$ref":"#/components/schemas/DeductionProcessCost"}},"Assistances":{"description":"Items: Assistance","type":"array","items":{"$ref":"#/components/schemas/DeductionAssistance"}},"Properties":{"description":"Items: Property","type":"array","items":{"$ref":"#/components/schemas/DeductionProperty"}}},"type":"object"},"DeductionCapital":{"title":"Capital","description":"Capital","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasAmountSpecified":{"description":"Has claim amount been specified.","type":"boolean"},"Amount":{"description":"Claimed capital amount.","type":"number"},"HasAmountCalcInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AmountCalcInterest":{"description":"Amount on which interest is to be calculated.","type":"number"},"HasAccruedInterestSpecified":{"description":"Has interest rate been specified.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the amount is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in Amount, AmountCalcInterest, and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"},"ExecutionType":{"description":"Type of execution desired: 0 (ExecutionNotRequested), 1 (ExecutionRequested), 2 (ExecutionRequestedAndAssistance), 3 (Assistance)","type":"string"}},"type":"object"},"DeductionDelaymentFee":{"title":"DelaymentFee","description":"DelaymentFee","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasAmountSpecified":{"description":"Has claimed amount been specified.","type":"boolean"},"Amount":{"description":"Claimed amount.","type":"number"},"HasAccruedInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the amount is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in Amount and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"},"DefendantResponsible":{"title":"DefendantResponsible","description":"DefendantResponsible","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"}},"type":"object"},"DeductionCollectionClaim":{"title":"CollectionClaim","description":"CollectionClaim","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasPaymentPlanClaimAmountSpecified":{"description":"Has claimed amount been specified.","type":"boolean"},"PaymentPlanClaimAmount":{"description":"Claimed amount for installment cost.","type":"integer"},"HasRemainderClaimAmountSpecified":{"description":"Has remainder claim amount been specified.","type":"boolean"},"RemainderClaimAmount":{"description":"Claimed amount for reminder fee.","type":"integer"},"HasCollectionCostClaimAmountSpecified":{"description":"Has collection cost claim amount been specified.","type":"boolean"},"CollectionCostClaimAmount":{"description":"Claimed amount for collection cost.","type":"integer"},"HasAccruedInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the collection cost is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in PaymentPlanClaimAmount, RemainderClaimAmount, CollectionCostClaimAmount, and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionProcessCost":{"title":"ProcessCost","description":"ProcessCost","properties":{"PartialClaimNo":{"description":"The partial claim number. Should be the same partial claim number specified in the application document.","type":"integer"},"HasAgencyFeeSpecified":{"description":"Has the agency fee amount been specified.","type":"boolean"},"AgencyFee":{"description":"Claimed amount for agency fee.","type":"number"},"HasApplicationFeeSpecified":{"description":"Has the application fee amount been specified.","type":"boolean"},"ApplicationFee":{"description":"Claimed amount for application fee.","type":"integer"},"HasOtherFeeSpecified":{"description":"Has the other fee amount been specified.","type":"boolean"},"OtherFee":{"description":"Claimed amount for other costs.","type":"number"},"RecallPartialClaim":{"description":"If the partial claim should be withdrawn. If RecallPartialClaim = True, there should be no values in AgencyFee, ApplicationFee, and OtherFee, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Withdraws a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"},"DeductionAssistance":{"title":"Assistance","description":"Assistance","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionProperty":{"title":"Property","description":"Property","properties":{"PartialClaimNo":{"description":"The partial claim number. Should be the same partial claim number specified in the application document.","type":"integer"},"RecallPartialClaim":{"description":"If the partial claim should be withdrawn. If RecallPartialClaim = True, no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Withdraws a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"}}}} ``` ## The DeductionDefendant object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"},"ExecutionType":{"description":"Type of execution desired: 0 (ExecutionNotRequested), 1 (ExecutionRequested), 2 (ExecutionRequestedAndAssistance), 3 (Assistance)","type":"string"}},"type":"object"}}}} ``` ## The DefendantResponsible object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DefendantResponsible":{"title":"DefendantResponsible","description":"DefendantResponsible","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"}},"type":"object"}}}} ``` ## The DeductionDelaymentFee object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionDelaymentFee":{"title":"DelaymentFee","description":"DelaymentFee","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasAmountSpecified":{"description":"Has claimed amount been specified.","type":"boolean"},"Amount":{"description":"Claimed amount.","type":"number"},"HasAccruedInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the amount is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in Amount and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"},"DefendantResponsible":{"title":"DefendantResponsible","description":"DefendantResponsible","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"}},"type":"object"}}}} ``` ## The PartialReductionClaim object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"PartialReductionClaim":{"title":"PartialReductionClaim","description":"PartialReductionClaim","properties":{"CapitalClaims":{"description":"Items: Capital","type":"array","items":{"$ref":"#/components/schemas/DeductionCapital"}},"DelaymentFeeClaim":{"$ref":"#/components/schemas/DeductionDelaymentFee"},"CollectionClaims":{"description":"Items: CollectionClaim","type":"array","items":{"$ref":"#/components/schemas/DeductionCollectionClaim"}},"ProcessCostClaims":{"description":"Items: ProcessCost","type":"array","items":{"$ref":"#/components/schemas/DeductionProcessCost"}},"Assistances":{"description":"Items: Assistance","type":"array","items":{"$ref":"#/components/schemas/DeductionAssistance"}},"Properties":{"description":"Items: Property","type":"array","items":{"$ref":"#/components/schemas/DeductionProperty"}}},"type":"object"},"DeductionCapital":{"title":"Capital","description":"Capital","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasAmountSpecified":{"description":"Has claim amount been specified.","type":"boolean"},"Amount":{"description":"Claimed capital amount.","type":"number"},"HasAmountCalcInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AmountCalcInterest":{"description":"Amount on which interest is to be calculated.","type":"number"},"HasAccruedInterestSpecified":{"description":"Has interest rate been specified.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the amount is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in Amount, AmountCalcInterest, and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"},"ExecutionType":{"description":"Type of execution desired: 0 (ExecutionNotRequested), 1 (ExecutionRequested), 2 (ExecutionRequestedAndAssistance), 3 (Assistance)","type":"string"}},"type":"object"},"DeductionDelaymentFee":{"title":"DelaymentFee","description":"DelaymentFee","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasAmountSpecified":{"description":"Has claimed amount been specified.","type":"boolean"},"Amount":{"description":"Claimed amount.","type":"number"},"HasAccruedInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the amount is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in Amount and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"},"DefendantResponsible":{"title":"DefendantResponsible","description":"DefendantResponsible","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"}},"type":"object"},"DeductionCollectionClaim":{"title":"CollectionClaim","description":"CollectionClaim","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"HasPaymentPlanClaimAmountSpecified":{"description":"Has claimed amount been specified.","type":"boolean"},"PaymentPlanClaimAmount":{"description":"Claimed amount for installment cost.","type":"integer"},"HasRemainderClaimAmountSpecified":{"description":"Has remainder claim amount been specified.","type":"boolean"},"RemainderClaimAmount":{"description":"Claimed amount for reminder fee.","type":"integer"},"HasCollectionCostClaimAmountSpecified":{"description":"Has collection cost claim amount been specified.","type":"boolean"},"CollectionCostClaimAmount":{"description":"Claimed amount for collection cost.","type":"integer"},"HasAccruedInterestSpecified":{"description":"Has interest been calculated.","type":"boolean"},"AccruedInterest":{"description":"Accrued interest amount. If accrued interest exists, ToDate must be specified.","type":"number"},"HasFromDateSpecified":{"description":"Has from date been specified.","type":"boolean"},"FromDate":{"description":"From date from which additional interest is to be calculated. Should only be specified if interest rate is specified. Should not be specified if the amount is missing or zero. Should not be specified if NoInterestClaim = True. Should not be earlier than ToDate (but can be the same).","type":"string"},"HasToDateSpecified":{"description":"Has to date been specified.","type":"boolean"},"ToDate":{"description":"To date to which accrued interest is calculated. Must be specified if accrued interest exists and should not be specified if accrued interest is missing.","type":"string"},"NoInterestClaim":{"description":"If no additional interest on the collection cost is claimed, this should be specified as True. Even if this is True, accrued interest and ToDate can be specified.","type":"boolean"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, there should be no values in PaymentPlanClaimAmount, RemainderClaimAmount, CollectionCostClaimAmount, and AccruedInterest, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionProcessCost":{"title":"ProcessCost","description":"ProcessCost","properties":{"PartialClaimNo":{"description":"The partial claim number. Should be the same partial claim number specified in the application document.","type":"integer"},"HasAgencyFeeSpecified":{"description":"Has the agency fee amount been specified.","type":"boolean"},"AgencyFee":{"description":"Claimed amount for agency fee.","type":"number"},"HasApplicationFeeSpecified":{"description":"Has the application fee amount been specified.","type":"boolean"},"ApplicationFee":{"description":"Claimed amount for application fee.","type":"integer"},"HasOtherFeeSpecified":{"description":"Has the other fee amount been specified.","type":"boolean"},"OtherFee":{"description":"Claimed amount for other costs.","type":"number"},"RecallPartialClaim":{"description":"If the partial claim should be withdrawn. If RecallPartialClaim = True, there should be no values in AgencyFee, ApplicationFee, and OtherFee, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Withdraws a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"},"DeductionAssistance":{"title":"Assistance","description":"Assistance","properties":{"PartialClaimNo":{"description":"Serial number of the partial claim. Should be the same as specified in the application document.","type":"integer"},"RecallPartialClaim":{"description":"If the partial claim should be recalled. If RecallPartialClaim = True, no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Recalls a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DeductionDefendant"}}},"type":"object"},"DeductionProperty":{"title":"Property","description":"Property","properties":{"PartialClaimNo":{"description":"The partial claim number. Should be the same partial claim number specified in the application document.","type":"integer"},"RecallPartialClaim":{"description":"If the partial claim should be withdrawn. If RecallPartialClaim = True, no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Withdraws a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"}}}} ``` ## The DeductionProcessCost object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionProcessCost":{"title":"ProcessCost","description":"ProcessCost","properties":{"PartialClaimNo":{"description":"The partial claim number. Should be the same partial claim number specified in the application document.","type":"integer"},"HasAgencyFeeSpecified":{"description":"Has the agency fee amount been specified.","type":"boolean"},"AgencyFee":{"description":"Claimed amount for agency fee.","type":"number"},"HasApplicationFeeSpecified":{"description":"Has the application fee amount been specified.","type":"boolean"},"ApplicationFee":{"description":"Claimed amount for application fee.","type":"integer"},"HasOtherFeeSpecified":{"description":"Has the other fee amount been specified.","type":"boolean"},"OtherFee":{"description":"Claimed amount for other costs.","type":"number"},"RecallPartialClaim":{"description":"If the partial claim should be withdrawn. If RecallPartialClaim = True, there should be no values in AgencyFee, ApplicationFee, and OtherFee, and no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Withdraws a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"},"DefendantResponsible":{"title":"DefendantResponsible","description":"DefendantResponsible","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"}},"type":"object"}}}} ``` ## The DeductionProperty object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeductionProperty":{"title":"Property","description":"Property","properties":{"PartialClaimNo":{"description":"The partial claim number. Should be the same partial claim number specified in the application document.","type":"integer"},"RecallPartialClaim":{"description":"If the partial claim should be withdrawn. If RecallPartialClaim = True, no defendant should be specified in RecallResponsibleDefendants.","type":"boolean"},"RecallResponsibleDefendants":{"description":"Withdraws a specific defendant per partial claim. If any defendant is specified in RecallResponsibleDefendants, RecallPartialClaim should not be True.","type":"array","items":{"$ref":"#/components/schemas/DefendantResponsible"}}},"type":"object"},"DefendantResponsible":{"title":"DefendantResponsible","description":"DefendantResponsible","properties":{"DefendantGuid":{"description":"Defendant GUID for a specific defendant should contain an automatically generated and unique GUID.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, Name field 1.","type":"string"}},"type":"object"}}}} ``` ## The RecallAgency object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"RecallAgency":{"title":"Agency","description":"Agency","properties":{"AgencyCode":{"description":"The agent's code.","type":"string"},"AgencyName":{"description":"The agent's name.","type":"string"}},"type":"object"}}}} ``` ## The RecallApplicant object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"RecallApplicant":{"title":"Applicant","description":"Applicant","properties":{"OrganizationNo":{"description":"Applicant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name":{"description":"Applicant's name.","type":"string"}},"type":"object"}}}} ``` ## The RecallDefendant object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"RecallDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantGuid":{"description":"Defendant's GUID, must be automatically generated and unique.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, field 1.","type":"string"}},"type":"object"}}}} ``` ## The RecallResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"RecallResponse":{"title":"RecallResponse","description":"RecallResponse","properties":{"FileDate":{"description":"Date when the file is submitted to the authority.","type":"string"},"FileNo":{"description":"Incremental number that uniquely identifies the file along with agency code and file date.","type":"string"},"ReferenceNo":{"description":"The agent's reference number for the case.","type":"string"},"JournalNo":{"description":"Case number in the format NN-NNNNNN-NN or null.","type":"string"},"Agency":{"$ref":"#/components/schemas/RecallAgency","description":"Ombud."},"Applicants":{"description":"List of applicants.","type":"array","items":{"$ref":"#/components/schemas/RecallApplicant"}},"RecallEntireCase":{"description":"Recalls the entire case and all defendants. If true, RecallDefendants must be null.","type":"boolean"},"RecallDefendants":{"description":"Recalls specifically mentioned defendants. If any defendant is specified, RecallEntireCase must be false.","type":"array","items":{"$ref":"#/components/schemas/RecallDefendant"}}},"type":"object"},"RecallAgency":{"title":"Agency","description":"Agency","properties":{"AgencyCode":{"description":"The agent's code.","type":"string"},"AgencyName":{"description":"The agent's name.","type":"string"}},"type":"object"},"RecallApplicant":{"title":"Applicant","description":"Applicant","properties":{"OrganizationNo":{"description":"Applicant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name":{"description":"Applicant's name.","type":"string"}},"type":"object"},"RecallDefendant":{"title":"Defendant","description":"Defendant","properties":{"DefendantGuid":{"description":"Defendant's GUID, must be automatically generated and unique.","type":"string"},"OrganizationNo":{"description":"Defendant's personal/organization number - N12, starts with 16, 18, 19, or 20","type":"string"},"Name1":{"description":"Defendant's name, field 1.","type":"string"}},"type":"object"}}}} ``` ## The StatusRequest object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"StatusRequest":{"title":"StatusRequest","description":"StatusRequest","properties":{"ServiceFileType":{"description":"Type of file service - [COBB, RECEIPT, CONFIRMATION, REPORT].","type":"string"},"SequenceNo":{"description":"Sequence number of the application file.","type":"integer"},"ReferenceNo":{"description":"Applicant or agency reference number.","type":"string"},"ErrorMessages":{"description":"List of error messages of why the case was rejected.","type":"array","items":{"type":"string"}},"Data":{"description":"Object with different data depending on file service type.","type":"object"},"Status":{"description":"Status of update - [ACCEPTED, REJECTED, EXPORTED, CONFIRMED].","type":"string"}},"type":"object"}}}} ``` ## The OnlineLinkResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"OnlineLinkResponse":{"title":"OnlineLinkResponse","description":"OnlineLinkResponse","properties":{"url":{"type":"string"}},"type":"object"}}}} ``` ## The PaylinkResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"PaylinkResponse":{"title":"PaylinkResponse","description":"PaylinkResponse","properties":{"url":{"type":"string"}},"type":"object"}}}} ``` ## The ProductStockError object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ProductStockError":{"title":"ProductStockError","description":"ProductStockError","properties":{"errorId":{"type":"integer"},"errorText":{"type":"string"}},"type":"object"}}}} ``` ## The ProductStockGroup object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ProductStockGroup":{"title":"ProductStockGroup","description":"ProductStockGroup","properties":{"name":{"description":"Warehouse name","type":"string"},"totalamount":{"description":"Total amount of the stock item","type":"number"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductStockRow"}}},"type":"object"},"ProductStockRow":{"title":"ProductStockRow","description":"ProductStockRow","properties":{"productId":{"description":"Product id","type":"integer"},"name":{"description":"Product name","type":"string"},"code":{"description":"Product code","type":"string"},"amount":{"description":"Store value","type":"integer"},"count":{"description":"Store quantity","type":"integer"}},"type":"object"}}}} ``` ## The ProductStockResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ProductStockResponse":{"title":"ProductStockResponse","description":"ProductStockResponse","properties":{"created_at":{"description":"Event creation timestamp in ISO8601 format","type":"string","format":"date"},"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"},"ProductStockGroup":{"title":"ProductStockGroup","description":"ProductStockGroup","properties":{"name":{"description":"Warehouse name","type":"string"},"totalamount":{"description":"Total amount of the stock item","type":"number"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductStockRow"}}},"type":"object"},"ProductStockRow":{"title":"ProductStockRow","description":"ProductStockRow","properties":{"productId":{"description":"Product id","type":"integer"},"name":{"description":"Product name","type":"string"},"code":{"description":"Product code","type":"string"},"amount":{"description":"Store value","type":"integer"},"count":{"description":"Store quantity","type":"integer"}},"type":"object"}}}} ``` ## The ProductStockResult object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ProductStockResult":{"title":"ProductStockResult","description":"ProductStockResult","properties":{"productgroups":{"type":"array","items":{"$ref":"#/components/schemas/ProductStockGroup"}}},"type":"object"},"ProductStockGroup":{"title":"ProductStockGroup","description":"ProductStockGroup","properties":{"name":{"description":"Warehouse name","type":"string"},"totalamount":{"description":"Total amount of the stock item","type":"number"},"products":{"type":"array","items":{"$ref":"#/components/schemas/ProductStockRow"}}},"type":"object"},"ProductStockRow":{"title":"ProductStockRow","description":"ProductStockRow","properties":{"productId":{"description":"Product id","type":"integer"},"name":{"description":"Product name","type":"string"},"code":{"description":"Product code","type":"string"},"amount":{"description":"Store value","type":"integer"},"count":{"description":"Store quantity","type":"integer"}},"type":"object"}}}} ``` ## The ProductStockRow object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ProductStockRow":{"title":"ProductStockRow","description":"ProductStockRow","properties":{"productId":{"description":"Product id","type":"integer"},"name":{"description":"Product name","type":"string"},"code":{"description":"Product code","type":"string"},"amount":{"description":"Store value","type":"integer"},"count":{"description":"Store quantity","type":"integer"}},"type":"object"}}}} ``` ## The ReceiverResponse object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ReceiverResponse":{"title":"ReceiverResponse","description":"ReceiverResponse","properties":{"result":{"description":"Result","type":"string"},"errors":{"description":"Result","type":"string"}},"type":"object"}}}} ``` ## The OutDeliveryStatus object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"OutDeliveryStatus":{"title":"OutDeliveryStatus","description":"OutDeliveryStatus","properties":{"created_at":{"description":"Event creation timestamp in ISO8601 format","type":"string","format":"date"},"id":{"description":"Event identification","type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/OutDeliveryStatusData"}}},"type":"object"},"OutDeliveryStatusData":{"title":"OutDeliveryStatusData","description":"OutDeliveryStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"status":{"description":"Document status","type":"string"},"statustime":{"description":"Time when status changed. Local time format Y-m-d H:i:s","type":"string"},"description":{"description":"Status description","type":"string"},"distributionchannel":{"description":"Distribution channel","type":"string"}},"type":"object"}}}} ``` ## The OutDeliveryStatusData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"OutDeliveryStatusData":{"title":"OutDeliveryStatusData","description":"OutDeliveryStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"status":{"description":"Document status","type":"string"},"statustime":{"description":"Time when status changed. Local time format Y-m-d H:i:s","type":"string"},"description":{"description":"Status description","type":"string"},"distributionchannel":{"description":"Distribution channel","type":"string"}},"type":"object"}}}} ``` ## The AmountBreakdown object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"AmountBreakdown":{"title":"AmountBreakdown","description":"AmountBreakdown","properties":{"capital":{"description":"Capital amount","type":"number"},"interest":{"description":"Interest amount","type":"number"},"expenses":{"type":["number","null"],"default":0},"cashdiscount":{"description":"Cash discount amount","type":"number"}},"type":"object"}}}} ``` ## The ContractStatusData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"ContractStatusData":{"title":"ContractStatusData","description":"ContractStatusData","properties":{"contract_no":{"description":"Contract number","type":"string"},"jobid":{"description":"Job id","type":"string"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"contractstatus":{"description":"Status of contract (active, closed, terminated)","type":["string","null"]},"type":{"description":"Type of contract (insurance)","type":["string","null"]},"termination_date":{"description":"Contract termination date","type":["string","null"]},"terminationterm":{"description":"Contract termination term. Number of days termination will be done.","type":["integer","null"]},"description":{"description":"Status description","type":"string"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"}}}} ``` ## The DeliveryStatusData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeliveryStatusData":{"title":"DeliveryStatusData","description":"DeliveryStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"status":{"description":"Document status","type":"string"},"statustime":{"description":"Time when status changed","type":"string"},"description":{"description":"Status description","type":"string"},"distributionchannel":{"description":"Distribution channel","type":"string"},"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"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"},"DeliveryStatusNote":{"title":"DeliveryStatusNote","description":"DeliveryStatusNote","properties":{"note":{"description":"Notes reported to customer from the data.","type":"string"}},"type":"object"},"DeliveryStatusError":{"title":"DeliveryStatusError","description":"DeliveryStatusError","type":"object"}}}} ``` ## The DeliveryStatusError object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeliveryStatusError":{"title":"DeliveryStatusError","description":"DeliveryStatusError","type":"object"}}}} ``` ## The DeliveryStatusNote object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"DeliveryStatusNote":{"title":"DeliveryStatusNote","description":"DeliveryStatusNote","properties":{"note":{"description":"Notes reported to customer from the data.","type":"string"}},"type":"object"}}}} ``` ## The Expense object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Expense":{"title":"Expense","description":"Expense","properties":{"code":{"type":"integer"},"description":{"type":"string"},"amount":{"description":"Capital amount","type":"number"}},"type":"object"}}}} ``` ## The Invoice object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Invoice":{"title":"Status","description":"Status information provided from Ropo One.","properties":{"invoicenumber":{"description":"Invoicenumber","type":"string"},"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"}},"type":"object"}}}} ``` ## The JobCreditNoteData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobCreditNoteData":{"title":"JobCreditNoteData","description":"JobCreditNoteData","properties":{"creditjobid":{"description":"Ropo One ID for credit job","type":"integer"},"creditbillnum":{"description":"Credit billnum","type":"string"},"debitjobid":{"description":"Ropo One ID for debit job","type":"integer"},"debitbillnum":{"description":"Debit billnum","type":"string"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"amount":{"description":"Refunded or allocated amount","type":"string"},"time":{"description":"Time when status changed","type":"string"},"type":{"description":"Type of credit note change, refund or allocation","type":"string"},"description":{"description":"Status description","type":"string"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"}}}} ``` ## The JobDisconnectData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobDisconnectData":{"title":"JobDisconnectData","description":"JobDisconnectData","properties":{"customernumber":{"description":"Customernumber","type":"string"},"usageplacecode":{"description":"Usageplacecode","type":"string"},"contract_no":{"description":"Contractnumber","type":"string"},"invoices":{"description":"Array of Invoices","type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Description","type":"string"},"disconnectiondate":{"description":"Disconnect Date","type":"string"}},"type":"object"},"Invoice":{"title":"Status","description":"Status information provided from Ropo One.","properties":{"invoicenumber":{"description":"Invoicenumber","type":"string"},"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"}},"type":"object"}}}} ``` ## The JobReconnectData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobReconnectData":{"title":"JobReconnectData","description":"JobReconnectData","properties":{"customernumber":{"description":"Customernumber","type":"string"},"usageplacecode":{"description":"Usageplacecode","type":"string"},"contract_no":{"description":"Contractnumber","type":"string"},"invoices":{"description":"Array of Invoices","type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Description","type":"string"}},"type":"object"},"Invoice":{"title":"Status","description":"Status information provided from Ropo One.","properties":{"invoicenumber":{"description":"Invoicenumber","type":"string"},"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"}},"type":"object"}}}} ``` ## The JobStatusData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobStatusData":{"title":"JobStatusData","description":"JobStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"status":{"description":"Document status","type":"string"},"code":{"description":"Document status code value","type":"string"},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Status description","type":"string"},"paydate":{"description":"Original duedate","type":"string"},"currentpaydate":{"description":"Current duedate","type":"string"},"invoicenumber":{"description":"get billnum for status","type":"string"},"interest":{"description":"current interest","type":"number","format":"float"},"expenses":{"description":"current expenses","type":"number","format":"float"},"opencapital":{"description":"current opencapital","type":"number","format":"float"},"source":{"description":"Source for the status change","type":"string"},"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"}}}} ``` ## The JobStatusDataContract object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"JobStatusDataContract":{"title":"JobStatusDataContract","description":"JobStatusDataContract","properties":{"contract_no":{"type":"string"}},"type":"object"}}}} ``` ## The PaymentStatusData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"PaymentStatusData":{"title":"PaymentStatusData","description":"PaymentStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"amount":{"description":"Paid amount","type":"number"},"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"},"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"},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Information about payment","type":"string"},"paydate":{"description":"When payment was done","type":"string","deprecated":true},"reference":{"description":"Payment reference","type":"string"},"invoicenumber":{"description":"Used to get billnum","type":"string"},"paymentdate":{"description":"Payment registered in bank","type":"string"},"accountdate":{"description":"Payment received","type":"string"},"settlementdate":{"description":"Payment settled","type":"string"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"},"AmountBreakdown":{"title":"AmountBreakdown","description":"AmountBreakdown","properties":{"capital":{"description":"Capital amount","type":"number"},"interest":{"description":"Interest amount","type":"number"},"expenses":{"type":["number","null"],"default":0},"cashdiscount":{"description":"Cash discount amount","type":"number"}},"type":"object"}}}} ``` ## The Status object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"Status":{"title":"Status","description":"Status information provided from Ropo One.","properties":{"created_at":{"description":"Event creation timestamp in ISO8601 format","type":"string","format":"date"},"id":{"description":"Event identification","type":"string"},"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"}},"creditloss":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TimeBasedCreditLossStatusData"},"default":null}},"type":"object"},"ContractStatusData":{"title":"ContractStatusData","description":"ContractStatusData","properties":{"contract_no":{"description":"Contract number","type":"string"},"jobid":{"description":"Job id","type":"string"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"contractstatus":{"description":"Status of contract (active, closed, terminated)","type":["string","null"]},"type":{"description":"Type of contract (insurance)","type":["string","null"]},"termination_date":{"description":"Contract termination date","type":["string","null"]},"terminationterm":{"description":"Contract termination term. Number of days termination will be done.","type":["integer","null"]},"description":{"description":"Status description","type":"string"},"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"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"status":{"description":"Document status","type":"string"},"statustime":{"description":"Time when status changed","type":"string"},"description":{"description":"Status description","type":"string"},"distributionchannel":{"description":"Distribution channel","type":"string"},"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"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"},"DeliveryStatusNote":{"title":"DeliveryStatusNote","description":"DeliveryStatusNote","properties":{"note":{"description":"Notes reported to customer from the data.","type":"string"}},"type":"object"},"DeliveryStatusError":{"title":"DeliveryStatusError","description":"DeliveryStatusError","type":"object"},"JobStatusData":{"title":"JobStatusData","description":"JobStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"status":{"description":"Document status","type":"string"},"code":{"description":"Document status code value","type":"string"},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Status description","type":"string"},"paydate":{"description":"Original duedate","type":"string"},"currentpaydate":{"description":"Current duedate","type":"string"},"invoicenumber":{"description":"get billnum for status","type":"string"},"interest":{"description":"current interest","type":"number","format":"float"},"expenses":{"description":"current expenses","type":"number","format":"float"},"opencapital":{"description":"current opencapital","type":"number","format":"float"},"source":{"description":"Source for the status change","type":"string"},"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"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"amount":{"description":"Paid amount","type":"number"},"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"},"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"},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Information about payment","type":"string"},"paydate":{"description":"When payment was done","type":"string","deprecated":true},"reference":{"description":"Payment reference","type":"string"},"invoicenumber":{"description":"Used to get billnum","type":"string"},"paymentdate":{"description":"Payment registered in bank","type":"string"},"accountdate":{"description":"Payment received","type":"string"},"settlementdate":{"description":"Payment settled","type":"string"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"},"AmountBreakdown":{"title":"AmountBreakdown","description":"AmountBreakdown","properties":{"capital":{"description":"Capital amount","type":"number"},"interest":{"description":"Interest amount","type":"number"},"expenses":{"type":["number","null"],"default":0},"cashdiscount":{"description":"Cash discount amount","type":"number"}},"type":"object"},"JobCreditNoteData":{"title":"JobCreditNoteData","description":"JobCreditNoteData","properties":{"creditjobid":{"description":"Ropo One ID for credit job","type":"integer"},"creditbillnum":{"description":"Credit billnum","type":"string"},"debitjobid":{"description":"Ropo One ID for debit job","type":"integer"},"debitbillnum":{"description":"Debit billnum","type":"string"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"amount":{"description":"Refunded or allocated amount","type":"string"},"time":{"description":"Time when status changed","type":"string"},"type":{"description":"Type of credit note change, refund or allocation","type":"string"},"description":{"description":"Status description","type":"string"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"},"JobDisconnectData":{"title":"JobDisconnectData","description":"JobDisconnectData","properties":{"customernumber":{"description":"Customernumber","type":"string"},"usageplacecode":{"description":"Usageplacecode","type":"string"},"contract_no":{"description":"Contractnumber","type":"string"},"invoices":{"description":"Array of Invoices","type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Description","type":"string"},"disconnectiondate":{"description":"Disconnect Date","type":"string"}},"type":"object"},"Invoice":{"title":"Status","description":"Status information provided from Ropo One.","properties":{"invoicenumber":{"description":"Invoicenumber","type":"string"},"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"}},"type":"object"},"JobReconnectData":{"title":"JobReconnectData","description":"JobReconnectData","properties":{"customernumber":{"description":"Customernumber","type":"string"},"usageplacecode":{"description":"Usageplacecode","type":"string"},"contract_no":{"description":"Contractnumber","type":"string"},"invoices":{"description":"Array of Invoices","type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Description","type":"string"}},"type":"object"},"TimeBasedCreditLossStatusData":{"title":"TimeBasedCreditLossStatusData","description":"TimeBasedCreditLossStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"invoicenumber":{"description":"Billnum","type":"string"},"time":{"description":"Time","type":"string"},"amount":{"type":"number","format":"float"},"description":{"description":"Status description","type":"string"},"reason":{"type":"string"},"reference":{"type":"string"},"type":{"description":"Type of status update","type":"string","enum":["creditloss","suspected","changed"]},"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"},"creditloss":{"type":"number","format":"float"},"suspected_creditloss":{"type":["number","null"],"format":"float","default":null}},"type":"object"}}}} ``` ## The StatusData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"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"}},"creditloss":{"type":["array","null"],"items":{"$ref":"#/components/schemas/TimeBasedCreditLossStatusData"},"default":null}},"type":"object"},"ContractStatusData":{"title":"ContractStatusData","description":"ContractStatusData","properties":{"contract_no":{"description":"Contract number","type":"string"},"jobid":{"description":"Job id","type":"string"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"name":{"type":["string","null"]},"startdate":{"type":["string","null"]},"enddate":{"description":"Contract end date","type":["string","null"]},"contractstatus":{"description":"Status of contract (active, closed, terminated)","type":["string","null"]},"type":{"description":"Type of contract (insurance)","type":["string","null"]},"termination_date":{"description":"Contract termination date","type":["string","null"]},"terminationterm":{"description":"Contract termination term. Number of days termination will be done.","type":["integer","null"]},"description":{"description":"Status description","type":"string"},"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"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"status":{"description":"Document status","type":"string"},"statustime":{"description":"Time when status changed","type":"string"},"description":{"description":"Status description","type":"string"},"distributionchannel":{"description":"Distribution channel","type":"string"},"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"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"},"DeliveryStatusNote":{"title":"DeliveryStatusNote","description":"DeliveryStatusNote","properties":{"note":{"description":"Notes reported to customer from the data.","type":"string"}},"type":"object"},"DeliveryStatusError":{"title":"DeliveryStatusError","description":"DeliveryStatusError","type":"object"},"JobStatusData":{"title":"JobStatusData","description":"JobStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"status":{"description":"Document status","type":"string"},"code":{"description":"Document status code value","type":"string"},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Status description","type":"string"},"paydate":{"description":"Original duedate","type":"string"},"currentpaydate":{"description":"Current duedate","type":"string"},"invoicenumber":{"description":"get billnum for status","type":"string"},"interest":{"description":"current interest","type":"number","format":"float"},"expenses":{"description":"current expenses","type":"number","format":"float"},"opencapital":{"description":"current opencapital","type":"number","format":"float"},"source":{"description":"Source for the status change","type":"string"},"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"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"amount":{"description":"Paid amount","type":"number"},"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"},"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"},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Information about payment","type":"string"},"paydate":{"description":"When payment was done","type":"string","deprecated":true},"reference":{"description":"Payment reference","type":"string"},"invoicenumber":{"description":"Used to get billnum","type":"string"},"paymentdate":{"description":"Payment registered in bank","type":"string"},"accountdate":{"description":"Payment received","type":"string"},"settlementdate":{"description":"Payment settled","type":"string"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"},"AmountBreakdown":{"title":"AmountBreakdown","description":"AmountBreakdown","properties":{"capital":{"description":"Capital amount","type":"number"},"interest":{"description":"Interest amount","type":"number"},"expenses":{"type":["number","null"],"default":0},"cashdiscount":{"description":"Cash discount amount","type":"number"}},"type":"object"},"JobCreditNoteData":{"title":"JobCreditNoteData","description":"JobCreditNoteData","properties":{"creditjobid":{"description":"Ropo One ID for credit job","type":"integer"},"creditbillnum":{"description":"Credit billnum","type":"string"},"debitjobid":{"description":"Ropo One ID for debit job","type":"integer"},"debitbillnum":{"description":"Debit billnum","type":"string"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"amount":{"description":"Refunded or allocated amount","type":"string"},"time":{"description":"Time when status changed","type":"string"},"type":{"description":"Type of credit note change, refund or allocation","type":"string"},"description":{"description":"Status description","type":"string"},"customernumber":{"description":"Customer number from creditor's system","type":"string"}},"type":"object"},"JobDisconnectData":{"title":"JobDisconnectData","description":"JobDisconnectData","properties":{"customernumber":{"description":"Customernumber","type":"string"},"usageplacecode":{"description":"Usageplacecode","type":"string"},"contract_no":{"description":"Contractnumber","type":"string"},"invoices":{"description":"Array of Invoices","type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Description","type":"string"},"disconnectiondate":{"description":"Disconnect Date","type":"string"}},"type":"object"},"Invoice":{"title":"Status","description":"Status information provided from Ropo One.","properties":{"invoicenumber":{"description":"Invoicenumber","type":"string"},"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"}},"type":"object"},"JobReconnectData":{"title":"JobReconnectData","description":"JobReconnectData","properties":{"customernumber":{"description":"Customernumber","type":"string"},"usageplacecode":{"description":"Usageplacecode","type":"string"},"contract_no":{"description":"Contractnumber","type":"string"},"invoices":{"description":"Array of Invoices","type":"array","items":{"$ref":"#/components/schemas/Invoice"}},"time":{"description":"Time when status changed","type":"string"},"description":{"description":"Description","type":"string"}},"type":"object"},"TimeBasedCreditLossStatusData":{"title":"TimeBasedCreditLossStatusData","description":"TimeBasedCreditLossStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"invoicenumber":{"description":"Billnum","type":"string"},"time":{"description":"Time","type":"string"},"amount":{"type":"number","format":"float"},"description":{"description":"Status description","type":"string"},"reason":{"type":"string"},"reference":{"type":"string"},"type":{"description":"Type of status update","type":"string","enum":["creditloss","suspected","changed"]},"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"},"creditloss":{"type":"number","format":"float"},"suspected_creditloss":{"type":["number","null"],"format":"float","default":null}},"type":"object"}}}} ``` ## The TimeBasedCreditLossStatusData object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"TimeBasedCreditLossStatusData":{"title":"TimeBasedCreditLossStatusData","description":"TimeBasedCreditLossStatusData","properties":{"jobid":{"description":"Ropo One identification id for document","type":"integer"},"cid":{"description":"Ropo One identification id for customer / profile","type":"integer"},"documentid":{"description":"Customer own identification id for document if provided","type":"string"},"invoicenumber":{"description":"Billnum","type":"string"},"time":{"description":"Time","type":"string"},"amount":{"type":"number","format":"float"},"description":{"description":"Status description","type":"string"},"reason":{"type":"string"},"reference":{"type":"string"},"type":{"description":"Type of status update","type":"string","enum":["creditloss","suspected","changed"]},"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"},"creditloss":{"type":"number","format":"float"},"suspected_creditloss":{"type":["number","null"],"format":"float","default":null}},"type":"object"}}}} ``` ## The TimeBasedCreditLossStatusDataAmountBreakdown object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"TimeBasedCreditLossStatusDataAmountBreakdown":{"title":"TimeBasedCreditLossStatusDataAmountBreakdown","description":"TimeBasedCreditLossStatusDataAmountBreakdown","properties":{"capital":{"type":"number","format":"float"},"creditloss":{"type":"number","format":"float"},"suspected_creditloss":{"type":["number","null"],"format":"float","default":null}},"type":"object"}}}} ``` ## The UEInvoice object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"UEInvoice":{"title":"UEInvoice","description":"Invoice","properties":{"jobid":{"description":"Ropo One jobid","type":"integer"},"invoicenumber":{"description":"Invoicenumber","type":"string"}},"type":"object"}}}} ``` ## The UsageplaceEvent object ```json {"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"components":{"schemas":{"UsageplaceEvent":{"title":"UsageplaceEvent","description":"UsageplaceEvent","properties":{"id":{"description":"Unique id for the event","type":"string"},"usageplacecode":{"description":"Usageplacecode","type":"string"},"customernumber":{"description":"Customernumer","type":"string"},"contract_no":{"description":"Contractnumber","type":"string"},"invoices":{"type":"array","items":{"$ref":"#/components/schemas/UEInvoice"}},"time":{"description":"Time of event","type":"string"},"status":{"description":"Type of event","type":"string"},"description":{"description":"Further description of the event","type":"string"}},"type":"object"},"UEInvoice":{"title":"UEInvoice","description":"Invoice","properties":{"jobid":{"description":"Ropo One jobid","type":"integer"},"invoicenumber":{"description":"Invoicenumber","type":"string"}},"type":"object"}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://dev.ropo.com/api-reference/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.