Decline invoice payable

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

Path parameters

• invoicePayableId string · uuidrequired

Request body

application/json;charset=UTF-8

• note string

  Optional note.

Response

• id string · uuid

  External ID of the invoice payable object.

• type string

  Type of the invoice payable (e.g. vendor invoice or reimbursement).

  ⚠️ 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

• invoicePayableId string · uuid

  Internal ID of the underlying invoice payable record.

• companyId string · uuid

  ID of the company this invoice payable belongs to.

• state string

  Current state of the invoice payable in its lifecycle (from ingestion to payment/completion).

  ⚠️ 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

• failureReason string

  High-level reason why processing the invoice payable failed, if any.

  ⚠️ 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

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

• approvalNote string

  Approval note associated with the invoice payable (e.g. approver comments).

• cancellationReason string

  Reason why the invoice payable was cancelled, if applicable.

• payeeName string

  Name of the payee for this invoice payable.

• payeeIban string

  Payee IBAN used for payment of this invoice payable.

• payeeBban string

  Payee BBAN (Basic Bank Account Number) used for local payments.

• payeeBic string

  Payee bank BIC/SWIFT code.

• payeeBankCode string

  Payee bank/branch code used for local payments.

• payeeSwedishBankgiroNumber string

  Payee Swedish Bankgiro number, if applicable.

• payeeSwedishPlusgiroNumber string

  Payee Swedish Plusgiro number, if applicable.

• payeeCountry string

  Country of the payee.

  ⚠️ 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

• payeeAddress string

  Street address of the payee.

• payeeZipcode string

  ZIP/postal code of the payee.

• payeeBankName string

  Name of the payee's bank.

• payeeBankCountry string

  Country of the payee's bank.

  ⚠️ 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

  Street address of the payee's bank.

• payeeBankZipcode string

  ZIP/postal code of the payee's bank.

• payeeCity string

  City of the payee.

• payeeBankCity string

  City of the payee's bank.

• vendorId string · uuid

  ID of the vendor entity this invoice payable is linked to, if any.

• vendorDetailsOcr object

  Vendor details extracted from the invoice using OCR.

  • avatarUrl string

    URL of the vendor avatar/logo detected by OCR, if any.

  • name string

    Vendor name detected by OCR from the uploaded document.

  • email string

    Vendor email address detected by OCR from the uploaded document.

  • phoneNumber object

    Vendor phone number.

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

    • localNumber string

  • website string

    Vendor website detected by OCR from the uploaded document.

  • country string

    Vendor country detected by OCR from the uploaded document.

    ⚠️ 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

  • city string

    Vendor city detected by OCR from the uploaded document.

  • address string

    Vendor street address detected by OCR from the uploaded document.

  • zipcode string

    Vendor ZIP/postal code detected by OCR from the uploaded document.

  • bankAccountNumber string

    Vendor bank account number (IBAN or local format) detected by OCR from the uploaded document.

  • bankAccountBic string

    Vendor bank BIC/SWIFT code detected by OCR from the uploaded document.

  • domesticBankAccountNumber string

    Vendor domestic bank account number detected by OCR (country-specific format).

  • domesticBankAccountCode string

    Vendor domestic bank account code detected by OCR (e.g. routing/sort code).

  • vatId string

    Vendor VAT ID detected by OCR from the uploaded document.

• companyEntityId string · uuid

  ID of the company entity this invoice payable is booked under.

• invoiceNumber string

  Invoice number provided on the vendor invoice.

• amount integer · int64

  Total invoice amount in cents, expressed in the invoice currency.

• outstandingBalance integer · int64

  Outstanding invoice balance to be paid in cents, expressed in the invoice currency.

• currency string

• description string

  Description or memo for the invoice payable.

• senderBankAccountId string · uuid

  ID of the sender bank account from which this invoice payable will be paid.

• fiNumber string

  FI (Finnish reference) number associated with this invoice payable, if applicable.

• finnishPaymentReference string

  Finnish payment reference (viitenumero or RF Creditor Reference) associated with this invoice payable, if applicable.

• norKidReference string

  Norwegian KID reference associated with this invoice payable, if applicable.

• swissPaymentReference string

  Swiss payment reference (QR-Reference or Creditor Reference/SCOR) associated with this invoice payable, if applicable.

• swedishOcrReference string

  Swedish OCR reference associated with this invoice payable, if applicable.

• paymentAt string · date-time

  Date/time when payment is scheduled or was executed for this invoice payable.

• ocrCompletedAt string · date-time

  Timestamp when OCR processing for this invoice payable was completed.

• canceledAt string · date-time

  Timestamp when this invoice payable was cancelled.

• issuedDate string · date

  Issue date of the original vendor invoice.

  The date the vendor issued the invoice. This model carries no postingDate — for the date the document hit the ledger, read the ledger line via GET /v1/ledger-transaction-lines.

• dueDate string · date

  Payment due date of the invoice payable.

• invoiceCreatedAt string · date-time

  Timestamp when the invoice payable record was created.

• updatedAt string · date-time

  Timestamp when the invoice payable record was last updated.

• purchaseOrderId string · uuid

  ID of the purchase order linked to this invoice payable, if any.

• lineItemsIncludeTax boolean

  Whether invoice line item amounts are entered as tax-inclusive. When true, line item amount is expected to be the gross amount including tax; when false, line item netAmount is expected to be the base amount excluding tax.

• localCurrencyFxRate number

  Foreign exchange rate to the ledger's local currency. If null, the system uses its default FX source.

• groupCurrencyFxRate number

  Foreign exchange rate to the ledger's group currency. If null, the system uses its default FX source.

• lineItems array of object

  List of line items belonging to this invoice payable.

  • id string · uuid

    ID of the invoice payable line item.

  • invoicePayableId string · uuid

    ID of the invoice payable this line item belongs to.

  • type string

    Type of the invoice payable line item (vendor invoice or reimbursement).

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

    One of REIMBURSEMENT SELF_BILLED VENDOR_INVOICE

  • metadata object

    Metadata for the invoice payable line item (ERP-specific fields and context).

    • type string

      Type of the invoice payable line item (vendor invoice or reimbursement).

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

      One of REIMBURSEMENT SELF_BILLED VENDOR_INVOICE

  • amount integer · int64

    Amount in cents, including tax. When lineItemsIncludeTax is true, amount represents the full tax-inclusive amount for this line.

  • netAmount integer · int64

    Net line amount in cents, excluding tax. When lineItemsIncludeTax is false, netAmount represents the base amount on which tax is calculated.

  • description string

    Description of this invoice payable line item.

  • taxCodeId string · uuid

    ID of the tax code applied to this line item.

  • taxAmount integer · int64

    Tax amount in cents for this line item.

  • accountId string · uuid

    ID of the ledger account used to book this line item.

  • costCenterId string · uuid

    ID of the cost center associated with this line item, if applicable.

  • amortizationStartDate string · date

    Start date for amortization of this line item.

  • amortizationEndDate string · date

    End date for amortization of this line item.

  • amortizationTemplateId string · uuid

    ID of the amortization template to use for this line item within Light Ledger.

  • customPropertiesOld object

    Legacy container for custom properties on this line item (deprecated/old format).

    • items object

  • aiValueSuggestions array of object

    AI-generated suggestions for line item values (e.g. account, cost center, tax code).

    • field string

    • fieldValues array of string

    • reasoning string

  • customProperties array of object

    Custom properties set on this invoice payable line item.

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • values array of object

      List of values. Note that this will be a single value unless the group input type supports multiple values

      • id string · uuid

        Unique identifier for the object

      • groupId string · uuid

        ID of the custom property group

      • groupInternalName string

        Internal name of the custom property group

      • companyId string · uuid

        ID of the company

      • internalName string

        Internal name of the custom property value

      • label string

        Label of the custom property value

      • context string

        Context/description of the custom property value

      • createdAt string · date-time

        Timestamp when the custom property value was created

      • updatedAt string · date-time

        Timestamp when the custom property value was last updated

  • createdAt string · date-time

    Timestamp when this invoice payable line item was created.

  • updatedAt string · date-time

    Timestamp when this invoice payable line item was last updated.

• customProperties array of object

  Custom properties set on the invoice payable header.

  • groupId string · uuid

    ID of the custom property group

  • groupInternalName string

    Internal name of the custom property group

  • values array of object

    List of values. Note that this will be a single value unless the group input type supports multiple values

    • id string · uuid

      Unique identifier for the object

    • groupId string · uuid

      ID of the custom property group

    • groupInternalName string

      Internal name of the custom property group

    • companyId string · uuid

      ID of the company

    • internalName string

      Internal name of the custom property value

    • label string

      Label of the custom property value

    • context string

      Context/description of the custom property value

    • createdAt string · date-time

      Timestamp when the custom property value was created

    • updatedAt string · date-time

      Timestamp when the custom property value was last updated

• paymentPausedBy string · uuid

  ID of the user who paused payment for this invoice payable, if payment is paused.

• paymentPausedAt string · date-time

  Timestamp when payment for this invoice payable was paused, if applicable.

• senderEmail string

  Email address from which the invoice payable was received, if known.

• documentName string

  Name of the original document file associated with this invoice payable.