Invoice query by SSN or customer number

Retrieve open and/or paid invoices for an end customer by SSN or customer number.

For each matching invoice, the response includes invoice data and a MyRopoLink. MyRopoLink is included only if the MyRopoLink agreement is active in Ropo One.

Details of the invoice data can be found below.

• Additional information

  • Statuses are the same, which are used in MyRopo (myropo.com)

    • Invoicing

    • Due

    • Reminder

    • Collection

    • Paid (older that 2y from the pay date are not returned)

Find open jobs by end customer SSN or customer number

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

ssnstringOptional

Social security number (HETU). Either ssn or custnum is required.

custnumstringOptional

Customer number. Either ssn or custnum is required.

all_invoicesintegerOptional

0 = open invoices only (default), 1 = all invoices including paid.

Responses

200

Jobs found

application/json

400

Bad request

application/json

404

Not found

application/json

post/jobs/findbyendcustomer

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

{
  "ssn": "text",
  "custnum": "text",
  "all_invoices": 1
}

{
  "jobs": [
    {
      "case_number": 1,
      "invoice_number": "text",
      "original_invoice_date": "text",
      "status": "text",
      "open_amount": 1,
      "group_job": 1,
      "group_invoice_numbers": [
        "text"
      ],
      "group_total_payable": 1,
      "my_ropo_link": "text"
    }
  ]
}