Light APIv1.0.0

API / Reference / Purchase Orders

List purchase order activity events

GET https://api.light.inc/v1/purchase-orders/{purchaseOrderId}/activity-events

The purchase order's activity timeline, newest first: who did what to it, when, and which fields changed. Requires permission to view this purchase order. The entityId and entityType filters are fixed by the path here; passing them can only narrow the result.

Authorization

Send one of these on every request. See Authentication for how to get credentials.

  • API key

    Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.

  • Bearer token

Path parameters

  • purchaseOrderId string · uuidrequired

Query parameters

  • filter string

    Filter string in the format field:operator:value. To provide multiple filters, separate them with commas.

    Available operators: eq, ne, in, not_in, gt, gte, lt, lte.

    • For in and not_in operators, provide multiple values separated by the pipe character (|).

    Available fields: action, actorId, correlationId, createdAt, entityId, entityType.

  • limit integer · int32

    Maximum number of items to return. Default is 50, maximum is 200.

  • offset integer · int64deprecated

    Number of items to skip before starting to collect the result set. Deprecated, use 'cursor' instead.

  • cursor string

    The cursor position to start returning results from. To opt-in into cursor-based pagination, provide 0 for the initial request. For subsequent requests, use nextCursor and prevCursor from the previous response to navigate. Cursor values are opaque and should not be constructed manually.

Response

  • records array of object

    List of records for the current page

    • id string · uuid

      Unique identifier of the event. Ids are time-ordered, so a later event always has a greater id.

    • entityType string

      Type of the record the event belongs to

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of AI_AGENT AI_ARTIFACT ASSISTANT_INSTRUCTION BANK_ACCOUNT BANK_PAYMENT CARD CARD_INTENT CARD_TRANSACTION CONTRACT CREDIT_NOTE CUSTOMER CUSTOMER_CREDIT DEFERRED_ENTRY DOCUMENT_TEMPLATE FX_REVALUATION HUBSPOT_CONNECTION INTERCOMPANY_JOURNAL_ENTRY INVOICE_PAYABLE INVOICE_RECEIVABLE JOURNAL_ENTRY LCI_MEMORY PRODUCT PURCHASE_ORDER PURCHASE_REQUEST SALESFORCE_CONNECTION SKILL USER_REIMBURSEMENT_CONFIG VENDOR WORKFLOW YEAR_CLOSING_ENTRY

    • entityId string · uuid

      ID of the record the event belongs to

    • action string

      What was done to the record

      ⚠️ This enum is not exhaustive; new values may be added in the future.

      One of ACTIVATE ADD_TO_PAYMENT_BATCH AGENT_REVIEW APPLY_CREDIT_NOTE APPLY_CUSTOMER_CREDIT APPROVE APPROVE_PAYMENT ARCHIVE ATTACH_FILE CANCEL CANCEL_TERMINATION CLEAR CLOSE CONFIRM_GOODS_RECEIPT CREATE DECLINE_APPROVAL DECLINE_PAYMENT DELETE FAIL FLAG_GOODS_RECEIPT_ISSUE INITIATE_PAYMENT LOCK MARK_AS_PAID MARK_AS_PAID_IN_STRIPE MARK_AS_PARTIALLY_PAID MATCH_BILL MATCH_PURCHASE_ORDER OPEN PARTIALLY_CLEAR PAUSE_PAYMENT PAY POST PUBLISH RECONCILE REMOVE_CREDIT_NOTE REMOVE_CUSTOMER_CREDIT RENEW RESET RESUME_PAYMENT REVERSE_CLEARING REVERT SCHEDULE_TERMINATION SEND_CUSTOMER_CREDIT SEND_DUNNING_EMAIL SEND_INVOICE SEND_PURCHASE_ORDER SUBMIT_FOR_APPROVAL TERMINATE TRIGGER_SYNC UNARCHIVE UNMATCH_BILL UNMATCH_PURCHASE_ORDER UNRECONCILE UPDATE

    • actor object

      Who did it

      • id string · uuid

        ID of the principal that acted

      • type string

        Kind of principal that acted

        ⚠️ This enum is not exhaustive; new values may be added in the future.

        One of AI_AGENT INTEGRATION LIGHT_TEAM SYSTEM USER

      • name string

        Display name of the actor

    • correlationId string · uuid

      ID of the operation this event belongs to, e.g. an approval run or an assistant tool call. Events sharing it were caused by that one operation.

    • createdAt string · date-time

      Timestamp when the event happened

    • changes array of object

      Field changes recorded with the event, each with the value before and after

      • objectType string

        Whether the changed field belongs to the record itself or to one of its lines

        ⚠️ This enum is not exhaustive; new values may be added in the future.

        One of HEADER LINE

      • objectId string · uuid

        ID of the record or line the field belongs to

      • objectPosition integer · int32

        Position of the line within the record, for line fields

      • field string

        Machine name of the changed field

      • fieldLabel string

        Human-readable label of the changed field

      • oldValue object

        A field value, discriminated by type: TEXT, DATE, ENUM, MONEY, REFERENCE or REFERENCE_LIST

        • type stringrequired

      • newValue object

        A field value, discriminated by type: TEXT, DATE, ENUM, MONEY, REFERENCE or REFERENCE_LIST

        • type stringrequired

  • hasMore boolean

    Boolean flag indicating if there are more records available

  • total integer · int64deprecated

    Total number of records (only for offset pagination). This field is not guaranteed to be returned and only available for offset pagination, please do not rely on it and migrate to cursor pagination.

  • nextCursor string

    Cursor for fetching the next page (only for cursor pagination)

  • prevCursor string

    Cursor for fetching the previous page (only for cursor pagination)