latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Invoices

Gets the currently active flag for the specified invoice

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

get/v1/finance/invoices/{invoiceId}/flags

Path parameters

invoiceIdinteger required

The invoice id

Headers

Customer-Idinteger required

The customer identifier

Response

historyIdinteger

The unique identifier of the flag history entry

flagIdinteger

The unique identifier of the flag

flagNamestring

The name of the flag

appliedAtstring date-time

The UTC timestamp of when this flag was applied

ownerNamestring

The owner who applied the flag (user email or ID)

commentsstring nullable

Additional context for the flag

Example response

{
  "historyId": 123456,
  "flagId": 789,
  "flagName": "High Priority",
  "appliedAt": "2024-01-15T10:30:00.0000000+00:00",
  "ownerName": "john.doe@example.com",
  "comments": "Requires special attention"
}