---
title: "Gets the currently active flag for the specified purchase order"
method: GET
path: "/v1/finance/purchaseOrders/{purchaseOrderId}/flags"
tags: ["PurchaseOrders"]
---

# Gets the currently active flag for the specified purchase order

`GET /v1/finance/purchaseOrders/{purchaseOrderId}/flags`

## Request

- Base URL: `https://api.bigchange.com`
- URL: `https://api.bigchange.com/v1/finance/purchaseOrders/{purchaseOrderId}/flags`
- Auth: HTTP bearer

Retrieve the current active flag for a purchase order (required scope finance:read)

## Path parameters

- `purchaseOrderId` integer, required

## Headers

- `Customer-Id` integer, required

## Response `200`

OK

- ReadEntityFlagModel: Represents a flag applied to an entity. Used as the response model for all entity flag endpoints.<br/>The entity identifier is serialised under its entity-specific key (e.g. `jobId`,<br/>`jobGroupId`) taken from BigChange.BO.RestApi.Application.EntityFlags.Services.EntityFlagConfig.PrimaryKeyColumn
  - `historyId` integer: The unique identifier of the flag history entry
  - `flagId` integer: The unique identifier of the flag
  - `flagName` string: The name of the flag
  - `appliedAt` string, date-time: The UTC timestamp of when this flag was applied
  - `ownerName` string: The owner who applied the flag (user email or ID)
  - `comments` string, nullable: Additional context for the flag

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/bigchange/apis/bigchange-dx.md) - [All operations](https://skmtc.dev/bigchange/apis/bigchange-dx/llms.txt) - [OpenAPI document](https://skmtc.dev/bigchange/apis/bigchange-dx/revisions/b262bfdb1dd0?raw)