List invoice payables

GET

bff

invoice-payables

curl --request GET \
  --url https://api.light.inc/v1/bff/invoice-payables \
  --header 'Authorization: <api-key>'

{
  "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": {
        "name": "<string>",
        "type": "BAD_REQUEST",
        "errors": [
          {
            "type": "<string>",
            "message": "<string>",
            "path": [
              "<string>"
            ],
            "context": {}
          }
        ]
      },
      "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"
    }
  ],
  "hasMore": true,
  "total": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Authorizations

Authorization

string

header

required

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

Query Parameters

sort

string

Sort string in the format field:direction. To provide multiple sort fields, separate them with commas.

Available directions: asc, desc.

Available fields: amount, canceledAt, companyEntityName, description, dueDate, createdAt, issuedDate, ocrCompletedAt, paymentAt, state, vendorName, businessPartnerName, nextApproverName.

Example:

"amount:desc,createdAt:asc"

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: id, vendorId, userId, companyEntityId, senderBankAccountId, amount, description, dueDate, issuedDate, paymentAt, createdAt, state, vendorName, userFirstName, userLastName, type.

Example:

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

limit

integer<int32>

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

Required range: x <= 200

offset

integer<int64>

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.

include

enum<string>[]

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

Available options:

REIMBURSEMENT

Response

default - application/json;charset=UTF-8

default response

records

object[]

List of records for the current page

Show child attributes

records.id

string<uuid>

records.type

enum<string>

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

Available options:

REIMBURSEMENT,

VENDOR_INVOICE

records.metadata

object

Metadata specific to the invoice payable type (e.g. reimbursement- or vendor-specific fields).

Show child attributes

records.metadata.type

enum<string>

Type of metadata attached to the invoice payable, depending on its kind (vendor invoice or reimbursement).

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

Available options:

VENDOR_INVOICE_METADATA,

REIMBURSEMENT_METADATA

records.documentKey

string | null

records.documentName

string | null

records.senderEmail

string | null

records.companyId

string<uuid>

records.failureReason

enum<string> | null

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

Available options:

EMAIL_NOT_ALLOWED,

ERP_ENTRY_FAILED,

OCR_FAILED,

PAYMENT_APPROVAL_DECLINED,

PAYMENT_FAILED,

RESETTING_INVOICE_FAILED,

APPROVAL_SUBMISSION_FAILED,

USER_INPUT_VALIDATION_FAILED,

DUPLICATE_INVOICE,

PAYMENT_REJECTED

records.failureContext

object

Show child attributes

records.failureContext.name

string

The error name

records.failureContext.type

enum<string>

The error type

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

Available options:

BAD_REQUEST,

UNAUTHORIZED,

FORBIDDEN,

NOT_FOUND,

CONFLICT,

UNPROCESSABLE_CONTENT

records.failureContext.errors

object[]

List of errors providing details about what went wrong

Show child attributes

records.failureContext.errors.type

string

A string code identifying the error type

records.failureContext.errors.message

string

A human-readable message providing more details about the error

records.failureContext.errors.path

(string | null)[] | null

Optional path of the error when the error is for a specific field. Used mostly on BAD_REQUEST errors, that path will match the field name on the request object

records.failureContext.errors.context

object

Optional context providing additional information about the error. This can include any relevant data that might help in understanding or resolving the error

Show child attributes

records.failureContext.errors.context.{key}

object

Optional context providing additional information about the error. This can include any relevant data that might help in understanding or resolving the error

records.state

enum<string>

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

Available options:

INIT,

CREATED,

IN_DRAFT,

APPROVAL_REQUESTED,

APPROVAL_PENDING,

APPROVED_ACCOUNTING_ENTRY_PENDING,

DECLINED,

READY_FOR_PAYMENT_RELEASE,

PENDING_PAYMENT_APPROVAL,

PAYMENT_PAUSED,

SCHEDULED,

PAYMENT_PENDING,

PARTIALLY_PAID,

PAYMENTS_REVERSED,

PAID,

COMPLETED,

RESET_PENDING,

CANCELLATION_PENDING,

CANCELLED,

DUPLICATED,

IMPORT_PENDING

records.version

integer<int32>

records.approvalNote

string | null

records.payeeName

string | null

records.payeeIban

string | null

records.payeeBban

string | null

records.payeeBic

string | null

records.payeeBankCode

string | null

records.payeeCountry

string | null

records.payeeAddress

string | null

records.payeeZipcode

string | null

records.payeeBankName

string | null

records.payeeBankCountry

enum<string> | null

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

Available options:

UNDEFINED,

AC,

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AN,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BU,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CP,

CR,

CS,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DG,

DJ,

DK,

DM,

DO,

DZ,

EA,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

EU,

EZ,

FI,

FJ,

FK,

FM,

FO,

FR,

FX,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

IC,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NT,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SF,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SU,

SV,

SX,

SY,

SZ,

TA,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TP,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UK,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XI,

XU,

XK,

YE,

YT,

YU,

ZA,

ZM,

ZR,

ZW

records.payeeBankAddress

string | null

records.payeeBankZipcode

string | null

records.payeeCity

string | null

records.payeeBankCity

string | null

records.fiNumber

string | null

records.invoiceNumber

string | null

records.companyEntityId

string<uuid> | null

records.companyEntityName

string | null

records.amount

integer<int64> | null

records.currency

string | null

Example:

"USD"

records.issuedDate

string<date> | null

records.dueDate

string<date> | null

records.paymentAt

string<date-time> | null

records.ocrCompletedAt

string<date-time> | null

records.canceledAt

string<date-time> | null

records.description

string | null

records.senderBankAccountId

string<uuid> | null

records.cancellationReason

string | null

records.vendor

object

Show child attributes

records.vendor.vendorId

string<uuid> | null

records.vendor.vatId

string | null

records.vendor.vendorAccountId

string<uuid> | null

records.vendor.vendorTaxCodeId

string<uuid> | null

records.vendor.vendorCostCenterId

string<uuid> | null

records.vendor.vendorSenderBankAccountId

string<uuid> | null

records.vendor.vendorIdentifier

string | null

records.vendor.vendorName

string | null

records.vendor.vendorAvatarUrl

string | null

records.vendor.vendorEmail

string | null

records.vendor.vendorWebsite

string | null

records.vendor.vendorCountry

enum<string> | null

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

Available options:

UNDEFINED,

AC,

AD,

AE,

AF,

AG,

AI,

AL,

AM,

AN,

AO,

AQ,

AR,

AS,

AT,

AU,

AW,

AX,

AZ,

BA,

BB,

BD,

BE,

BF,

BG,

BH,

BI,

BJ,

BL,

BM,

BN,

BO,

BQ,

BR,

BS,

BT,

BU,

BV,

BW,

BY,

BZ,

CA,

CC,

CD,

CF,

CG,

CH,

CI,

CK,

CL,

CM,

CN,

CO,

CP,

CR,

CS,

CU,

CV,

CW,

CX,

CY,

CZ,

DE,

DG,

DJ,

DK,

DM,

DO,

DZ,

EA,

EC,

EE,

EG,

EH,

ER,

ES,

ET,

EU,

EZ,

FI,

FJ,

FK,

FM,

FO,

FR,

FX,

GA,

GB,

GD,

GE,

GF,

GG,

GH,

GI,

GL,

GM,

GN,

GP,

GQ,

GR,

GS,

GT,

GU,

GW,

GY,

HK,

HM,

HN,

HR,

HT,

HU,

IC,

ID,

IE,

IL,

IM,

IN,

IO,

IQ,

IR,

IS,

IT,

JE,

JM,

JO,

JP,

KE,

KG,

KH,

KI,

KM,

KN,

KP,

KR,

KW,

KY,

KZ,

LA,

LB,

LC,

LI,

LK,

LR,

LS,

LT,

LU,

LV,

LY,

MA,

MC,

MD,

ME,

MF,

MG,

MH,

MK,

ML,

MM,

MN,

MO,

MP,

MQ,

MR,

MS,

MT,

MU,

MV,

MW,

MX,

MY,

MZ,

NA,

NC,

NE,

NF,

NG,

NI,

NL,

NO,

NP,

NR,

NT,

NU,

NZ,

OM,

PA,

PE,

PF,

PG,

PH,

PK,

PL,

PM,

PN,

PR,

PS,

PT,

PW,

PY,

QA,

RE,

RO,

RS,

RU,

RW,

SA,

SB,

SC,

SD,

SE,

SF,

SG,

SH,

SI,

SJ,

SK,

SL,

SM,

SN,

SO,

SR,

SS,

ST,

SU,

SV,

SX,

SY,

SZ,

TA,

TC,

TD,

TF,

TG,

TH,

TJ,

TK,

TL,

TM,

TN,

TO,

TP,

TR,

TT,

TV,

TW,

TZ,

UA,

UG,

UK,

UM,

US,

UY,

UZ,

VA,

VC,

VE,

VG,

VI,

VN,

VU,

WF,

WS,

XI,

XU,

XK,

YE,

YT,

YU,

ZA,

ZM,

ZR,

ZW

records.vendor.vendorCity

string | null

records.vendor.vendorAddress

string | null

records.vendor.vendorZipcode

string | null

records.vendor.vendorCurrency

string | null

Example:

"USD"

records.vendor.vendorContractValue

integer<int64> | null

records.vendor.vendorCreatedBy

string<uuid> | null

records.user

object

Show child attributes

records.user.userId

string<uuid> | null

records.user.userFirstName

string | null

records.user.userLastName

string | null

records.user.userAvatarUrl

string | null

records.nextApprover

object

Show child attributes

records.nextApprover.userId

string<uuid>

records.nextApprover.firstName

string

records.nextApprover.lastName

string

records.nextApprover.fullName

string

records.nextApprover.notificationChannel

enum<string>

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

Available options:

MS_TEAMS,

SLACK,

WEB_APP

records.nextApprover.approvalSentAt

string<date-time>

records.reimbursement

object

Show child attributes

records.reimbursement.id

string<uuid>

records.reimbursement.companyId

string<uuid>

records.reimbursement.userId

string<uuid>

records.reimbursement.expenseIds

string<uuid>[]

records.reimbursement.status

enum<string>

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

Available options:

IN_PROGRESS,

SUCCEEDED,

FAILED,

REJECTED,

RESET

records.reimbursement.createdAt

string<date-time>

records.createdAt

string<date-time>

records.updatedAt

string<date-time>

records.paymentPausedBy

string<uuid> | null

records.paymentPausedAt

string<date-time> | null

hasMore

boolean

Boolean flag indicating if there are more records available

total

integer<int64> | null

deprecated

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 | null

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

prevCursor

string | null

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

Approve invoice payableApproves an invoice payable for payment processing

⌘I

List invoice payables

curl --request GET \
  --url https://api.light.inc/v1/bff/invoice-payables \
  --header 'Authorization: <api-key>'

{
  "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": {
        "name": "<string>",
        "type": "BAD_REQUEST",
        "errors": [
          {
            "type": "<string>",
            "message": "<string>",
            "path": [
              "<string>"
            ],
            "context": {}
          }
        ]
      },
      "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"
    }
  ],
  "hasMore": true,
  "total": 123,
  "nextCursor": "<string>",
  "prevCursor": "<string>"
}

Accounting Documents

Attachments

Authorization

Card Customers

Card Transactions

Cards

Companies

Credit Notes

Custom Properties

Customer Credits

Customers

Entities

Exchange

Expenses

Invoice Approvals

Invoice Payables

Invoice Receivables

Journal Entries

Ledger Transactions

Ledger accounts

Products

Purchase Orders

Users

Vendors

Authorizations

Query Parameters

Response