Update VendorPaymentV2 record (partial)

curl --request PATCH \
  --url https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "custom_fields": [
    {}
  ],
  "company_id": 123,
  "check_number": "<string>",
  "account_number": 123,
  "exchange_rate": 123,
  "memo": "<string>",
  "items": [
    {
      "amount": 123,
      "position": 123,
      "id": 123,
      "bill_number": 123,
      "vendor_credit_number": 123,
      "journal_entry_line_id": 123,
      "intercompany_journal_entry_line_id": 123,
      "account_id": 123,
      "description": "",
      "customer_id": 123,
      "vendor_id": 123
    }
  ],
  "attachments": [
    {
      "id": 123,
      "file_name": "<string>",
      "file_size": 123,
      "download_url": "<string>",
      "upload_url": "<string>",
      "category": "default"
    }
  ],
  "bank_or_credit_card_amount": 1,
  "payment_method_id": 123,
  "line_date_validation": true,
  "date": "2023-12-25",
  "transaction_date": "2023-12-25"
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/"

payload = {
    "custom_fields": [{}],
    "company_id": 123,
    "check_number": "<string>",
    "account_number": 123,
    "exchange_rate": 123,
    "memo": "<string>",
    "items": [
        {
            "amount": 123,
            "position": 123,
            "id": 123,
            "bill_number": 123,
            "vendor_credit_number": 123,
            "journal_entry_line_id": 123,
            "intercompany_journal_entry_line_id": 123,
            "account_id": 123,
            "description": "",
            "customer_id": 123,
            "vendor_id": 123
        }
    ],
    "attachments": [
        {
            "id": 123,
            "file_name": "<string>",
            "file_size": 123,
            "download_url": "<string>",
            "upload_url": "<string>",
            "category": "default"
        }
    ],
    "bank_or_credit_card_amount": 1,
    "payment_method_id": 123,
    "line_date_validation": True,
    "date": "2023-12-25",
    "transaction_date": "2023-12-25"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    custom_fields: [{}],
    company_id: 123,
    check_number: '<string>',
    account_number: 123,
    exchange_rate: 123,
    memo: '<string>',
    items: [
      {
        amount: 123,
        position: 123,
        id: 123,
        bill_number: 123,
        vendor_credit_number: 123,
        journal_entry_line_id: 123,
        intercompany_journal_entry_line_id: 123,
        account_id: 123,
        description: '',
        customer_id: 123,
        vendor_id: 123
      }
    ],
    attachments: [
      {
        id: 123,
        file_name: '<string>',
        file_size: 123,
        download_url: '<string>',
        upload_url: '<string>',
        category: 'default'
      }
    ],
    bank_or_credit_card_amount: 1,
    payment_method_id: 123,
    line_date_validation: true,
    date: '2023-12-25',
    transaction_date: '2023-12-25'
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/', 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/v3-alpha/vendor-payments/{record_number}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'custom_fields' => [
        [
                
        ]
    ],
    'company_id' => 123,
    'check_number' => '<string>',
    'account_number' => 123,
    'exchange_rate' => 123,
    'memo' => '<string>',
    'items' => [
        [
                'amount' => 123,
                'position' => 123,
                'id' => 123,
                'bill_number' => 123,
                'vendor_credit_number' => 123,
                'journal_entry_line_id' => 123,
                'intercompany_journal_entry_line_id' => 123,
                'account_id' => 123,
                'description' => '',
                'customer_id' => 123,
                'vendor_id' => 123
        ]
    ],
    'attachments' => [
        [
                'id' => 123,
                'file_name' => '<string>',
                'file_size' => 123,
                'download_url' => '<string>',
                'upload_url' => '<string>',
                'category' => 'default'
        ]
    ],
    'bank_or_credit_card_amount' => 1,
    'payment_method_id' => 123,
    'line_date_validation' => true,
    'date' => '2023-12-25',
    'transaction_date' => '2023-12-25'
  ]),
  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/v3-alpha/vendor-payments/{record_number}/"

	payload := strings.NewReader("{\n  \"custom_fields\": [\n    {}\n  ],\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"position\": 123,\n      \"id\": 123,\n      \"bill_number\": 123,\n      \"vendor_credit_number\": 123,\n      \"journal_entry_line_id\": 123,\n      \"intercompany_journal_entry_line_id\": 123,\n      \"account_id\": 123,\n      \"description\": \"\",\n      \"customer_id\": 123,\n      \"vendor_id\": 123\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"file_size\": 123,\n      \"download_url\": \"<string>\",\n      \"upload_url\": \"<string>\",\n      \"category\": \"default\"\n    }\n  ],\n  \"bank_or_credit_card_amount\": 1,\n  \"payment_method_id\": 123,\n  \"line_date_validation\": true,\n  \"date\": \"2023-12-25\",\n  \"transaction_date\": \"2023-12-25\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_fields\": [\n    {}\n  ],\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"position\": 123,\n      \"id\": 123,\n      \"bill_number\": 123,\n      \"vendor_credit_number\": 123,\n      \"journal_entry_line_id\": 123,\n      \"intercompany_journal_entry_line_id\": 123,\n      \"account_id\": 123,\n      \"description\": \"\",\n      \"customer_id\": 123,\n      \"vendor_id\": 123\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"file_size\": 123,\n      \"download_url\": \"<string>\",\n      \"upload_url\": \"<string>\",\n      \"category\": \"default\"\n    }\n  ],\n  \"bank_or_credit_card_amount\": 1,\n  \"payment_method_id\": 123,\n  \"line_date_validation\": true,\n  \"date\": \"2023-12-25\",\n  \"transaction_date\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom_fields\": [\n    {}\n  ],\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"position\": 123,\n      \"id\": 123,\n      \"bill_number\": 123,\n      \"vendor_credit_number\": 123,\n      \"journal_entry_line_id\": 123,\n      \"intercompany_journal_entry_line_id\": 123,\n      \"account_id\": 123,\n      \"description\": \"\",\n      \"customer_id\": 123,\n      \"vendor_id\": 123\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"file_size\": 123,\n      \"download_url\": \"<string>\",\n      \"upload_url\": \"<string>\",\n      \"category\": \"default\"\n    }\n  ],\n  \"bank_or_credit_card_amount\": 1,\n  \"payment_method_id\": 123,\n  \"line_date_validation\": true,\n  \"date\": \"2023-12-25\",\n  \"transaction_date\": \"2023-12-25\"\n}"

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

{
  "transaction_ids": [
    123
  ],
  "internal_id": 123,
  "number": 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>",
  "account_number": 123,
  "items": [],
  "vendor_id": 123,
  "vendor_name": "<string>",
  "payment_method_id": 123,
  "source": "manual",
  "has_more_lines": false,
  "lines_count": 0
}

{
  "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>"
}

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

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

Vendor Payments

Update VendorPaymentV2 record (partial)

Partially update an existing VendorPaymentV2 record. Send only the fields you want to change. Anything you don’t send stays as it is. Updates are subject to the same constraints as the full update endpoint: period locks, payment-applied restrictions, and approval-workflow rules apply.

Side effects

If an approval workflow matches this request, DualEntry can set record_status back to draft.
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_printed paper check, even if the record is draft.
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 to archived.

Additional validations

Fails with 422 if the request changes check_number while a paper check is not_printed.
Fails with 503 if the exchange rate for the transaction date is unavailable.
Fails with 422 if the bank currency differs from the transaction currency and bank_or_credit_card_amount is missing, or is 0 while the applied amount is not 0.
Fails with 422 and the error code posting_date_after_limit if date is after the latest posting date that your organization allows.
Fails with 422 if you set an inactive, archived, or draft customer or vendor, or an inactive company.
Fails with 422 if a line account is not available to the record’s company.
Fails with 422 if 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.

PATCH

public

v3-alpha

vendor-payments

{record_number}

Update VendorPaymentV2 record (partial)

curl --request PATCH \
  --url https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "custom_fields": [
    {}
  ],
  "company_id": 123,
  "check_number": "<string>",
  "account_number": 123,
  "exchange_rate": 123,
  "memo": "<string>",
  "items": [
    {
      "amount": 123,
      "position": 123,
      "id": 123,
      "bill_number": 123,
      "vendor_credit_number": 123,
      "journal_entry_line_id": 123,
      "intercompany_journal_entry_line_id": 123,
      "account_id": 123,
      "description": "",
      "customer_id": 123,
      "vendor_id": 123
    }
  ],
  "attachments": [
    {
      "id": 123,
      "file_name": "<string>",
      "file_size": 123,
      "download_url": "<string>",
      "upload_url": "<string>",
      "category": "default"
    }
  ],
  "bank_or_credit_card_amount": 1,
  "payment_method_id": 123,
  "line_date_validation": true,
  "date": "2023-12-25",
  "transaction_date": "2023-12-25"
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/"

payload = {
    "custom_fields": [{}],
    "company_id": 123,
    "check_number": "<string>",
    "account_number": 123,
    "exchange_rate": 123,
    "memo": "<string>",
    "items": [
        {
            "amount": 123,
            "position": 123,
            "id": 123,
            "bill_number": 123,
            "vendor_credit_number": 123,
            "journal_entry_line_id": 123,
            "intercompany_journal_entry_line_id": 123,
            "account_id": 123,
            "description": "",
            "customer_id": 123,
            "vendor_id": 123
        }
    ],
    "attachments": [
        {
            "id": 123,
            "file_name": "<string>",
            "file_size": 123,
            "download_url": "<string>",
            "upload_url": "<string>",
            "category": "default"
        }
    ],
    "bank_or_credit_card_amount": 1,
    "payment_method_id": 123,
    "line_date_validation": True,
    "date": "2023-12-25",
    "transaction_date": "2023-12-25"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    custom_fields: [{}],
    company_id: 123,
    check_number: '<string>',
    account_number: 123,
    exchange_rate: 123,
    memo: '<string>',
    items: [
      {
        amount: 123,
        position: 123,
        id: 123,
        bill_number: 123,
        vendor_credit_number: 123,
        journal_entry_line_id: 123,
        intercompany_journal_entry_line_id: 123,
        account_id: 123,
        description: '',
        customer_id: 123,
        vendor_id: 123
      }
    ],
    attachments: [
      {
        id: 123,
        file_name: '<string>',
        file_size: 123,
        download_url: '<string>',
        upload_url: '<string>',
        category: 'default'
      }
    ],
    bank_or_credit_card_amount: 1,
    payment_method_id: 123,
    line_date_validation: true,
    date: '2023-12-25',
    transaction_date: '2023-12-25'
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/', 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/v3-alpha/vendor-payments/{record_number}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'custom_fields' => [
        [
                
        ]
    ],
    'company_id' => 123,
    'check_number' => '<string>',
    'account_number' => 123,
    'exchange_rate' => 123,
    'memo' => '<string>',
    'items' => [
        [
                'amount' => 123,
                'position' => 123,
                'id' => 123,
                'bill_number' => 123,
                'vendor_credit_number' => 123,
                'journal_entry_line_id' => 123,
                'intercompany_journal_entry_line_id' => 123,
                'account_id' => 123,
                'description' => '',
                'customer_id' => 123,
                'vendor_id' => 123
        ]
    ],
    'attachments' => [
        [
                'id' => 123,
                'file_name' => '<string>',
                'file_size' => 123,
                'download_url' => '<string>',
                'upload_url' => '<string>',
                'category' => 'default'
        ]
    ],
    'bank_or_credit_card_amount' => 1,
    'payment_method_id' => 123,
    'line_date_validation' => true,
    'date' => '2023-12-25',
    'transaction_date' => '2023-12-25'
  ]),
  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/v3-alpha/vendor-payments/{record_number}/"

	payload := strings.NewReader("{\n  \"custom_fields\": [\n    {}\n  ],\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"position\": 123,\n      \"id\": 123,\n      \"bill_number\": 123,\n      \"vendor_credit_number\": 123,\n      \"journal_entry_line_id\": 123,\n      \"intercompany_journal_entry_line_id\": 123,\n      \"account_id\": 123,\n      \"description\": \"\",\n      \"customer_id\": 123,\n      \"vendor_id\": 123\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"file_size\": 123,\n      \"download_url\": \"<string>\",\n      \"upload_url\": \"<string>\",\n      \"category\": \"default\"\n    }\n  ],\n  \"bank_or_credit_card_amount\": 1,\n  \"payment_method_id\": 123,\n  \"line_date_validation\": true,\n  \"date\": \"2023-12-25\",\n  \"transaction_date\": \"2023-12-25\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"custom_fields\": [\n    {}\n  ],\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"position\": 123,\n      \"id\": 123,\n      \"bill_number\": 123,\n      \"vendor_credit_number\": 123,\n      \"journal_entry_line_id\": 123,\n      \"intercompany_journal_entry_line_id\": 123,\n      \"account_id\": 123,\n      \"description\": \"\",\n      \"customer_id\": 123,\n      \"vendor_id\": 123\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"file_size\": 123,\n      \"download_url\": \"<string>\",\n      \"upload_url\": \"<string>\",\n      \"category\": \"default\"\n    }\n  ],\n  \"bank_or_credit_card_amount\": 1,\n  \"payment_method_id\": 123,\n  \"line_date_validation\": true,\n  \"date\": \"2023-12-25\",\n  \"transaction_date\": \"2023-12-25\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/vendor-payments/{record_number}/")

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

request = Net::HTTP::Patch.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"custom_fields\": [\n    {}\n  ],\n  \"company_id\": 123,\n  \"check_number\": \"<string>\",\n  \"account_number\": 123,\n  \"exchange_rate\": 123,\n  \"memo\": \"<string>\",\n  \"items\": [\n    {\n      \"amount\": 123,\n      \"position\": 123,\n      \"id\": 123,\n      \"bill_number\": 123,\n      \"vendor_credit_number\": 123,\n      \"journal_entry_line_id\": 123,\n      \"intercompany_journal_entry_line_id\": 123,\n      \"account_id\": 123,\n      \"description\": \"\",\n      \"customer_id\": 123,\n      \"vendor_id\": 123\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": 123,\n      \"file_name\": \"<string>\",\n      \"file_size\": 123,\n      \"download_url\": \"<string>\",\n      \"upload_url\": \"<string>\",\n      \"category\": \"default\"\n    }\n  ],\n  \"bank_or_credit_card_amount\": 1,\n  \"payment_method_id\": 123,\n  \"line_date_validation\": true,\n  \"date\": \"2023-12-25\",\n  \"transaction_date\": \"2023-12-25\"\n}"

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

{
  "transaction_ids": [
    123
  ],
  "internal_id": 123,
  "number": 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>",
  "account_number": 123,
  "items": [],
  "vendor_id": 123,
  "vendor_name": "<string>",
  "payment_method_id": 123,
  "source": "manual",
  "has_more_lines": false,
  "lines_count": 0
}

{
  "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>"
}

{
  "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

Path Parameters

record_number

integer

required

The number attribute of the record.

Body

application/json

Partial update for PATCH /public/vendor-payments/{number}/.

Send only the fields you want to change. Unset fields stay as they are. The save uses the same rules as a full update. Period locks, applied-payment checks, and approval workflow rules apply. A sent attachments list replaces the existing files. Omit attachments to keep them. A sent items list replaces the application lines. Omit items to keep them.

custom_fields

Custom Fields · object[] | null

company_id

integer | null

check_number

string | null

account_number

integer | null

currency_iso_4217_code

enum<string> | null

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

If you omit this field, DualEntry keeps the stored rate. If you omit this field and you change transaction_date or currency_iso_4217_code, DualEntry calculates a new rate. This also applies when you change company_id to a company with a different base currency. A change to date also changes the transaction date when your organization does not keep the two dates independent. DualEntry stores a rate that you send, including 1.0, and calculates a new rate when you send null.

memo

string | null

items

PublicVendorPaymentItemIn · object[] | null

Show child attributes

attachments

AttachmentSchemaOut · object[] | null

Show child attributes

bank_or_credit_card_amount

If you omit this field and you do not change the bank account, DualEntry keeps the stored amount. If you send null, DualEntry calculates the amount again, as for a change of the bank account. If you change the bank account and you omit this field, DualEntry uses the payment amount when the currencies match. If the bank currency differs from the transaction currency, send this field. Send 0 only when the applied amount is 0.

Required range: x >= 0

payment_method_id

integer | null

record_status

enum<string> | null

Available options:

draft,

posted,

archived

line_date_validation

boolean | null

date

string<date> | null

transaction_date

string<date> | null

Response

transaction_ids

integer[]

required

internal_id

integer

required

number

integer

required

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

account_number

integer | null

items

PublicVendorPaymentItemOut · object[]

Show child attributes

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

has_more_lines

boolean

default:false

lines_count

integer

default:0

Overview

Organization

Accounting Setup

Transactions

Money In

Money Out

Financial & Banking

Assets

Tax

Financial Planning

Reporting

Governance

Developers

Monitoring

OAuth

Update VendorPaymentV2 record (partial)

Authorizations

Headers

Path Parameters

Body

Response