Create VendorPayment record (v1)

Create VendorPayment record

curl --request POST \
  --url https://api.dualentry.com/public/v1/vendor-payments/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "company_id": 123,
  "check_number": "<string>",
  "account_number": 123,
  "exchange_rate": 123,
  "memo": "<string>",
  "custom_fields": [
    {}
  ],
  "transaction_date": "2023-12-25",
  "items": [],
  "attachments": [],
  "bank_or_credit_card_amount": "0.00",
  "payment_method_id": 123,
  "record_status": "posted",
  "line_date_validation": true
}
'

import requests

url = "https://api.dualentry.com/public/v1/vendor-payments/"

payload = {
    "date": "2023-12-25",
    "company_id": 123,
    "check_number": "<string>",
    "account_number": 123,
    "exchange_rate": 123,
    "memo": "<string>",
    "custom_fields": [{}],
    "transaction_date": "2023-12-25",
    "items": [],
    "attachments": [],
    "bank_or_credit_card_amount": "0.00",
    "payment_method_id": 123,
    "record_status": "posted",
    "line_date_validation": True
}
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,
    check_number: '<string>',
    account_number: 123,
    exchange_rate: 123,
    memo: '<string>',
    custom_fields: [{}],
    transaction_date: '2023-12-25',
    items: [],
    attachments: [],
    bank_or_credit_card_amount: '0.00',
    payment_method_id: 123,
    record_status: 'posted',
    line_date_validation: true
  })
};

fetch('https://api.dualentry.com/public/v1/vendor-payments/', 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/v1/vendor-payments/",
  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,
    'check_number' => '<string>',
    'account_number' => 123,
    'exchange_rate' => 123,
    'memo' => '<string>',
    'custom_fields' => [
        [
                
        ]
    ],
    'transaction_date' => '2023-12-25',
    'items' => [
        
    ],
    'attachments' => [
        
    ],
    'bank_or_credit_card_amount' => '0.00',
    'payment_method_id' => 123,
    'record_status' => 'posted',
    'line_date_validation' => true
  ]),
  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/v1/vendor-payments/"

	payload := strings.NewReader("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"items\": [],\n  \"attachments\": [],\n  \"bank_or_credit_card_amount\": \"0.00\",\n  \"payment_method_id\": 123,\n  \"record_status\": \"posted\",\n  \"line_date_validation\": true\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/v1/vendor-payments/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"items\": [],\n  \"attachments\": [],\n  \"bank_or_credit_card_amount\": \"0.00\",\n  \"payment_method_id\": 123,\n  \"record_status\": \"posted\",\n  \"line_date_validation\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"items\": [],\n  \"attachments\": [],\n  \"bank_or_credit_card_amount\": \"0.00\",\n  \"payment_method_id\": 123,\n  \"record_status\": \"posted\",\n  \"line_date_validation\": true\n}"

response = http.request(request)
puts response.read_body

{
  "transaction_ids": [
    123
  ],
  "internal_id": 123,
  "number": 123,
  "account_number": 123,
  "items": [
    {
      "amount": "<string>",
      "position": 123,
      "bank_or_credit_card_amount": "<string>",
      "bill_number": 123,
      "vendor_credit_number": 123,
      "journal_entry_line_id": 123,
      "intercompany_journal_entry_line_id": 123
    }
  ],
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "memo": "<string>",
  "check_number": "<string>",
  "date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "currency_iso_4217_code": "AED",
  "exchange_rate": "<string>",
  "bank_or_credit_card_amount": "<string>",
  "amount": "<string>",
  "record_status": "draft",
  "paper_check_status": "printed",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "custom_fields": [],
  "integration_remote_records": [],
  "attachments": [],
  "classifications": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "vendor_id": 123,
  "vendor_name": "<string>",
  "payment_method_id": 123,
  "source": "manual"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

POST

public

vendor-payments

Create VendorPayment record

curl --request POST \
  --url https://api.dualentry.com/public/v1/vendor-payments/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "date": "2023-12-25",
  "company_id": 123,
  "check_number": "<string>",
  "account_number": 123,
  "exchange_rate": 123,
  "memo": "<string>",
  "custom_fields": [
    {}
  ],
  "transaction_date": "2023-12-25",
  "items": [],
  "attachments": [],
  "bank_or_credit_card_amount": "0.00",
  "payment_method_id": 123,
  "record_status": "posted",
  "line_date_validation": true
}
'

import requests

url = "https://api.dualentry.com/public/v1/vendor-payments/"

payload = {
    "date": "2023-12-25",
    "company_id": 123,
    "check_number": "<string>",
    "account_number": 123,
    "exchange_rate": 123,
    "memo": "<string>",
    "custom_fields": [{}],
    "transaction_date": "2023-12-25",
    "items": [],
    "attachments": [],
    "bank_or_credit_card_amount": "0.00",
    "payment_method_id": 123,
    "record_status": "posted",
    "line_date_validation": True
}
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,
    check_number: '<string>',
    account_number: 123,
    exchange_rate: 123,
    memo: '<string>',
    custom_fields: [{}],
    transaction_date: '2023-12-25',
    items: [],
    attachments: [],
    bank_or_credit_card_amount: '0.00',
    payment_method_id: 123,
    record_status: 'posted',
    line_date_validation: true
  })
};

fetch('https://api.dualentry.com/public/v1/vendor-payments/', 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/v1/vendor-payments/",
  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,
    'check_number' => '<string>',
    'account_number' => 123,
    'exchange_rate' => 123,
    'memo' => '<string>',
    'custom_fields' => [
        [
                
        ]
    ],
    'transaction_date' => '2023-12-25',
    'items' => [
        
    ],
    'attachments' => [
        
    ],
    'bank_or_credit_card_amount' => '0.00',
    'payment_method_id' => 123,
    'record_status' => 'posted',
    'line_date_validation' => true
  ]),
  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/v1/vendor-payments/"

	payload := strings.NewReader("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"items\": [],\n  \"attachments\": [],\n  \"bank_or_credit_card_amount\": \"0.00\",\n  \"payment_method_id\": 123,\n  \"record_status\": \"posted\",\n  \"line_date_validation\": true\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/v1/vendor-payments/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"items\": [],\n  \"attachments\": [],\n  \"bank_or_credit_card_amount\": \"0.00\",\n  \"payment_method_id\": 123,\n  \"record_status\": \"posted\",\n  \"line_date_validation\": true\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"custom_fields\": [\n    {}\n  ],\n  \"transaction_date\": \"2023-12-25\",\n  \"items\": [],\n  \"attachments\": [],\n  \"bank_or_credit_card_amount\": \"0.00\",\n  \"payment_method_id\": 123,\n  \"record_status\": \"posted\",\n  \"line_date_validation\": true\n}"

response = http.request(request)
puts response.read_body

{
  "transaction_ids": [
    123
  ],
  "internal_id": 123,
  "number": 123,
  "account_number": 123,
  "items": [
    {
      "amount": "<string>",
      "position": 123,
      "bank_or_credit_card_amount": "<string>",
      "bill_number": 123,
      "vendor_credit_number": 123,
      "journal_entry_line_id": 123,
      "intercompany_journal_entry_line_id": 123
    }
  ],
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "memo": "<string>",
  "check_number": "<string>",
  "date": "2023-12-25",
  "transaction_date": "2023-12-25",
  "currency_iso_4217_code": "AED",
  "exchange_rate": "<string>",
  "bank_or_credit_card_amount": "<string>",
  "amount": "<string>",
  "record_status": "draft",
  "paper_check_status": "printed",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "custom_fields": [],
  "integration_remote_records": [],
  "attachments": [],
  "classifications": [],
  "created_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "updated_by": {
    "actor_type": "<string>",
    "email": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "via": "<string>",
    "agent_id": 123,
    "agent_name": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "code": "<string>",
  "vendor_id": 123,
  "vendor_name": "<string>",
  "payment_method_id": 123,
  "source": "manual"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

{
  "errors": {},
  "success": false,
  "error_code": "<string>",
  "error_reason": "<string>"
}

Authorizations

X-API-KEY

string

header

required

Headers

Idempotency-Key

string

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.

Maximum string length: 255

Body

application/json

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.

date

string<date>

required

company_id

integer

required

check_number

string

required

account_number

integer

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

memo

string

required

custom_fields

Custom Fields · object[] | null

transaction_date

string<date> | null

items

PublicVendorPaymentItemIn · object[]

Show child attributes

attachments

AttachmentSchemaOut · object[]

Show child attributes

bank_or_credit_card_amount

default:0.00

Bank or credit card amount

Required range: x >= 0

payment_method_id

integer | null

record_status

enum<string>

default:posted

Available options:

draft,

posted,

archived

line_date_validation

boolean

default:true

Response

transaction_ids

integer[]

required

internal_id

integer

required

number

integer

required

account_number

integer | null

required

items

PublicVendorPaymentItemOut · object[]

required

Show child attributes

company_id

integer

required

company_name

string

required

company_currency

string

required

memo

string

required

check_number

string

required

date

string<date>

required

Posting date (GL date) - the date when the transaction is recorded in the general ledger

transaction_date

string<date>

required

Transaction date (inception date) - the date when the transaction actually occurred

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_credit_card_amount

string

required

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

amount

string

required

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

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[]

Show child attributes

integration_remote_records

IntegrationRemoteRecordSchemaOut · object[]

Show child attributes

attachments

PublicAttachmentSchemaOut · object[]

Show child attributes

classifications

PublicRecordClassificationsSchemaOut · object[]

Show child attributes

created_by

AuditActorSchemaOut · object | null

Schema for audit actor information.

Show child attributes

updated_by

AuditActorSchemaOut · object | null

Schema for audit actor information.

Show child attributes

code

string | null

vendor_id

integer | null

vendor_name

string | null

payment_method_id

integer | null

source

enum<string>

default:manual

Creation source. manual means DualEntry. bank_match_ai means Bank Match Agent. bank_match_rule means a bank match rule.

Available options:

manual,

bank_match_ai,

bank_match_rule,

banking,

payments

Last modified on October 8, 2026

Overview

V1

Authorizations

Headers

Body

Response