# Jobs

Manage Jobs

## POST /rest/jobs/findbyendcustomer

> Find open jobs by end customer SSN or customer number

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"},"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"}}},"paths":{"/rest/jobs/findbyendcustomer":{"post":{"tags":["jobs"],"summary":"Find open jobs by end customer SSN or customer number","operationId":"JobsFindByEndCustomerAction","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobsByEndCustomerRequest"}}}},"responses":{"200":{"description":"Jobs found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobsByEndCustomerResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"404":{"description":"Not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}}}}}}}
```

## GET /jobs

> Get jobs

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}},"paths":{"/jobs":{"get":{"tags":["jobs"],"summary":"Get jobs","operationId":"JobGetJobAction","parameters":[{"name":"jobid","in":"query","description":"Id of the job","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobJobInfo"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}},"401":{"description":"Unauthorized"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}}}}}}}
```

## POST /jobs

> Add bills

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"}}},"paths":{"/jobs":{"post":{"tags":["jobs"],"summary":"Add bills","operationId":"JobAddJobAction","parameters":[{"name":"DataIdentifier","in":"header","description":"Data identifier defined by customer for tracking purposes","required":false,"schema":{"type":"string"}},{"name":"DataTypeIdentifier","in":"header","description":"Data type identifier","required":false,"schema":{"type":"string"}},{"name":"Content-Type","in":"header","description":"Content type","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"Job","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"201":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"401":{"description":"Unauthorized"},"429":{"description":"Too many requests - Too many concurrent requests for this customer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}}}}}}}
```

## PATCH /jobs

> Modify existing bill data

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}},"paths":{"/jobs":{"patch":{"tags":["jobs"],"summary":"Modify existing bill data","operationId":"JobPatchJobAction","parameters":[{"name":"jobid","in":"query","description":"Id of the job to modify [jobid or billnum is required]","required":false,"schema":{"type":"integer"}},{"name":"billnum","in":"query","description":"Billnum of the job to modify [jobid or billnum is required]","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"JSON defining only the fields to modify. Currently supported: 'paydate', 'addaddress'.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDataSet"}}}},"responses":{"200":{"description":"Successful operation"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}}}}}}}
```

## GET /jobs/statusupdates

> Get jobs status update information

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"}}},"paths":{"/jobs/statusupdates":{"get":{"tags":["jobs"],"summary":"Get jobs status update information","operationId":"JobsGetStatusUpdatesAction","parameters":[{"name":"date","in":"query","description":"Date (YYYY-MM-DD) to define to get all status update of given day.","required":false,"schema":{"type":"string"}},{"name":"billnum","in":"query","description":"Invoice number. Response will contain all status updates for the invoice.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobsStatusUpdatesResult"}}}},"204":{"description":"No Content, No status updates to return"},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobsStatusUpdatesCommonErrorResult"}}}},"401":{"description":"Unauthorized"}}}}}}
```

## GET /jobs/pdf

> Get bill in pdf-format

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}},"paths":{"/jobs/pdf":{"get":{"tags":["jobs"],"summary":"Get bill in pdf-format","operationId":"JobsGetPdfAction","parameters":[{"name":"jobid","in":"query","description":"Id of the job [contractnum, billnum or jobid is required]","required":false,"schema":{"type":"integer"}},{"name":"billnum","in":"query","description":"Billnum of the job [contractnum, billnum or jobid is required]","required":false,"schema":{"type":"string"}},{"name":"contractnum","in":"query","description":"Contractnum of the job [contractnum, billnum or jobid is required]","required":false,"schema":{"type":"string"}},{"name":"documentdate","in":"query","description":"Document date of the job [also contractnum or billnum is required]","required":false,"schema":{"type":"string"}},{"name":"origdata","in":"query","description":"0 = current, 1 = original[default]","required":false,"schema":{"type":"integer"}},{"name":"documenttype","in":"query","description":"Documenttype for Joisto archive.","required":false,"schema":{"type":"string"}},{"name":"joistocolumn","in":"query","description":"Column name in Joisto archive (JobId, Laskunumero, Laskunro)","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns PDF","content":{"application/pdf":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}}}}}}}
```

## PATCH /jobs/opensalesinvoices

> Modify existing bill data for multiple open invoices by customer and order number

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"},"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}},"paths":{"/jobs/opensalesinvoices":{"patch":{"tags":["jobs"],"summary":"Modify existing bill data for multiple open invoices by customer and order number","operationId":"patchOpenSalesInvoicesAction","parameters":[{"name":"custnum","in":"query","description":"Customer number of job(s) to modify","required":true,"schema":{"type":"string"}},{"name":"ordernumber","in":"query","description":"Order number of job(s) to modify","required":true,"schema":{"type":"string"}}],"requestBody":{"description":"JSON defining only the fields to modify. Currently 'addaddress' is the only one supported.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDataSet"}}}},"responses":{"200":{"description":"Successful operation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobPatchOpenSalesInvoicesResponse"}}}},"204":{"description":"No content (no jobs were updated)"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden (customer type mismatch)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}}}}}}}
```

## PATCH /jobs/deliverystatus

> Update invoice delivery status

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}},"paths":{"/jobs/deliverystatus":{"patch":{"tags":["jobs"],"summary":"Update invoice delivery status","operationId":"patchJobsDeliveryStatus","requestBody":{"description":"JSON defining status udpate","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDeliveryStatusRequest"}}}},"responses":{"200":{"description":"Successful operation"},"204":{"description":"No content (no jobs were updated)"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}}}}}}}
```

## POST /jobs/preview

> Preview of the invoice

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"}}},"paths":{"/jobs/preview":{"post":{"tags":["jobs"],"summary":"Preview of the invoice","operationId":"JobPreviewJobAction","parameters":[{"name":"DataIdentifier","in":"header","description":"Data identifier defined by customer for tracking purposes","required":false,"schema":{"type":"string"}},{"name":"DataTypeIdentifier","in":"header","description":"Data type identifier","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"Data sent. Can be JSON defined by the Job Model, but also mutually agreed custom data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"201":{"description":"Returns PDF","headers":{"pdfname":{"description":"pdf filename","schema":{"type":"string"}}},"content":{"application/pdf":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"401":{"description":"Unauthorized"}}}}}}
```

## POST /jobs/localprint

> Print locally the invoice

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"}}},"paths":{"/jobs/localprint":{"post":{"tags":["jobs"],"summary":"Print locally the invoice","operationId":"JobLocalprintJobAction","parameters":[{"name":"DataIdentifier","in":"header","description":"Data identifier defined by customer for tracking purposes","required":false,"schema":{"type":"string"}},{"name":"DataTypeIdentifier","in":"header","description":"Data type identifier","required":false,"schema":{"type":"string"}}],"requestBody":{"description":"Data sent. Can be JSON defined by the Job Model, but also mutually agreed custom data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Job"}}}},"responses":{"201":{"description":"Returns PDF","headers":{"pdfname":{"description":"pdf filename","schema":{"type":"string"}}},"content":{"application/pdf":{}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponse"}}}},"401":{"description":"Unauthorized"}}}}}}
```

## POST /jobs/payment

> Add payment to existing job.

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"}}},"paths":{"/jobs/payment":{"post":{"tags":["jobs"],"summary":"Add payment to existing job.","operationId":"JobAddPaymentJobAction","requestBody":{"description":"JobAddPayment","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAddPayment"}}}},"responses":{"201":{"description":"Payment response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAddPaymentResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAddPaymentResponse"}}}},"401":{"description":"Unauthorized"}}}}}}
```

## POST /jobs/creditnote

> Add credit note to existing job

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"}}},"paths":{"/jobs/creditnote":{"post":{"tags":["jobs"],"summary":"Add credit note to existing job","operationId":"JobAddCreditNoteJobAction","requestBody":{"description":"JobAddCreditNote","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAddCreditNote"}}}},"responses":{"201":{"description":"Credit note response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAddCreditNoteResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobAddCreditNoteResponse"}}}},"401":{"description":"Unauthorized"}}}}}}
```

## GET /jobs/transferconfirmation

> Send transfer report based on Batch ID

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"schemas":{"JobResponseErrors":{"title":"JobResponseErrors","description":"JobResponseErrors","properties":{"error":{"description":"Error description.","type":"string"}},"type":"object"}}},"paths":{"/jobs/transferconfirmation":{"get":{"tags":["jobs"],"summary":"Send transfer report based on Batch ID","operationId":"TransferConfirmationTransfer","parameters":[{"name":"batchid","in":"query","description":"Transferconfirmation batchid identifier","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"successful operation"},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}},"404":{"description":"report not found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResponseErrors"}}}}}}}}}
```

## POST /jobs/dispute

> Dispute a job

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"},"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"}}},"paths":{"/jobs/dispute":{"post":{"tags":["jobs"],"summary":"Dispute a job","operationId":"disputeJobAction","parameters":[{"name":"jobid","in":"query","description":"Job ID, required if invoice number not given.","schema":{"type":"string"}},{"name":"invoice_number","in":"query","description":"Invoice number, required if job ID not given.","schema":{"type":"string"}}],"requestBody":{"description":"JSON data with dispute reason in description.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDisputeRequest"}}}},"responses":{"200":{"description":"Returns success message if job was succesfully disputed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDisputeResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}}}}}}}
```

## POST /jobs/dispute/resolve

> Resolve a disputed job

```json
{"openapi":"3.1.0","info":{"title":"Ropo One","version":"1.0.0"},"tags":[{"name":"jobs","description":"Manage Jobs"}],"servers":[{"url":"/rest","description":"Ropo One"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","bearerFormat":"JWT","scheme":"bearer"}},"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"},"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"},"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"}}},"paths":{"/jobs/dispute/resolve":{"post":{"tags":["jobs"],"summary":"Resolve a disputed job","operationId":"resolveDisputeJobAction","parameters":[{"name":"jobid","in":"query","description":"Job ID, required if invoice_number not given.","schema":{"type":"string"}},{"name":"invoice_number","in":"query","description":"Invoice number, required if job ID not given.","schema":{"type":"string"}}],"requestBody":{"description":"JSON data with resolve reason in description.","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobResolveDisputeRequest"}}}},"responses":{"200":{"description":"Returns success message if job was succesfully resolved.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/JobDisputeResponse"}}}},"400":{"description":"Bad request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HttpApiProblem"}}}}}}}}}
```


---

# 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/jobs.md?ask=<question>
```

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.