Skip to main content
GET
/
v1
/
invoice-approval
Get invoice approvals
curl --request GET \
  --url https://api.light.inc/v1/invoice-approval \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json;charset=UTF-8' \
  --data '
{
  "roles": [
    "<string>"
  ],
  "name": "<string>"
}
'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoicePayableId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "invoiceDocumentKey": "<string>",
    "invoiceNumber": "<string>",
    "invoiceAmount": 123,
    "invoiceCurrency": "USD",
    "invoiceIssuedAt": "2023-11-07T05:31:56Z",
    "invoiceIssuedDate": "2023-12-25",
    "invoiceDueAt": "2023-11-07T05:31:56Z",
    "invoiceDueDate": "2023-12-25",
    "userApprovals": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "approvalId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "priority": 123,
        "status": "APPROVED",
        "channel": "SLACK",
        "note": "<string>",
        "completedAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdAt": "2023-11-07T05:31:56Z",
        "notifiedAt": "2023-11-07T05:31:56Z"
      }
    ],
    "note": "<string>",
    "status": "APPROVED",
    "completedAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "createdAt": "2023-11-07T05:31:56Z"
  }
]

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
invoicePayableId
string<uuid>[]

Body

application/json;charset=UTF-8
​
roles
string[]
​
name
string

Response

default - application/json;charset=UTF-8

default response

​
id
string<uuid>
​
companyId
string<uuid>
​
invoicePayableId
string<uuid>
​
invoiceDocumentKey
string
​
invoiceNumber
string | null
​
invoiceAmount
integer<int64>
​
invoiceCurrency
string
Example:

"USD"

​
invoiceIssuedAt
string<date-time>
​
invoiceIssuedDate
string<date>
​
invoiceDueAt
string<date-time>
​
invoiceDueDate
string<date>
​
userApprovals
object[]
​
note
string | null
​
status
enum<string>

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

Available options:
APPROVED,
DECLINED,
CANCELLED,
FAILED,
IN_PROGRESS
​
completedAt
string<date-time> | null
​
updatedAt
string<date-time>
​
createdAt
string<date-time>