Create VendorPaymentV2 record
Create a new VendorPaymentV2 record with the provided data. Validates all required fields and business rules.
Side effects
- If an approval workflow matches this request, DualEntry can set
record_statusback todraft. - If this record already has an active bank match, and an approval workflow holds the record, DualEntry returns those matches to
draft. - If the customer or vendor is intercompany, DualEntry also writes a transaction in the elimination company.
- If the record has a bank account and a payment method that prints checks, DualEntry creates a
not_printedpaper check, even if the record isdraft. - If a printed or not-printed paper check already exists, DualEntry skips paper-check creation.
- If you clear
payment_method_id, or set it to a payment method that does not print checks, DualEntry sets the associated unprinted paper check toarchived.
Additional validations
- Fails with
422if the request changescheck_numberwhile a paper check isnot_printed. - Fails with
503if the exchange rate for the transaction date is unavailable. - Fails with
422if the bank currency differs from the transaction currency andbank_or_credit_card_amountis missing, or is0while the applied amount is not0. - Fails with
422and the error codeposting_date_after_limitifdateis after the latest posting date that your organization allows. - Fails with
422if you set an inactive, archived, or draft customer or vendor, or an inactive company. - Fails with
422if a line account is not available to the record’s company. - Fails with
422if you set the customer or vendor that stands for the record’s own company as a party. - A reference that the record or its linked source record already holds passes these checks.
Authorizations
Headers
Optional. A unique value (a UUID works well) identifying this operation. If the request is repeated with the same key, the original response is replayed instead of the operation running again, so a retry cannot create a duplicate record. Results are replayable for 48 hours. Reusing a key with a different request body returns 422.
255Query Parameters
When false, store submitted line classifications, including an empty list. When omitted, organization defaults apply to new lines with omitted or empty classifications only when the organization setting is enabled.
Body
Create or replace a vendor payment.
The save posts a general ledger transaction. It applies the payment to bills, vendor credits, and journal entry lines. It computes realized, rounding, and matching gain or loss. It posts an elimination transaction when the vendor is intercompany. It creates a paper check when the payment method requires printing. A sent attachments list replaces the existing files.
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMW, ZWL Bank or credit card account number. Omit this when the applied amount is zero.
If you omit this field or send null, DualEntry calculates the rate from the company base currency, the transaction currency, and the transaction date. A date of today or later uses the rate for yesterday (UTC). A rate you send is stored, including 1.0.
If the bank currency matches the transaction currency and you omit this field or send null, DualEntry uses the payment amount. If the bank currency differs from the transaction currency, this field is required. Send 0 only when the applied amount is 0. An amount you send is stored.
x >= 0draft, posted, archived Response
OK
Posting date (GL date) - the date when the transaction is recorded in the general ledger
Transaction date (inception date) - the date when the transaction actually occurred
AED, AFN, ALL, AMD, ANG, AOA, ARS, AUD, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BRL, BSD, BTN, BWP, BYN, BZD, CAD, CDF, CHF, CLF, CLP, CNY, COP, CRC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, EUR, FJD, FKP, GBP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HTG, HUF, IDR, ILS, INR, IQD, IRR, ISK, JMD, JOD, JPY, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NGN, NIO, NOK, NPR, NZD, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SEK, SGD, SHP, SLL, SOS, SRD, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USD, UYU, UZS, VES, VND, VUV, WST, XAF, XAG, XAU, XCD, XDR, XOF, XPD, XPF, XPT, YER, ZAR, ZMW, ZWL ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$draft, posted, archived printed, not_printed, archived Date and time the record was created
Date and time the record was last updated
Schema for audit actor information.
Schema for audit actor information.
Creation source. manual means DualEntry. bank_match_ai means Bank Match Agent. bank_match_rule means a bank match rule.
manual, bank_match_ai, bank_match_rule, banking, payments