List invoice payables

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

• 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, fromAccountName, createdAt, invoiceNumber, issuedDate, ocrCompletedAt, paymentAt, senderEmail, state, vendorName, businessPartnerName, nextApproverName.

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

• 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.

• include array

Response

• records array of object

  List of records for the current page

  • id string · uuid

  • type string

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

    One of REIMBURSEMENT SELF_BILLED VENDOR_INVOICE

  • metadata object

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

    • type 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.

      One of SELF_BILLED_METADATA VENDOR_INVOICE_METADATA REIMBURSEMENT_METADATA

  • documentKey string

  • documentName string

  • senderEmail string

  • companyId string · uuid

  • failureReason string

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

    One of 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 PAYMENT_REVERSED

  • failureContext object

    Failure context when vendor onboarding fails.

    • name string

      The error name

    • type string

      The error type

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

      One of BAD_REQUEST UNAUTHORIZED FORBIDDEN NOT_FOUND CONFLICT UNPROCESSABLE_CONTENT

    • errors array of object

      List of errors providing details about what went wrong

      • type string

        A string code identifying the error type

      • message string

        A human-readable message providing more details about the error

      • path array of string

        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

      • 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

  • state string

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

    One of 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 UNPAID PAID COMPLETED RESET_PENDING CANCELLATION_PENDING CANCELLED DUPLICATED IMPORT_PENDING

  • version integer · int32

  • approvalNote string

  • payeeName string

  • payeeIban string

  • payeeBban string

  • payeeBic string

  • payeeBankCode string

  • payeeCountry string

  • payeeAddress string

  • payeeZipcode string

  • payeeBankName string

  • payeeBankCountry string

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

    One of 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

  • payeeBankAddress string

  • payeeBankZipcode string

  • payeeCity string

  • payeeBankCity string

  • fiNumber string

  • invoiceNumber string

  • companyEntityId string · uuid

  • companyEntityName string

  • amount integer · int64

  • currency string

  • issuedDate string · date

  • dueDate string · date

  • paymentAt string · date-time

  • ocrCompletedAt string · date-time

  • canceledAt string · date-time

  • description string

  • senderBankAccountId string · uuid

  • cancellationReason string

  • vendor object

    • vendorId string · uuid

    • vatId string

    • vendorAccountId string · uuid

    • vendorTaxCodeId string · uuid

    • vendorCostCenterId string · uuid

    • vendorSenderBankAccountId string · uuid

    • vendorIdentifier string

    • vendorName string

    • vendorAvatarUrl string

    • vendorEmail string

    • vendorWebsite string

    • vendorCountry string

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

      One of 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

    • vendorCity string

    • vendorAddress string

    • vendorZipcode string

    • vendorCurrency string

    • vendorContractValue integer · int64

    • vendorCreatedBy string · uuid

  • user object

    • userId string · uuid

    • userFirstName string

    • userLastName string

    • userAvatarUrl string

  • nextApprover object

    • userId string · uuid

    • firstName string

    • lastName string

    • fullName string

    • approvalSentAt string · date-time

  • reimbursement object

    • id string · uuid

    • companyId string · uuid

    • userId string · uuid

    • expenseIds array of string · uuid

    • status string

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

      One of IN_PROGRESS SUCCEEDED FAILED REJECTED RESET

    • createdAt string · date-time

  • createdAt string · date-time

  • updatedAt string · date-time

  • paymentPausedBy string · uuid

  • paymentPausedAt string · date-time

• 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)