search

Jobs

Manage Jobs

hashtag
Get jobs

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
jobidintegerRequired

Id of the job

Responses
chevron-right
200

Successful operation

application/json

JobJobInfo

accountdatestring · nullableOptional

The date job was added

Example: 2017-10-10
addressstringOptional

The street address of the recipient

Example: Satamakatu 123
addressaddline1stringOptional

The first additional line of the address card, printed above the name of the recipient

Example: Johto
addressaddline2stringOptional

The second additional line of the address card, printed between the name and the street address

Example: PL 43
billcodestringOptional

Reference number or message, by which the payment is delivered to the biller

Example: 4349
billnumstringOptional

The current number of the bill in the accounting books of the principal

Example: 11213
citystringOptional

The mailing location of the debtor

Example: KUOPIO
companystringOptional

Name of the corporate customer

Example: Matin konepaja Oy
countrystringOptional

Country where the corporate customer is registered

Example: FIN
currentpaydatestringOptional

Current paydate

Example: 2017-12-31
currentstatusintegerOptional

Current status

Example: 0
currentstatustextstringOptional

Current statustext

Example: Invoicing
custnumstringOptional

The customer number of the customer in the principals system

Example: 1022
govidstringOptional

The business ID (Y-tunnus) or personal identity code of the customer

Example: 2262509-5
jobidintegerOptional

Job id

Example: 123
nextstatusintegerOptional

Next status (-1 if next status is not available)

Example: 1
nextstatusdatestringOptional

Date when next status occurs

Example: 2018-01-15
nextstatustextstringOptional

Next status text

Example: Reminder
origjobdatestringOptional

Date when job was originally received

Example: 2017-11-13
origjobtextstringOptional

Original status text

Example: Invoicing
origjobtypeintegerOptional

Jobtype when job was originally received

Example: 0
paydatestringOptional

Original duedate of the bill

Example: 2017-11-27
personstringOptional

The name of the consumer client

Example: Teppo Nuutinen
postcodestringOptional

The postal code of the customer

Example: 70100
referencestringOptional

Reference number or message, by which the payment is delivered to the biller

Example: 412431235
refundtojobidintegerOptional

Assignment ID generated by Ropo to which the credit note is allocated.

Example: 31211
vatidstringOptional

The VAT ID of the customer

Example: FI22059054
get
/jobs

hashtag
Add bills

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
DataIdentifierstringOptional

Data identifier defined by customer for tracking purposes

DataTypeIdentifierstringOptional

Data type identifier

Content-TypestringOptional

Content type

Body

Job

Responses
post
/jobs

hashtag
Modify existing bill data

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
jobidintegerOptional

Id of the job to modify [jobid or billnum is required]

billnumstringOptional

Billnum of the job to modify [jobid or billnum is required]

Body

JobDataSet

accountdatestring · nullableOptional

Account date

Example: 2017-10-10
addressstringRequired

The street address of the recipient

Example: Satamakatu 123
addressaddline1string · nullableOptional

The first additional line of the address card, printed above the name of the recipient

Example: Johto
addressaddline2string · nullableOptional

The second additional line of the address card, printed between the name and the street address

Example: PL 43
addressaddline3string · nullableOptional

Line between receivers name and the street address

Example: CO Mauno Mansikka
addresscountrystring · nullableOptional

The home country of the recipient

Example: FIN
advancepaymentnumber · nullableOptional

Amount of advancepayment

Example: 15.00
amountnumber · nullableOptional

Total amount of the bill

Example: 19.96
billcodestring · nullableOptional

Reference number or message, by which the payment is delivered to the biller

Example: 4349
billdatestring · nullableOptional

The date of the bill

Example: 2017-01-01
xmldatestring · nullableOptional

The date of the bill on invoices or reminder date

Example: 2017-01-01
billnumstring · nullableOptional

The current number of the bill in the accounting books of the principal

Example: 11213
billtemplatestring · nullableOptional

The layout design of the bill template: CUSTOM, ECOM, BOBCAT, INC

Example: CUSTOM
billtemplateidinteger · nullableOptional

The layout id of the bill template.

Example: 123
cashbillinteger · nullableOptional

A cash bill is marked as paid directly: 1=cash bill

Example: 1
checkbillnuminteger · nullableOptional

Check if the bill number is unique 1=on, 0=off

Example: 1
citystringRequired

The mailing location of the debtor

Example: KUOPIO
claimtextstring · nullableOptional

Reason for Recall and Recourse.

Example: Unpaid bill 123456.
collectionprocessstring · nullableOptional

Type of receivable. Influences the collection process

Example: AUTO
colorinteger · nullableOptional

1=color, 0=black and white

Example: 0
collectioninvoiceinteger · nullableOptional

1=Collection invoice, 0=Single invoice

Example: 0
companystringOptional

Name of the corporate customer

Example: Matin konepaja Oy
contactpersonstring · nullableOptional

Contact person

Example: Liisa Liukaas
contactpersontitlestring · nullableOptional

Contact person title

Example: Assistentti
contactpersondepartmentstring · nullableOptional

Contact person department

Example: Customer service
countrystring · nullableOptional

Country where the corporate customer is registered

Example: FIN
countrynamestring · nullableOptional

Recipients country name

Example: Finland
currencystring · nullableOptional

Currency of job

Example: EUR
custnumstring · nullableOptional

The customer number of the customer in the principals system

Example: 1022
customeridinteger · nullableOptional

The customer number of the customer in Ropo One

Example: 1022
customertypeintegerRequired

Type of customer: 1=company, 2=natural person

Example: 1
deliverydatestring · nullableOptional

Products delivery date on invoice or cover note.

Example: 2017-01-24
deliverymethodstring · nullableOptional

Products delivery method as text.

Example: Kiitolinja
deliverytermstring · nullableOptional

Terms of delivery as text.

Example: NOK
departmentstring · nullableOptional

Recipients department

Example: Sales
doublesidedinteger · nullableOptional

0=singleside(default), 1=use doublesided bill

Example: 0
emailstring · nullableOptional

The e-mail address to which the bill is sent

Example: [email protected]
email2string · nullableOptional

The second e-mail address to which the bill is sent

Example: [email protected]
evoicestring · nullableOptional

Finnish e-invoice address

Example: FI123578612717718
evoiceintstring · nullableOptional

The code of the intermediary in the e-invoice

Example: NDEAFIHH
financeinteger · nullableOptional

1 = if funding applied from Ropo Finance.

Example: 0
foreignamountnumber · nullableOptional

Total amount of the bill in its original currency.

Example: 123.32
foreigncurrencystring · nullableOptional

TotalIdentifier of the currency used in the bill.

Example: SEK
freetextstring · nullableOptional

Free text field at the end of the bill

Example: Kiitokset tilauksesta!
govidstring · nullableOptional

The business ID (Y-tunnus) or personal identity code of the customer

Example: 2262509-5
jobtypeintegerRequired

Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service

Example: 0
languagestring · nullableOptional

Language of the bill: eng, fin, swe, est

Example: fin
modelstring · nullableOptional

Make, cost centre in the customers accounting or other reference

Example: Malli tai merkki
negvatinteger · nullableOptional

1, if reverse VAT liability is used in the bill

Example: 1
netamountnumber · nullableOptional

Total amount of the bill without VAT

Example: 16.10
noticedatestring · nullableOptional

Date of the first payment notice.

Example: 2017-03-24
noticedate2string · nullableOptional

Date of the second payment notice.

Example: 2017-04-24
noticedate3string · nullableOptional

Date of the third payment notice.

Example: 2017-05-24
noticedate4string · nullableOptional

Date of the fourth payment notice.

Example: 2017-06-24
noticefeenumber · nullableOptional

Principals notice costs.

Example: 10.00
ordernumberinteger · nullableOptional

Order number

Example: 10232
ourcodestring · nullableOptional

The principals reference

Example: Volvo ABC-553
overdueinterestnumber · nullableOptional

Delay interest rate

Example: 8.0
ovtstring · nullableOptional

OrganisationUnitNumber of recipient

Example: 00371234567800001
ownrefstring · nullableOptional

Temporary reference for sending

Example: 155
origbillnumstring · nullableOptional

Billnumber of collection invoices. Compulsory when invoice is sub invoice jobtype = 602.

Example: 123456
paydatestring · nullableOptional

The due date of the bill

Example: 2017-01-17
payplanamountnumber · nullableOptional

Amount of one instalment in a payment schedule in euros.

Example: 100.00
payplancountinteger · nullableOptional

The number of instalments in a payment schedule.

Example: 5
payplanintervalinteger · nullableOptional

Interval between instalments of the payment schedule in months.

Example: 1
pdfnamestring · nullableOptional

Predefined filename. This value is returned in preview and localprint responseheader

Example: preview.pdf
periodstring · nullableOptional

The date when the bill is recorded in the principals accounting. Contact our customer service before using this!

Example: 2017-02-17
personstring · nullableOptional

The name of the consumer client

Example: Teppo Nuutinen
phonestring · nullableOptional

The phone number of the customer/buyer/debtor

Example: +358441234567
postclassintegerOptional

Class of the letter in the post: 1 or 2

Example: 2
postcodestring · nullableOptional

The postal code of the customer

Example: 70100
putonholdinteger · nullableOptional

Should jobstatus be changed to 100: 1 = yes, 0 = no

Example: 1
refundtobillnumstring · nullableOptional

Bill number of the principal to which the credit note is allocated.

Example: 11213
refundtojobidinteger · nullableOptional

Assignment ID generated by Ropo to which the credit note is allocated.

Example: 31211
refundibanstring · nullableOptional

Account number where credit note is payed

Example: FI2112345600000785
refundmessagestring · nullableOptional

Message for payment of credit note

Example: tm 22141739 tili 1514 va 4804
refundmessagetypeinteger · nullableOptional

Messagetype for payment of credit note: 1=Using reference, 3=Using message

Example: 3
salesmaninteger · nullableOptional

The code of the salesman

Example: 12
salesmannamestring · nullableOptional

Name or initials of the salesman

Example: Sam Salesman
sendtypestring · nullableOptional

Type of sending of the bill: post, print, email or evoice

Example: post
sensibleinteger · nullableOptional

Is a payment notice sent automatically: 1=no, 0=yes

Example: 0
servicecodestring · nullableOptional

Cost center id

Example: 1
servicecode_namestring · nullableOptional

Cost center Name

Example: Center X
servicecode_dimensionstring · nullableOptional

Cost center code

Example: 123
TA0001string · nullableOptional

Site key in construction invoices.

Example: TA-FI-STVOY0001-B
TA0002string · nullableOptional

Site number in construction invoices.

Example: 1234
TA0003string · nullableOptional

Reported to the site register: Y = yes, N = no

Example: Y
totalamountnumber · nullableOptional

Total bill amount including VAT

Example: 19.96
vatamountnumber · nullableOptional

Total VAT amount of the bill

Example: 3.86
vatlayoutinteger · nullableOptional

VAT layout at invoice lines when only one is shown. 0 = Without VAT 1 = VAT included

Example: 0
vatidstring · nullableOptional

The VAT ID of the customer

Example: FI22059054
vatperiodstring · nullableOptional

The date on which VAT is applied in the principals accounting. Contact our customer service before using this!

Example: 2017-02-17
voucherbatchstring · nullableOptional

Voucher batch

Example: 43
vouchernumstring · nullableOptional

Voucher number

Example: 202132
yourcodestring · nullableOptional

Reference of the buyer

Example: Teppo Nuutinen
imageone ofOptional
or
nullOptional
packagedetailsone ofOptional
or
nullOptional
payeeone ofOptional
or
nullOptional
avtalegirostring · nullableOptional

Used to determine that invoice is Avtalegiro type

Example: avtalegiro
autogirostring · nullableOptional

Used to determine that invoice is Autogiro type

Example: autogiro
Responses
chevron-right
200

Successful operation

No content
patch
/jobs
No content

hashtag
Get jobs status update information

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
datestringOptional

Date (YYYY-MM-DD) to define to get all status update of given day.

billnumstringOptional

Invoice number. Response will contain all status updates for the invoice.

Responses
chevron-right
200

Successful operation

application/json

JobsStatusUpdatesResult

get
/jobs/statusupdates

hashtag
Get bill in pdf-format

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
jobidintegerOptional

Id of the job [contractnum, billnum or jobid is required]

billnumstringOptional

Billnum of the job [contractnum, billnum or jobid is required]

contractnumstringOptional

Contractnum of the job [contractnum, billnum or jobid is required]

documentdatestringOptional

Document date of the job [also contractnum or billnum is required]

origdataintegerOptional

0 = current, 1 = original[default]

documenttypestringOptional

Documenttype for Joisto archive.

joistocolumnstringOptional

Column name in Joisto archive (JobId, Laskunumero, Laskunro)

Responses
chevron-right
200

Returns PDF

application/pdf
get
/jobs/pdf

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

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
custnumstringRequired

Customer number of job(s) to modify

ordernumberstringRequired

Order number of job(s) to modify

Body

JobDataSet

accountdatestring · nullableOptional

Account date

Example: 2017-10-10
addressstringRequired

The street address of the recipient

Example: Satamakatu 123
addressaddline1string · nullableOptional

The first additional line of the address card, printed above the name of the recipient

Example: Johto
addressaddline2string · nullableOptional

The second additional line of the address card, printed between the name and the street address

Example: PL 43
addressaddline3string · nullableOptional

Line between receivers name and the street address

Example: CO Mauno Mansikka
addresscountrystring · nullableOptional

The home country of the recipient

Example: FIN
advancepaymentnumber · nullableOptional

Amount of advancepayment

Example: 15.00
amountnumber · nullableOptional

Total amount of the bill

Example: 19.96
billcodestring · nullableOptional

Reference number or message, by which the payment is delivered to the biller

Example: 4349
billdatestring · nullableOptional

The date of the bill

Example: 2017-01-01
xmldatestring · nullableOptional

The date of the bill on invoices or reminder date

Example: 2017-01-01
billnumstring · nullableOptional

The current number of the bill in the accounting books of the principal

Example: 11213
billtemplatestring · nullableOptional

The layout design of the bill template: CUSTOM, ECOM, BOBCAT, INC

Example: CUSTOM
billtemplateidinteger · nullableOptional

The layout id of the bill template.

Example: 123
cashbillinteger · nullableOptional

A cash bill is marked as paid directly: 1=cash bill

Example: 1
checkbillnuminteger · nullableOptional

Check if the bill number is unique 1=on, 0=off

Example: 1
citystringRequired

The mailing location of the debtor

Example: KUOPIO
claimtextstring · nullableOptional

Reason for Recall and Recourse.

Example: Unpaid bill 123456.
collectionprocessstring · nullableOptional

Type of receivable. Influences the collection process

Example: AUTO
colorinteger · nullableOptional

1=color, 0=black and white

Example: 0
collectioninvoiceinteger · nullableOptional

1=Collection invoice, 0=Single invoice

Example: 0
companystringOptional

Name of the corporate customer

Example: Matin konepaja Oy
contactpersonstring · nullableOptional

Contact person

Example: Liisa Liukaas
contactpersontitlestring · nullableOptional

Contact person title

Example: Assistentti
contactpersondepartmentstring · nullableOptional

Contact person department

Example: Customer service
countrystring · nullableOptional

Country where the corporate customer is registered

Example: FIN
countrynamestring · nullableOptional

Recipients country name

Example: Finland
currencystring · nullableOptional

Currency of job

Example: EUR
custnumstring · nullableOptional

The customer number of the customer in the principals system

Example: 1022
customeridinteger · nullableOptional

The customer number of the customer in Ropo One

Example: 1022
customertypeintegerRequired

Type of customer: 1=company, 2=natural person

Example: 1
deliverydatestring · nullableOptional

Products delivery date on invoice or cover note.

Example: 2017-01-24
deliverymethodstring · nullableOptional

Products delivery method as text.

Example: Kiitolinja
deliverytermstring · nullableOptional

Terms of delivery as text.

Example: NOK
departmentstring · nullableOptional

Recipients department

Example: Sales
doublesidedinteger · nullableOptional

0=singleside(default), 1=use doublesided bill

Example: 0
emailstring · nullableOptional

The e-mail address to which the bill is sent

Example: [email protected]
email2string · nullableOptional

The second e-mail address to which the bill is sent

Example: [email protected]
evoicestring · nullableOptional

Finnish e-invoice address

Example: FI123578612717718
evoiceintstring · nullableOptional

The code of the intermediary in the e-invoice

Example: NDEAFIHH
financeinteger · nullableOptional

1 = if funding applied from Ropo Finance.

Example: 0
foreignamountnumber · nullableOptional

Total amount of the bill in its original currency.

Example: 123.32
foreigncurrencystring · nullableOptional

TotalIdentifier of the currency used in the bill.

Example: SEK
freetextstring · nullableOptional

Free text field at the end of the bill

Example: Kiitokset tilauksesta!
govidstring · nullableOptional

The business ID (Y-tunnus) or personal identity code of the customer

Example: 2262509-5
jobtypeintegerRequired

Type of job: 0=bill, 1=payment notice, 2=collection, 300=printing service, 301=mailing service

Example: 0
languagestring · nullableOptional

Language of the bill: eng, fin, swe, est

Example: fin
modelstring · nullableOptional

Make, cost centre in the customers accounting or other reference

Example: Malli tai merkki
negvatinteger · nullableOptional

1, if reverse VAT liability is used in the bill

Example: 1
netamountnumber · nullableOptional

Total amount of the bill without VAT

Example: 16.10
noticedatestring · nullableOptional

Date of the first payment notice.

Example: 2017-03-24
noticedate2string · nullableOptional

Date of the second payment notice.

Example: 2017-04-24
noticedate3string · nullableOptional

Date of the third payment notice.

Example: 2017-05-24
noticedate4string · nullableOptional

Date of the fourth payment notice.

Example: 2017-06-24
noticefeenumber · nullableOptional

Principals notice costs.

Example: 10.00
ordernumberinteger · nullableOptional

Order number

Example: 10232
ourcodestring · nullableOptional

The principals reference

Example: Volvo ABC-553
overdueinterestnumber · nullableOptional

Delay interest rate

Example: 8.0
ovtstring · nullableOptional

OrganisationUnitNumber of recipient

Example: 00371234567800001
ownrefstring · nullableOptional

Temporary reference for sending

Example: 155
origbillnumstring · nullableOptional

Billnumber of collection invoices. Compulsory when invoice is sub invoice jobtype = 602.

Example: 123456
paydatestring · nullableOptional

The due date of the bill

Example: 2017-01-17
payplanamountnumber · nullableOptional

Amount of one instalment in a payment schedule in euros.

Example: 100.00
payplancountinteger · nullableOptional

The number of instalments in a payment schedule.

Example: 5
payplanintervalinteger · nullableOptional

Interval between instalments of the payment schedule in months.

Example: 1
pdfnamestring · nullableOptional

Predefined filename. This value is returned in preview and localprint responseheader

Example: preview.pdf
periodstring · nullableOptional

The date when the bill is recorded in the principals accounting. Contact our customer service before using this!

Example: 2017-02-17
personstring · nullableOptional

The name of the consumer client

Example: Teppo Nuutinen
phonestring · nullableOptional

The phone number of the customer/buyer/debtor

Example: +358441234567
postclassintegerOptional

Class of the letter in the post: 1 or 2

Example: 2
postcodestring · nullableOptional

The postal code of the customer

Example: 70100
putonholdinteger · nullableOptional

Should jobstatus be changed to 100: 1 = yes, 0 = no

Example: 1
refundtobillnumstring · nullableOptional

Bill number of the principal to which the credit note is allocated.

Example: 11213
refundtojobidinteger · nullableOptional

Assignment ID generated by Ropo to which the credit note is allocated.

Example: 31211
refundibanstring · nullableOptional

Account number where credit note is payed

Example: FI2112345600000785
refundmessagestring · nullableOptional

Message for payment of credit note

Example: tm 22141739 tili 1514 va 4804
refundmessagetypeinteger · nullableOptional

Messagetype for payment of credit note: 1=Using reference, 3=Using message

Example: 3
salesmaninteger · nullableOptional

The code of the salesman

Example: 12
salesmannamestring · nullableOptional

Name or initials of the salesman

Example: Sam Salesman
sendtypestring · nullableOptional

Type of sending of the bill: post, print, email or evoice

Example: post
sensibleinteger · nullableOptional

Is a payment notice sent automatically: 1=no, 0=yes

Example: 0
servicecodestring · nullableOptional

Cost center id

Example: 1
servicecode_namestring · nullableOptional

Cost center Name

Example: Center X
servicecode_dimensionstring · nullableOptional

Cost center code

Example: 123
TA0001string · nullableOptional

Site key in construction invoices.

Example: TA-FI-STVOY0001-B
TA0002string · nullableOptional

Site number in construction invoices.

Example: 1234
TA0003string · nullableOptional

Reported to the site register: Y = yes, N = no

Example: Y
totalamountnumber · nullableOptional

Total bill amount including VAT

Example: 19.96
vatamountnumber · nullableOptional

Total VAT amount of the bill

Example: 3.86
vatlayoutinteger · nullableOptional

VAT layout at invoice lines when only one is shown. 0 = Without VAT 1 = VAT included

Example: 0
vatidstring · nullableOptional

The VAT ID of the customer

Example: FI22059054
vatperiodstring · nullableOptional

The date on which VAT is applied in the principals accounting. Contact our customer service before using this!

Example: 2017-02-17
voucherbatchstring · nullableOptional

Voucher batch

Example: 43
vouchernumstring · nullableOptional

Voucher number

Example: 202132
yourcodestring · nullableOptional

Reference of the buyer

Example: Teppo Nuutinen
imageone ofOptional
or
nullOptional
packagedetailsone ofOptional
or
nullOptional
payeeone ofOptional
or
nullOptional
avtalegirostring · nullableOptional

Used to determine that invoice is Avtalegiro type

Example: avtalegiro
autogirostring · nullableOptional

Used to determine that invoice is Autogiro type

Example: autogiro
Responses
chevron-right
200

Successful operation

application/json

JobPatchOpenSalesInvoicesResponse

patch
/jobs/opensalesinvoices

hashtag
Update invoice delivery status

patch
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

JobDeliveryStatusRequest

created_atstringOptional
idstringOptional
servicestringOptional
Responses
chevron-right
200

Successful operation

No content
patch
/jobs/deliverystatus
No content

hashtag
Preview of the invoice

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
DataIdentifierstringOptional

Data identifier defined by customer for tracking purposes

DataTypeIdentifierstringOptional

Data type identifier

Body

Job

Responses
post
/jobs/preview

hashtag
Print locally the invoice

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Header parameters
DataIdentifierstringOptional

Data identifier defined by customer for tracking purposes

DataTypeIdentifierstringOptional

Data type identifier

Body

Job

Responses
post
/jobs/localprint

hashtag
Add payment to existing job.

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

JobAddPayment

amountnumberRequired

Amount of payment

Example: 710.00
billcodestringOptional

Reference of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: 123467
billnumstringOptional

Billnum of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: R123467
jobidintegerOptional

Id of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: 123467
paydatestringRequired

Date of payment

Example: 2017-10-10
identifierstringOptional

Payment targeting identifier

Example: insurance
typestringOptional

Payment type

Example: directpayment
creditnotebillnumstringOptional

Credit note invoice number

Example: 26251
descriptionstringOptional

Description of payment

Example: Capital amount increased due to agreement change.
Responses
post
/jobs/payment

hashtag
Add credit note to existing job

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body

JobAddCreditNote

amountnumberRequired

Amount of credit note

Example: 710.00
billcodestringOptional

Reference of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: 123467
billnumstringOptional

Billnum of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: R123467
jobidintegerOptional

Id of job. One of these required: 1.billcode, 2.jobid, 3. billnum (search order)

Example: 123467
datestringRequired

Date

Example: 2017-10-10
typestringOptional

Credit note type

Example: allocated
creditnotebillnumstringOptional

Credit note invoice number

Example: 26251
descriptionstringOptional

Description of credit note

Example: Capital amount increased due to agreement change.
Responses
post
/jobs/creditnote

hashtag
Send transfer report based on Batch ID

get
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
batchidstringRequired

Transferconfirmation batchid identifier

Responses
chevron-right
200

successful operation

No content
get
/jobs/transferconfirmation
No content

hashtag
Dispute a job

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
jobidstringOptional

Job ID, required if invoice number not given.

invoice_numberstringOptional

Invoice number, required if job ID not given.

Body

JobDisputeRequest

Responses
chevron-right
200

Returns success message if job was succesfully disputed.

application/json

JobDisputeResponse

created_atstringOptional

Timestamp of the response.

post
/jobs/dispute

hashtag
Resolve a disputed job

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Query parameters
jobidstringOptional

Job ID, required if invoice_number not given.

invoice_numberstringOptional

Invoice number, required if job ID not given.

Body

JobResolveDisputeRequest

Responses
chevron-right
200

Returns success message if job was succesfully resolved.

application/json

JobDisputeResponse

created_atstringOptional

Timestamp of the response.

post
/jobs/dispute/resolve
PreviousContractNextReceiverproposal

Last updated

Was this helpful?