GET
/
ext
/
v1
/
bff
/
invoice-payables
List invoice payables
curl --request GET \
  --url https://api.light.inc/rest/ext/v1/bff/invoice-payables
{
  "total": 123,
  "records": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "type": "REIMBURSEMENT",
      "metadata": {
        "type": "VENDOR_INVOICE_METADATA"
      },
      "documentKey": "<string>",
      "documentName": "<string>",
      "senderEmail": "<string>",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "failureReason": "EMAIL_NOT_ALLOWED",
      "failureContext": {
        "type": "BAD_REQUEST",
        "errors": [
          {
            "type": "<string>",
            "clientMessage": "<string>",
            "message": "<string>",
            "path": [
              "<string>"
            ],
            "context": {}
          }
        ],
        "stackTrace": [
          {
            "classLoaderName": "<string>",
            "moduleName": "<string>",
            "moduleVersion": "<string>",
            "methodName": "<string>",
            "fileName": "<string>",
            "lineNumber": 123,
            "nativeMethod": true,
            "className": "<string>"
          }
        ],
        "message": "<string>",
        "suppressed": [
          {
            "stackTrace": [
              {
                "classLoaderName": "<string>",
                "moduleName": "<string>",
                "moduleVersion": "<string>",
                "methodName": "<string>",
                "fileName": "<string>",
                "lineNumber": 123,
                "nativeMethod": true,
                "className": "<string>"
              }
            ],
            "message": "<string>",
            "localizedMessage": "<string>"
          }
        ],
        "localizedMessage": "<string>",
        "name": "<string>"
      },
      "state": "INIT",
      "version": 123,
      "approvalNote": "<string>",
      "payeeName": "<string>",
      "payeeIban": "<string>",
      "payeeBban": "<string>",
      "payeeBic": "<string>",
      "payeeBankCode": "<string>",
      "payeeCountry": "<string>",
      "payeeAddress": "<string>",
      "payeeZipcode": "<string>",
      "payeeBankName": "<string>",
      "payeeBankCountry": "UNDEFINED",
      "payeeBankAddress": "<string>",
      "payeeBankZipcode": "<string>",
      "payeeCity": "<string>",
      "payeeBankCity": "<string>",
      "fiNumber": "<string>",
      "invoiceNumber": "<string>",
      "companyEntityId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyEntityName": "<string>",
      "amount": 123,
      "currency": "USD",
      "issuedDate": "2023-12-25",
      "dueDate": "2023-12-25",
      "paymentAt": "2023-11-07T05:31:56Z",
      "ocrCompletedAt": "2023-11-07T05:31:56Z",
      "canceledAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "senderBankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "cancellationReason": "<string>",
      "vendor": {
        "vendorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vatId": "<string>",
        "vendorAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendorTaxCodeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendorCostCenterId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendorSenderBankAccountId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "vendorIdentifier": "<string>",
        "vendorName": "<string>",
        "vendorAvatarUrl": "<string>",
        "vendorEmail": "<string>",
        "vendorWebsite": "<string>",
        "vendorCountry": "UNDEFINED",
        "vendorCity": "<string>",
        "vendorAddress": "<string>",
        "vendorZipcode": "<string>",
        "vendorCurrency": "USD",
        "vendorContractValue": 123,
        "vendorCreatedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "user": {
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userFirstName": "<string>",
        "userLastName": "<string>",
        "userAvatarUrl": "<string>"
      },
      "nextApprover": {
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "firstName": "<string>",
        "lastName": "<string>",
        "fullName": "<string>",
        "notificationChannel": "MS_TEAMS",
        "approvalSentAt": "2023-11-07T05:31:56Z"
      },
      "reimbursement": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "expenseIds": [
          "3c90c3cc-0d44-4b50-8888-8dd25736052a"
        ],
        "status": "IN_PROGRESS",
        "createdAt": "2023-11-07T05:31:56Z"
      },
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "paymentPausedBy": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "paymentPausedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Query Parameters

sort
string
Example:

"amount:desc,createdAt:asc"

filter
string
Example:

"state:in:IN_DRAFT|SCHEDULED|PAID,amount:gte:500"

limit
integer
offset
integer
include
enum<string>[]

Response

default - application/json;charset=UTF-8

default response

The response is of type object.