Reverse invoice payable payment
Reverses a clearing applied to an invoice payable — either a bank payment (BP) or a credit note (CN) — identified by its accounting document ID. Use the List invoice payable payments endpoint to obtain the accountingDocumentId and type of the clearing to reverse. Reversing removes the clearing’s effect from the ledger and transitions the invoice back to UNPAID or PARTIALLY_PAID depending on the remaining outstanding balance. Optionally set shouldArchiveClearingDocument to also archive the underlying bank payment or credit note.
Authorizations
Basic authentication header of the form Basic <api_key>, where <api_key> is your api key.
Path Parameters
Body
ID of the clearing accounting document to reverse — the bank payment or credit note that was applied to this invoice payable. Obtain it from the accountingDocumentId of an entry returned by the List invoice payable payments endpoint.
Type of the clearing being reversed: BP for a bank payment or CN for a credit note. Matches the type of the corresponding entry returned by the List invoice payable payments endpoint.
BP- Bank paymentCN- Credit note
⚠️ This enum is not exhaustive; new values may be added in the future.
BP, CN Whether to also archive the underlying clearing document (bank payment or credit note) after reversing it.
Response
default response
External ID of the invoice payable object.
Type of the invoice payable (e.g. vendor invoice or reimbursement).
⚠️ This enum is not exhaustive; new values may be added in the future.
REIMBURSEMENT, VENDOR_INVOICE Metadata specific to the invoice payable type (e.g. reimbursement- or vendor-specific fields).
Internal ID of the underlying invoice payable record.
ID of the company this invoice payable belongs to.
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.
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 High-level reason why processing the invoice payable failed, if any.
⚠️ This enum is not exhaustive; new values may be added in the future.
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 Failure context when vendor onboarding fails.
Failure context when vendor onboarding fails.
Approval note associated with the invoice payable (e.g. approver comments).
Reason why the invoice payable was cancelled, if applicable.
Name of the payee for this invoice payable.
Payee IBAN used for payment of this invoice payable.
Payee BBAN (Basic Bank Account Number) used for local payments.
Payee bank BIC/SWIFT code.
Payee bank/branch code used for local payments.
Payee Swedish Bankgiro number, if applicable.
Payee Swedish Plusgiro number, if applicable.
Country of the payee.
⚠️ This enum is not exhaustive; new values may be added in the future.
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 Street address of the payee.
ZIP/postal code of the payee.
Name of the payee's bank.
Country of the payee's bank.
⚠️ This enum is not exhaustive; new values may be added in the future.
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 Street address of the payee's bank.
ZIP/postal code of the payee's bank.
City of the payee.
City of the payee's bank.
ID of the vendor entity this invoice payable is linked to, if any.
Vendor details extracted from the invoice using OCR.
ID of the company entity this invoice payable is booked under.
Invoice number provided on the vendor invoice.
Total invoice amount in cents, expressed in the invoice currency.
Outstanding invoice balance to be paid in cents, expressed in the invoice currency.
"USD"
Description or memo for the invoice payable.
ID of the sender bank account from which this invoice payable will be paid.
FI (Finnish reference) number associated with this invoice payable, if applicable.
Norwegian KID reference associated with this invoice payable, if applicable.
Swiss payment reference (QR-Reference or Creditor Reference/SCOR) associated with this invoice payable, if applicable.
Date/time when payment is scheduled or was executed for this invoice payable.
Timestamp when OCR processing for this invoice payable was completed.
Timestamp when this invoice payable was cancelled.
Issue date of the original vendor invoice.
Payment due date of the invoice payable.
Timestamp when the invoice payable record was created.
Timestamp when the invoice payable record was last updated.
ID of the purchase order linked to this invoice payable, if any.
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.
Foreign exchange rate to the ledger's local currency. If null, the system uses its default FX source.
Foreign exchange rate to the ledger's group currency. If null, the system uses its default FX source.
List of line items belonging to this invoice payable.
Custom properties set on the invoice payable header.
Custom properties set on the vendor.
ID of the user who paused payment for this invoice payable, if payment is paused.
Timestamp when payment for this invoice payable was paused, if applicable.
Email address from which the invoice payable was received, if known.
Name of the original document file associated with this invoice payable.