Credit note allocation

Invoices sent to the interface cannot be canceled or changed. If there is an error in the invoice or if the invoice is to be canceled, a counterparty credit note will be sent to the interface that will partially or completely cancel the original invoice.

The credit note is like the normal invoice, but on invoice rows the amounts are presented negative and a refund jobid or refundtobillnum tag is added to the invoice, indicating the initial invoice item or bill number to which the refund applies. If the credit balance does not previously apply to the invoice sent to the Ropo One™, leave the refund jobid and the refund without a billnum tag: you can always place a credit note later in Ropo One™ if necessary.

Please note! If you are using payrows netamount, vatamount and totalamount they have to be presented in negative.

An example, sending and ordinary invoice:

JSON:
{
    "datastream": {
        "dataset": [
            {
                "jobtype": "0",
                "person": "Nelli Niirulainen",
                "address": "Kellokoskenkatu 15 A 3",
                "postcode": "70100",
                "city": "KUOPIO",
                "customertype": "2",
                "billdate": "2017-03-04",
                "paydate": "2017-03-18",
                "payrow": [
                    {
                        "desc": "Siivous",
                        "count": "1",
                        "itemtype": "h",
                        "amount": "100",
                        "taxpr": "23"
                    }
                ]
            }
        ]
    }
}

And then crediting the invoice:

JSON:
{
    "datastream": {
        "dataset": [
            {
                "jobtype": "0",
                "refundtojobid": "549220",
                "person": "Nelli Niirulainen",
                "address": "Kellokoskenkatu 15 A 3",
                "postcode": "70100",
                "city": "KUOPIO",
                "customertype": "2",
                "billdate": "2017-03-04",
                "paydate": "2017-03-18",
                "payrow": [
                    {
                        "desc": "Siivous",
                        "count": "-1",
                        "itemtype": "h",
                        "amount": "100",
                        "taxpr": "23"
                    }
                ]
            }
        ]
    }
}

The previous example credits the original invoice in full. If the invoice is only partially credited, credits note’s invoice rows may be changed accordingly. For example, a 50% credit can be achieved with a discount tag:

JSON:
"payrow": [
    {
        "desc": "Siivous",
        "count": "-1",
        "itemtype": "h",
        "amount": "100",
        "discount": "50",
        "taxpr": "23"
    }
]

In credit invoices you can remove invoice rows or change the number of products (pieces) as needed. Note, however, that no new products can be added to the credit note: if the debtor has been sold after the original invoice has been sent, these must be invoiced by a separate invoice!

Add credit note to existing job

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

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

201

Credit note response

application/json

400

Bad request

application/json

401

Unauthorized

post

/jobs/creditnote

HTTPcURLJavaScriptPython

POST /rest/jobs/creditnote HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 209

{
  "amount": "710.00",
  "billcode": "123467",
  "billnum": "R123467",
  "jobid": "123467",
  "date": "2017-10-10",
  "type": "allocated",
  "creditnotebillnum": "26251",
  "description": "Capital amount increased due to agreement change."
}

{
  "jobid": "123456",
  "billnum": "R12345",
  "billcode": "123456",
  "date": "2017-10-10",
  "amount": "710.00",
  "statusid": "1",
  "statustext": "Capital kirjattu"
}