---
title: "Analyse business rules violations by invoice ID"
method: POST
path: "/api/v1/business_rules_analysis/analyse_by_invoice"
---

# Analyse business rules violations by invoice ID

`POST /api/v1/business_rules_analysis/analyse_by_invoice`

## Request

- Base URL: `https://api.caresquare.com.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.caresquare.com.au/api/v1/business_rules_analysis/analyse_by_invoice`
- Auth: none declared

Retrieves invoice data and analyses line items for business rules violations

## Request body

- BusinessRulesAnalysisByInvoiceRequest: Request schema for analysing business rules violations by invoice ID
  - `invoice_id` string, required
  - `update_database` boolean, nullable

## Response `200`

Successful Response

- BusinessRulesAnalysisResponse: Response schema for business rules analysis
  - `violations_found` boolean, required
  - `line_items` object[], required
  - `violations_summary` ViolationSummary, required: Summary of violations found during analysis
    - `total_violations` integer, required
    - `general_violations` integer, required
    - `pace_violations` integer, required
    - `sap_violations` integer, required
    - `price_guide_violations` integer, required
    - `violation_types` object, required
  - `participant_info` AppSchemasBusinessRulesAnalysisParticipantInfo: Information about the participant for analysis context
    - `is_pace_plan` boolean, nullable, required
    - `has_budget_data` boolean, required
    - `has_service_bookings` boolean, required
  - `analysis_error` boolean, nullable
  - `database_updated` boolean, nullable

## Other responses

- `422`: Validation Error

---

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