Light APIv1.0.0

API / Reference / Invoice Approvals

Get invoice approvals

GET https://api.light.inc/v1/invoice-approval

Returns approval records for specified invoice payables

There is no request body; the LightPrincipal shape below is the authenticated caller leaking into the spec. invoicePayableId may be repeated and is effectively required: with none the result is an empty list, not all approvals. Only the latest approval per bill is returned, with userApprovals in priority order; a group approver has userGroupId set and userId null. Needs a user credential with the AP-preparation or auditor role, or one that is an approver on every requested bill (403 otherwise).

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

Query parameters

  • invoicePayableId array

Request body

application/json;charset=UTF-8

  • roles array of string

  • name string

Response

  • id string · uuid

  • companyId string · uuid

  • invoicePayableId string · uuid

  • invoiceDocumentKey string

  • invoiceNumber string

  • invoiceAmount integer · int64

  • invoiceCurrency string

  • invoiceIssuedAt string · date-time

  • invoiceIssuedDate string · date

  • invoiceDueAt string · date-time

  • invoiceDueDate string · date

  • userApprovals array of object

    • id string · uuid

    • approvalId string · uuid

    • userId string · uuid

    • userGroupId string · uuid

    • priority integer · int32

    • status string

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

      One of APPROVED CANCELLED DECLINED FAILED IN_REVIEW PENDING

    • note string

    • completedAt string · date-time

    • updatedAt string · date-time

    • createdAt string · date-time

    • notifiedAt string · date-time

  • note string

  • status string

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

    One of APPROVED DECLINED CANCELLED FAILED IN_PROGRESS

  • completedAt string · date-time

  • updatedAt string · date-time

  • createdAt string · date-time