---
title: "Get Job Payments Overview"
method: GET
path: "/jobs/{jobId}/payments/overview"
tags: ["jobs"]
---

# Get Job Payments Overview

`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

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

## Path parameters

- `jobId` string, uuid, required

## Response `200`

OK

- PaymentOverview
  - `salesAmount` number: The total contracted sales amount for the job.
  - `balanceDue` number: The balance left to be paid for the job.
  - `arAge` integer: The A/R days for the job.
  - `percentageCollected` integer: The percentage of the total contracted sales amount collected, to the nearest integer.

## Other responses

- `400`: The request was malformed or contained invalid field values. Check the error response body for details.
- `401`: The API key provided is missing, invalid, or has been deactivated. Verify your API key and try again.
- `404`: The requested resource was not found. Verify the ID in the request path is correct and that the resource exists.

---

[API](https://skmtc.dev/acculynx/apis/acculynx-api-v2.md) - [All operations](https://skmtc.dev/acculynx/apis/acculynx-api-v2/llms.txt) - [OpenAPI document](https://skmtc.dev/acculynx/apis/acculynx-api-v2/revisions/443924b00f43?raw)