Skip to main content
POST
/
public
/
v2
/
vendor-prepayments
/
Create VendorPrepayment record
curl --request POST \
  --url https://api.dualentry.com/public/v2/vendor-prepayments/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "company_id": 123,
  "vendor_id": 123,
  "check_number": "<string>",
  "amount": 123,
  "exchange_rate": 123,
  "bank_or_undeposited_funds_amount": 123,
  "memo": "<string>",
  "financial_transaction_to_validate_match": 123,
  "transaction_date": "2023-12-25",
  "custom_fields": [
    {}
  ],
  "account_number": 123,
  "attachments": [],
  "payment_method_id": 123,
  "record_status": "posted"
}
'
import requests

url = "https://api.dualentry.com/public/v2/vendor-prepayments/"

payload = {
"date": "2023-12-25",
"company_id": 123,
"vendor_id": 123,
"check_number": "<string>",
"amount": 123,
"exchange_rate": 123,
"bank_or_undeposited_funds_amount": 123,
"memo": "<string>",
"financial_transaction_to_validate_match": 123,
"transaction_date": "2023-12-25",
"custom_fields": [{}],
"account_number": 123,
"attachments": [],
"payment_method_id": 123,
"record_status": "posted"
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
date: '2023-12-25',
company_id: 123,
vendor_id: 123,
check_number: '<string>',
amount: 123,
exchange_rate: 123,
bank_or_undeposited_funds_amount: 123,
memo: '<string>',
financial_transaction_to_validate_match: 123,
transaction_date: '2023-12-25',
custom_fields: [{}],
account_number: 123,
attachments: [],
payment_method_id: 123,
record_status: 'posted'
})
};

fetch('https://api.dualentry.com/public/v2/vendor-prepayments/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dualentry.com/public/v2/vendor-prepayments/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'date' => '2023-12-25',
'company_id' => 123,
'vendor_id' => 123,
'check_number' => '<string>',
'amount' => 123,
'exchange_rate' => 123,
'bank_or_undeposited_funds_amount' => 123,
'memo' => '<string>',
'financial_transaction_to_validate_match' => 123,
'transaction_date' => '2023-12-25',
'custom_fields' => [
[

]
],
'account_number' => 123,
'attachments' => [

],
'payment_method_id' => 123,
'record_status' => 'posted'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.dualentry.com/public/v2/vendor-prepayments/"

payload := strings.NewReader("{\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"vendor_id\": 123,\n \"check_number\": \"<string>\",\n \"amount\": 123,\n \"exchange_rate\": 123,\n \"bank_or_undeposited_funds_amount\": 123,\n \"memo\": \"<string>\",\n \"financial_transaction_to_validate_match\": 123,\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"account_number\": 123,\n \"attachments\": [],\n \"payment_method_id\": 123,\n \"record_status\": \"posted\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.dualentry.com/public/v2/vendor-prepayments/")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"vendor_id\": 123,\n \"check_number\": \"<string>\",\n \"amount\": 123,\n \"exchange_rate\": 123,\n \"bank_or_undeposited_funds_amount\": 123,\n \"memo\": \"<string>\",\n \"financial_transaction_to_validate_match\": 123,\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"account_number\": 123,\n \"attachments\": [],\n \"payment_method_id\": 123,\n \"record_status\": \"posted\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v2/vendor-prepayments/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date\": \"2023-12-25\",\n \"company_id\": 123,\n \"vendor_id\": 123,\n \"check_number\": \"<string>\",\n \"amount\": 123,\n \"exchange_rate\": 123,\n \"bank_or_undeposited_funds_amount\": 123,\n \"memo\": \"<string>\",\n \"financial_transaction_to_validate_match\": 123,\n \"transaction_date\": \"2023-12-25\",\n \"custom_fields\": [\n {}\n ],\n \"account_number\": 123,\n \"attachments\": [],\n \"payment_method_id\": 123,\n \"record_status\": \"posted\"\n}"

response = http.request(request)
puts response.read_body
{
  "internal_id": 123,
  "transaction_ids": [
    123
  ],
  "number": 123,
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "vendor_id": 123,
  "vendor_name": "<string>",
  "account_number": 123,
  "date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "check_number": "<string>",
  "amount": "<string>",
  "used_amount": "<string>",
  "remaining_amount": "<string>",
  "exchange_rate": "<string>",
  "bank_or_undeposited_funds_amount": "<string>",
  "memo": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "custom_fields": [],
  "attachments": [],
  "payment_method_id": 123,
  "recurring_record_id": 123
}
{
"errors": {},
"success": false
}
{
"errors": {},
"success": false
}
{
"errors": {},
"success": false
}

Authorizations

X-API-KEY
string
header
required

Body

application/json
date
string<date>
required
company_id
integer
required
vendor_id
integer
required
check_number
string
required
amount
required
currency_iso_4217_code
enum<string>
required
Available options:
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
exchange_rate
required
bank_or_undeposited_funds_amount
required
memo
string
required
financial_transaction_to_validate_match
integer | null
transaction_date
string<date> | null
custom_fields
Custom Fields · object[] | null
account_number
integer | null
attachments
AttachmentSchemaOut · object[]
payment_method_id
integer | null
record_status
enum<string>
default:posted
Available options:
draft,
posted,
archived

Response

OK

internal_id
integer
required
transaction_ids
integer[]
required
number
integer
required
company_id
integer
required
company_name
string
required
company_currency
string
required
vendor_id
integer
required
vendor_name
string
required
account_number
integer
required
date
string<date>
required
transaction_date
string<date>
required
check_number
string
required
amount
string
required

Total transaction amount

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
used_amount
string
required

Amount that was already applied to Bills

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
remaining_amount
string
required

Amount that can be applied to Bills

Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
currency_iso_4217_code
enum<string>
required
Available options:
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
exchange_rate
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,16}0*$
bank_or_undeposited_funds_amount
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d{0,2}0*$
memo
string
required
record_status
enum<string>
required
Available options:
draft,
posted,
archived
paper_check_status
enum<string> | null
required
Available options:
printed,
not_printed,
archived
created_at
string<date-time>
required

Date and time the record was created

updated_at
string<date-time>
required

Date and time the record was last updated

custom_fields
CustomFieldValuePairOutputSchema · object[]
attachments
PublicAttachmentSchemaOut · object[]
payment_method_id
integer | null
recurring_record_id
integer | null
Last modified on July 13, 2026