Merge vendors

curl --request POST \
  --url https://api.dualentry.com/public/v3-alpha/vendors/merge/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "target_vendor_id": 123,
  "source_vendor_ids": [
    123
  ],
  "field_sources": {},
  "custom_field_sources": {}
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/vendors/merge/"

payload = {
    "target_vendor_id": 123,
    "source_vendor_ids": [123],
    "field_sources": {},
    "custom_field_sources": {}
}
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({
    target_vendor_id: 123,
    source_vendor_ids: [123],
    field_sources: {},
    custom_field_sources: {}
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/vendors/merge/', 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/vendors/merge/",
  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([
    'target_vendor_id' => 123,
    'source_vendor_ids' => [
        123
    ],
    'field_sources' => [
        
    ],
    'custom_field_sources' => [
        
    ]
  ]),
  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/vendors/merge/"

	payload := strings.NewReader("{\n  \"target_vendor_id\": 123,\n  \"source_vendor_ids\": [\n    123\n  ],\n  \"field_sources\": {},\n  \"custom_field_sources\": {}\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/v3-alpha/vendors/merge/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_vendor_id\": 123,\n  \"source_vendor_ids\": [\n    123\n  ],\n  \"field_sources\": {},\n  \"custom_field_sources\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/vendors/merge/")

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  \"target_vendor_id\": 123,\n  \"source_vendor_ids\": [\n    123\n  ],\n  \"field_sources\": {},\n  \"custom_field_sources\": {}\n}"

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

{
  "target_vendor_id": 123,
  "merged_vendor_ids": [
    123
  ],
  "moved_counts": {},
  "applied_field_sources": {},
  "applied_custom_field_sources": {},
  "reset_tax_1099_run_ids": [
    123
  ],
  "success": true
}

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

Vendors

Merge vendors

Merge the duplicate vendors in source_vendor_ids into the vendor in target_vendor_id. field_sources and custom_field_sources select the vendor whose value the survivor keeps for each field. A field that they do not name keeps the survivor value. When the survivor value is empty, the field gets the first duplicate value. Bank and payment details always stay on the survivor. You cannot undo a merge.

Side effects

DualEntry moves all records, attachments and company access of the duplicate vendors to the survivor vendor.
DualEntry archives the duplicate vendors and sets their merged_into_id to the survivor vendor.
When the survivor takes the name of a duplicate vendor, DualEntry adds (merged into <survivor code>) to the name of that duplicate.
DualEntry sets each changed open 1099 run back to draft. Compute these runs again.
DualEntry sends one core.vendor/merged webhook event for each duplicate vendor.

Additional validations

Fails with 422 if a vendor is an intercompany vendor, if the vendors have different tax IDs, tax registrations or subsidiaries, or if a 1099 run for these vendors is in progress.
Fails with 422 if the merge must move or read more than 20,000 rows, if the API key cannot access a company where the duplicate vendors have records, if the merge gives the survivor access to companies that the API key cannot access, or if the selected company_access does not include a company where the vendors have records.
Fails with 422 if field_sources or custom_field_sources selects a vendor that is not part of the merge, or an unknown custom field.
Fails with 409 if another merge uses one of the vendors.
Fails with 417 and changes no data if the merge does not finish in 25 seconds.

POST

public

v3-alpha

vendors

merge

Merge vendors

curl --request POST \
  --url https://api.dualentry.com/public/v3-alpha/vendors/merge/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "target_vendor_id": 123,
  "source_vendor_ids": [
    123
  ],
  "field_sources": {},
  "custom_field_sources": {}
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/vendors/merge/"

payload = {
    "target_vendor_id": 123,
    "source_vendor_ids": [123],
    "field_sources": {},
    "custom_field_sources": {}
}
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({
    target_vendor_id: 123,
    source_vendor_ids: [123],
    field_sources: {},
    custom_field_sources: {}
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/vendors/merge/', 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/vendors/merge/",
  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([
    'target_vendor_id' => 123,
    'source_vendor_ids' => [
        123
    ],
    'field_sources' => [
        
    ],
    'custom_field_sources' => [
        
    ]
  ]),
  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/vendors/merge/"

	payload := strings.NewReader("{\n  \"target_vendor_id\": 123,\n  \"source_vendor_ids\": [\n    123\n  ],\n  \"field_sources\": {},\n  \"custom_field_sources\": {}\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/v3-alpha/vendors/merge/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_vendor_id\": 123,\n  \"source_vendor_ids\": [\n    123\n  ],\n  \"field_sources\": {},\n  \"custom_field_sources\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/vendors/merge/")

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  \"target_vendor_id\": 123,\n  \"source_vendor_ids\": [\n    123\n  ],\n  \"field_sources\": {},\n  \"custom_field_sources\": {}\n}"

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

{
  "target_vendor_id": 123,
  "merged_vendor_ids": [
    123
  ],
  "moved_counts": {},
  "applied_field_sources": {},
  "applied_custom_field_sources": {},
  "reset_tax_1099_run_ids": [
    123
  ],
  "success": true
}

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

Body

application/json

target_vendor_id

integer

required

ID of the survivor vendor. Its ID, code and records stay.

source_vendor_ids

integer[]

required

IDs of the duplicate vendors. The merge moves their records to the survivor and archives them.

Required array length: 1 - 25 elements

field_sources

Field Sources · object

For each field, the ID of the vendor whose value the survivor keeps. A field that is not in this object keeps its default.

Show child attributes

custom_field_sources

Custom Field Sources · object

For each custom field ID, the ID of the vendor whose value the survivor keeps.

Show child attributes

Response

target_vendor_id

integer

required

merged_vendor_ids

integer[]

required

moved_counts

Moved Counts · object

required

Show child attributes

applied_field_sources

Applied Field Sources · object

required

Show child attributes

applied_custom_field_sources

Applied Custom Field Sources · object

required

Show child attributes

reset_tax_1099_run_ids

integer[]

required

success

boolean

default:true

Overview

V3 (alpha)

Merge vendors

Authorizations

Headers

Body

Response