ACacculynx
jobs

Get Job Payments Overview

Use this endpoint to get a high-level overview of financial information for the specified job.

get/jobs/{jobId}/payments/overview

Request

  • Base URL
    https://api.acculynx.com/api/v2
  • URL
    https://api.acculynx.com/api/v2/jobs/{jobId}/payments/overview
  • Auth
    HTTP bearer

Path parameters

jobIdstring uuid required

The job's unique identifier

Response

OK

salesAmountnumber

The total contracted sales amount for the job.

balanceDuenumber

The balance left to be paid for the job.

arAgeinteger

The A/R days for the job.

percentageCollectedinteger

The percentage of the total contracted sales amount collected, to the nearest integer.

Changes

No recorded changes to this operation across all 2 revisions of this API.