Update customer (partial)

curl --request PATCH \
  --url https://api.dualentry.com/public/v3-alpha/customers/{customer_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "gst_registration_numbers": [
    {
      "registration_number": "<string>",
      "region": "<string>"
    }
  ],
  "vat_registration_numbers": [
    {
      "country": "<string>",
      "registration_number": "<string>"
    }
  ],
  "custom_fields": [
    {}
  ],
  "business_id": "",
  "date_format_custom": "<string>",
  "name": "<string>",
  "unique_id": "<string>",
  "email": "<string>",
  "address": "<string>",
  "country": "<string>",
  "phone": "<string>",
  "website": "<string>",
  "full_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "is_active": true,
  "is_taxable": true,
  "allowed_company_ids": [
    123
  ],
  "default_ar_account_id": 123,
  "term_id": 123,
  "parent_id": 123,
  "tax_exemption_reason_code": "<string>",
  "tax_exemption_reason_code_origin": "AVALARA",
  "tin": "<string>",
  "tin_type": "",
  "default_billable_markup_pct": 123,
  "default_billable_expense_item_id": 123,
  "attachments": [
    {
      "id": 123,
      "file_name": "<string>",
      "file_size": 123,
      "download_url": "<string>",
      "upload_url": "<string>",
      "category": "default"
    }
  ],
  "classification_line_ids": [
    123
  ]
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/customers/{customer_id}/"

payload = {
    "gst_registration_numbers": [
        {
            "registration_number": "<string>",
            "region": "<string>"
        }
    ],
    "vat_registration_numbers": [
        {
            "country": "<string>",
            "registration_number": "<string>"
        }
    ],
    "custom_fields": [{}],
    "business_id": "",
    "date_format_custom": "<string>",
    "name": "<string>",
    "unique_id": "<string>",
    "email": "<string>",
    "address": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "full_address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "shipping_address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "is_active": True,
    "is_taxable": True,
    "allowed_company_ids": [123],
    "default_ar_account_id": 123,
    "term_id": 123,
    "parent_id": 123,
    "tax_exemption_reason_code": "<string>",
    "tax_exemption_reason_code_origin": "AVALARA",
    "tin": "<string>",
    "tin_type": "",
    "default_billable_markup_pct": 123,
    "default_billable_expense_item_id": 123,
    "attachments": [
        {
            "id": 123,
            "file_name": "<string>",
            "file_size": 123,
            "download_url": "<string>",
            "upload_url": "<string>",
            "category": "default"
        }
    ],
    "classification_line_ids": [123]
}
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({
    gst_registration_numbers: [{registration_number: '<string>', region: '<string>'}],
    vat_registration_numbers: [{country: '<string>', registration_number: '<string>'}],
    custom_fields: [{}],
    business_id: '',
    date_format_custom: '<string>',
    name: '<string>',
    unique_id: '<string>',
    email: '<string>',
    address: '<string>',
    country: '<string>',
    phone: '<string>',
    website: '<string>',
    full_address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    shipping_address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    is_active: true,
    is_taxable: true,
    allowed_company_ids: [123],
    default_ar_account_id: 123,
    term_id: 123,
    parent_id: 123,
    tax_exemption_reason_code: '<string>',
    tax_exemption_reason_code_origin: 'AVALARA',
    tin: '<string>',
    tin_type: '',
    default_billable_markup_pct: 123,
    default_billable_expense_item_id: 123,
    attachments: [
      {
        id: 123,
        file_name: '<string>',
        file_size: 123,
        download_url: '<string>',
        upload_url: '<string>',
        category: 'default'
      }
    ],
    classification_line_ids: [123]
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/customers/{customer_id}/', 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/customers/{customer_id}/",
  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([
    'gst_registration_numbers' => [
        [
                'registration_number' => '<string>',
                'region' => '<string>'
        ]
    ],
    'vat_registration_numbers' => [
        [
                'country' => '<string>',
                'registration_number' => '<string>'
        ]
    ],
    'custom_fields' => [
        [
                
        ]
    ],
    'business_id' => '',
    'date_format_custom' => '<string>',
    'name' => '<string>',
    'unique_id' => '<string>',
    'email' => '<string>',
    'address' => '<string>',
    'country' => '<string>',
    'phone' => '<string>',
    'website' => '<string>',
    'full_address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'shipping_address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'is_active' => true,
    'is_taxable' => true,
    'allowed_company_ids' => [
        123
    ],
    'default_ar_account_id' => 123,
    'term_id' => 123,
    'parent_id' => 123,
    'tax_exemption_reason_code' => '<string>',
    'tax_exemption_reason_code_origin' => 'AVALARA',
    'tin' => '<string>',
    'tin_type' => '',
    'default_billable_markup_pct' => 123,
    'default_billable_expense_item_id' => 123,
    'attachments' => [
        [
                'id' => 123,
                'file_name' => '<string>',
                'file_size' => 123,
                'download_url' => '<string>',
                'upload_url' => '<string>',
                'category' => 'default'
        ]
    ],
    'classification_line_ids' => [
        123
    ]
  ]),
  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/customers/{customer_id}/"

	payload := strings.NewReader("{\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"business_id\": \"\",\n  \"date_format_custom\": \"<string>\",\n  \"name\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"email\": \"<string>\",\n  \"address\": \"<string>\",\n  \"country\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"full_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"is_active\": true,\n  \"is_taxable\": true,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"default_ar_account_id\": 123,\n  \"term_id\": 123,\n  \"parent_id\": 123,\n  \"tax_exemption_reason_code\": \"<string>\",\n  \"tax_exemption_reason_code_origin\": \"AVALARA\",\n  \"tin\": \"<string>\",\n  \"tin_type\": \"\",\n  \"default_billable_markup_pct\": 123,\n  \"default_billable_expense_item_id\": 123,\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  \"classification_line_ids\": [\n    123\n  ]\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/customers/{customer_id}/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"business_id\": \"\",\n  \"date_format_custom\": \"<string>\",\n  \"name\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"email\": \"<string>\",\n  \"address\": \"<string>\",\n  \"country\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"full_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"is_active\": true,\n  \"is_taxable\": true,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"default_ar_account_id\": 123,\n  \"term_id\": 123,\n  \"parent_id\": 123,\n  \"tax_exemption_reason_code\": \"<string>\",\n  \"tax_exemption_reason_code_origin\": \"AVALARA\",\n  \"tin\": \"<string>\",\n  \"tin_type\": \"\",\n  \"default_billable_markup_pct\": 123,\n  \"default_billable_expense_item_id\": 123,\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  \"classification_line_ids\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/customers/{customer_id}/")

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  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"business_id\": \"\",\n  \"date_format_custom\": \"<string>\",\n  \"name\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"email\": \"<string>\",\n  \"address\": \"<string>\",\n  \"country\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"full_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"is_active\": true,\n  \"is_taxable\": true,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"default_ar_account_id\": 123,\n  \"term_id\": 123,\n  \"parent_id\": 123,\n  \"tax_exemption_reason_code\": \"<string>\",\n  \"tax_exemption_reason_code_origin\": \"AVALARA\",\n  \"tin\": \"<string>\",\n  \"tin_type\": \"\",\n  \"default_billable_markup_pct\": 123,\n  \"default_billable_expense_item_id\": 123,\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  \"classification_line_ids\": [\n    123\n  ]\n}"

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

{
  "term_id": 123,
  "term_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": 123,
  "address": "<string>",
  "country": "<string>",
  "name": "<string>",
  "unique_id": "<string>",
  "website": "<string>",
  "email": "<string>",
  "customer_type": "<string>",
  "is_active": true,
  "phone": "<string>",
  "record_status": "<string>",
  "is_taxable": true,
  "default_tax_code": "<string>",
  "tax_registration_number": "<string>",
  "default_currency": "AED",
  "full_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "attachments": [],
  "gst_registration_numbers": [
    {
      "id": 123,
      "country": "AU",
      "region": "<string>",
      "registration_type": "GST",
      "registration_number": "<string>"
    }
  ],
  "vat_registration_numbers": [
    {
      "id": 123,
      "country": "<string>",
      "registration_number": "<string>"
    }
  ],
  "classification_line_ids": [],
  "custom_fields": [],
  "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"
  },
  "approval_status": "<string>",
  "next_approvers": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "full_name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "rejected_by": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "rejection_reason": "<string>"
  },
  "date_style": "short",
  "date_format_custom": "<string>",
  "code": "<string>",
  "tin": "",
  "tin_type": "",
  "business_id": "",
  "default_ar_account_id": 123,
  "parent_id": 123,
  "tax_exemption_reason_code": "<string>",
  "tax_exemption_reason_code_origin": "AVALARA",
  "default_billable_markup_pct": "<string>",
  "default_billable_consolidation": "by_line",
  "default_billable_expense_item_id": 123,
  "company_id": 123,
  "company_name": "<string>",
  "allowed_company_ids": [],
  "merged_into_id": 123,
  "classifications": []
}

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

Customers

Update customer (partial)

Update specific fields on a customer. Send only the fields you want to change. Anything you don’t send stays as it is. To clear a nullable field, send null.

Set is_taxable to false to mark the customer as tax-exempt, or true to make them taxable. Omit the field to leave the current value unchanged.

To rename a customer, send:

{"name": "Acme Holdings, Inc."}

To update phone and website together, send:

{"phone": "555-0199", "website": "https://acme.example"}

Custom fields

Set custom fields by name:

{"custom_fields": [{"Partner": true}, {"Tier": "Gold"}]}

Each item is a one-key object where the key is the custom field’s name and the value is whatever you want to set. Use null to clear a field. If the name doesn’t match a custom field in your organization, the API returns a 422 instead of silently ignoring it. If you happen to have two custom fields with the same name, use the id-based shape:

{"custom_fields": [{"field": {"id": 42}, "value": {"custom_field_id": 42, "value": "Acme"}}]}

Omitting custom_fields from the request leaves existing values untouched.

Side effects

When you send attachments on an update, DualEntry replaces the stored attachment set with the list you send.
If an approval workflow matches this request, DualEntry can set record_status back to draft.

Additional validations

Fails with 422 when you set allowed_company_ids on a child customer, or when you create a child customer with its own company access.
Fails with 422 when you set a default AR account on an intercompany customer.
Fails with 422 when the default AR account is not an accounts receivable account in your organization.
Fails with 422 when parent_id would create a circular parent relationship.
Fails with 422 when you create a customer with customer_type intercompany, or when you change customer_type to or from intercompany.
Fails with 422 when you change customer_type from company while the customer has VAT or GST registrations. To clear them, send vat_registration_numbers and gst_registration_numbers as empty lists in the same request.
Fails with 422 when the request archives the customer while a recurring template that is not archived uses it.

PATCH

public

v3-alpha

customers

{customer_id}

Update customer (partial)

curl --request PATCH \
  --url https://api.dualentry.com/public/v3-alpha/customers/{customer_id}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "gst_registration_numbers": [
    {
      "registration_number": "<string>",
      "region": "<string>"
    }
  ],
  "vat_registration_numbers": [
    {
      "country": "<string>",
      "registration_number": "<string>"
    }
  ],
  "custom_fields": [
    {}
  ],
  "business_id": "",
  "date_format_custom": "<string>",
  "name": "<string>",
  "unique_id": "<string>",
  "email": "<string>",
  "address": "<string>",
  "country": "<string>",
  "phone": "<string>",
  "website": "<string>",
  "full_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "is_active": true,
  "is_taxable": true,
  "allowed_company_ids": [
    123
  ],
  "default_ar_account_id": 123,
  "term_id": 123,
  "parent_id": 123,
  "tax_exemption_reason_code": "<string>",
  "tax_exemption_reason_code_origin": "AVALARA",
  "tin": "<string>",
  "tin_type": "",
  "default_billable_markup_pct": 123,
  "default_billable_expense_item_id": 123,
  "attachments": [
    {
      "id": 123,
      "file_name": "<string>",
      "file_size": 123,
      "download_url": "<string>",
      "upload_url": "<string>",
      "category": "default"
    }
  ],
  "classification_line_ids": [
    123
  ]
}
'

import requests

url = "https://api.dualentry.com/public/v3-alpha/customers/{customer_id}/"

payload = {
    "gst_registration_numbers": [
        {
            "registration_number": "<string>",
            "region": "<string>"
        }
    ],
    "vat_registration_numbers": [
        {
            "country": "<string>",
            "registration_number": "<string>"
        }
    ],
    "custom_fields": [{}],
    "business_id": "",
    "date_format_custom": "<string>",
    "name": "<string>",
    "unique_id": "<string>",
    "email": "<string>",
    "address": "<string>",
    "country": "<string>",
    "phone": "<string>",
    "website": "<string>",
    "full_address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "shipping_address": {
        "street": "<string>",
        "city": "<string>",
        "postal_code": "<string>",
        "state": "",
        "country": "",
        "second_line": "",
        "name": "<string>"
    },
    "is_active": True,
    "is_taxable": True,
    "allowed_company_ids": [123],
    "default_ar_account_id": 123,
    "term_id": 123,
    "parent_id": 123,
    "tax_exemption_reason_code": "<string>",
    "tax_exemption_reason_code_origin": "AVALARA",
    "tin": "<string>",
    "tin_type": "",
    "default_billable_markup_pct": 123,
    "default_billable_expense_item_id": 123,
    "attachments": [
        {
            "id": 123,
            "file_name": "<string>",
            "file_size": 123,
            "download_url": "<string>",
            "upload_url": "<string>",
            "category": "default"
        }
    ],
    "classification_line_ids": [123]
}
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({
    gst_registration_numbers: [{registration_number: '<string>', region: '<string>'}],
    vat_registration_numbers: [{country: '<string>', registration_number: '<string>'}],
    custom_fields: [{}],
    business_id: '',
    date_format_custom: '<string>',
    name: '<string>',
    unique_id: '<string>',
    email: '<string>',
    address: '<string>',
    country: '<string>',
    phone: '<string>',
    website: '<string>',
    full_address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    shipping_address: {
      street: '<string>',
      city: '<string>',
      postal_code: '<string>',
      state: '',
      country: '',
      second_line: '',
      name: '<string>'
    },
    is_active: true,
    is_taxable: true,
    allowed_company_ids: [123],
    default_ar_account_id: 123,
    term_id: 123,
    parent_id: 123,
    tax_exemption_reason_code: '<string>',
    tax_exemption_reason_code_origin: 'AVALARA',
    tin: '<string>',
    tin_type: '',
    default_billable_markup_pct: 123,
    default_billable_expense_item_id: 123,
    attachments: [
      {
        id: 123,
        file_name: '<string>',
        file_size: 123,
        download_url: '<string>',
        upload_url: '<string>',
        category: 'default'
      }
    ],
    classification_line_ids: [123]
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/customers/{customer_id}/', 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/customers/{customer_id}/",
  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([
    'gst_registration_numbers' => [
        [
                'registration_number' => '<string>',
                'region' => '<string>'
        ]
    ],
    'vat_registration_numbers' => [
        [
                'country' => '<string>',
                'registration_number' => '<string>'
        ]
    ],
    'custom_fields' => [
        [
                
        ]
    ],
    'business_id' => '',
    'date_format_custom' => '<string>',
    'name' => '<string>',
    'unique_id' => '<string>',
    'email' => '<string>',
    'address' => '<string>',
    'country' => '<string>',
    'phone' => '<string>',
    'website' => '<string>',
    'full_address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'shipping_address' => [
        'street' => '<string>',
        'city' => '<string>',
        'postal_code' => '<string>',
        'state' => '',
        'country' => '',
        'second_line' => '',
        'name' => '<string>'
    ],
    'is_active' => true,
    'is_taxable' => true,
    'allowed_company_ids' => [
        123
    ],
    'default_ar_account_id' => 123,
    'term_id' => 123,
    'parent_id' => 123,
    'tax_exemption_reason_code' => '<string>',
    'tax_exemption_reason_code_origin' => 'AVALARA',
    'tin' => '<string>',
    'tin_type' => '',
    'default_billable_markup_pct' => 123,
    'default_billable_expense_item_id' => 123,
    'attachments' => [
        [
                'id' => 123,
                'file_name' => '<string>',
                'file_size' => 123,
                'download_url' => '<string>',
                'upload_url' => '<string>',
                'category' => 'default'
        ]
    ],
    'classification_line_ids' => [
        123
    ]
  ]),
  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/customers/{customer_id}/"

	payload := strings.NewReader("{\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"business_id\": \"\",\n  \"date_format_custom\": \"<string>\",\n  \"name\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"email\": \"<string>\",\n  \"address\": \"<string>\",\n  \"country\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"full_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"is_active\": true,\n  \"is_taxable\": true,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"default_ar_account_id\": 123,\n  \"term_id\": 123,\n  \"parent_id\": 123,\n  \"tax_exemption_reason_code\": \"<string>\",\n  \"tax_exemption_reason_code_origin\": \"AVALARA\",\n  \"tin\": \"<string>\",\n  \"tin_type\": \"\",\n  \"default_billable_markup_pct\": 123,\n  \"default_billable_expense_item_id\": 123,\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  \"classification_line_ids\": [\n    123\n  ]\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/customers/{customer_id}/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"business_id\": \"\",\n  \"date_format_custom\": \"<string>\",\n  \"name\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"email\": \"<string>\",\n  \"address\": \"<string>\",\n  \"country\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"full_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"is_active\": true,\n  \"is_taxable\": true,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"default_ar_account_id\": 123,\n  \"term_id\": 123,\n  \"parent_id\": 123,\n  \"tax_exemption_reason_code\": \"<string>\",\n  \"tax_exemption_reason_code_origin\": \"AVALARA\",\n  \"tin\": \"<string>\",\n  \"tin_type\": \"\",\n  \"default_billable_markup_pct\": 123,\n  \"default_billable_expense_item_id\": 123,\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  \"classification_line_ids\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.dualentry.com/public/v3-alpha/customers/{customer_id}/")

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  \"gst_registration_numbers\": [\n    {\n      \"registration_number\": \"<string>\",\n      \"region\": \"<string>\"\n    }\n  ],\n  \"vat_registration_numbers\": [\n    {\n      \"country\": \"<string>\",\n      \"registration_number\": \"<string>\"\n    }\n  ],\n  \"custom_fields\": [\n    {}\n  ],\n  \"business_id\": \"\",\n  \"date_format_custom\": \"<string>\",\n  \"name\": \"<string>\",\n  \"unique_id\": \"<string>\",\n  \"email\": \"<string>\",\n  \"address\": \"<string>\",\n  \"country\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"website\": \"<string>\",\n  \"full_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"shipping_address\": {\n    \"street\": \"<string>\",\n    \"city\": \"<string>\",\n    \"postal_code\": \"<string>\",\n    \"state\": \"\",\n    \"country\": \"\",\n    \"second_line\": \"\",\n    \"name\": \"<string>\"\n  },\n  \"is_active\": true,\n  \"is_taxable\": true,\n  \"allowed_company_ids\": [\n    123\n  ],\n  \"default_ar_account_id\": 123,\n  \"term_id\": 123,\n  \"parent_id\": 123,\n  \"tax_exemption_reason_code\": \"<string>\",\n  \"tax_exemption_reason_code_origin\": \"AVALARA\",\n  \"tin\": \"<string>\",\n  \"tin_type\": \"\",\n  \"default_billable_markup_pct\": 123,\n  \"default_billable_expense_item_id\": 123,\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  \"classification_line_ids\": [\n    123\n  ]\n}"

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

{
  "term_id": 123,
  "term_name": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "id": 123,
  "address": "<string>",
  "country": "<string>",
  "name": "<string>",
  "unique_id": "<string>",
  "website": "<string>",
  "email": "<string>",
  "customer_type": "<string>",
  "is_active": true,
  "phone": "<string>",
  "record_status": "<string>",
  "is_taxable": true,
  "default_tax_code": "<string>",
  "tax_registration_number": "<string>",
  "default_currency": "AED",
  "full_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "shipping_address": {
    "street": "<string>",
    "city": "<string>",
    "postal_code": "<string>",
    "state": "",
    "country": "",
    "second_line": "",
    "name": "<string>"
  },
  "attachments": [],
  "gst_registration_numbers": [
    {
      "id": 123,
      "country": "AU",
      "region": "<string>",
      "registration_type": "GST",
      "registration_number": "<string>"
    }
  ],
  "vat_registration_numbers": [
    {
      "id": 123,
      "country": "<string>",
      "registration_number": "<string>"
    }
  ],
  "classification_line_ids": [],
  "custom_fields": [],
  "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"
  },
  "approval_status": "<string>",
  "next_approvers": [
    {
      "id": 123,
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "full_name": "<string>",
      "avatar_url": "<string>"
    }
  ],
  "rejected_by": {
    "id": 123,
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "full_name": "<string>",
    "rejection_reason": "<string>"
  },
  "date_style": "short",
  "date_format_custom": "<string>",
  "code": "<string>",
  "tin": "",
  "tin_type": "",
  "business_id": "",
  "default_ar_account_id": 123,
  "parent_id": 123,
  "tax_exemption_reason_code": "<string>",
  "tax_exemption_reason_code_origin": "AVALARA",
  "default_billable_markup_pct": "<string>",
  "default_billable_consolidation": "by_line",
  "default_billable_expense_item_id": 123,
  "company_id": 123,
  "company_name": "<string>",
  "allowed_company_ids": [],
  "merged_into_id": 123,
  "classifications": []
}

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

customer_id

integer

required

Body

application/json

Partial update payload for PATCH /public/customers/{id}/.

Every field is optional: send only the fields you want to change. Unset fields are left untouched on the existing record.

gst_registration_numbers

GstRegistrationItemSchema · object[] | null

Show child attributes

vat_registration_numbers

VatRegistrationItemSchema · object[] | null

Show child attributes

custom_fields

Custom Fields · object[] | null

business_id

string

default:""

Business identifier. Spaces at the ends are removed. An empty value clears the stored identifier.

Maximum string length: 100

date_style

enum<string> | null

Date display style: short, medium, long, or custom. Null means the organization default applies.

Available options:

short,

medium,

long,

custom

date_format_custom

string | null

Day.js / Moment-style date pattern (max 16 chars). Tokens: YYYY, YY, MMMM, MMM, MM, M, DD, D. Separators: / . - , and space. Examples: DD.MM.YYYY, MM/DD/YYYY, YYYY-MM-DD. Not ICU or raw Intl.

Maximum string length: 16

name

string | null

unique_id

string | null

Required string length: 1 - 64

string | null

address

string | null

country

string | null

phone

string | null

Maximum string length: 64

Pattern: (?i)^(?:[0-9\s+\-.]*|[0-9\s+\-.]+(?:\s*(?:x|ext\.?|extension)\s*\d+))$

website

string | null

full_address

AddressSchemaIn · object | null

Show child attributes

shipping_address

AddressSchemaIn · object | null

Show child attributes

is_active

boolean | null

record_status

enum<string> | null

Available options:

draft,

posted,

archived

is_taxable

boolean | null

Whether tax is calculated for this customer. Set to false to mark the customer as tax-exempt.

allowed_company_ids

integer[] | null

Company IDs allowed to use this customer. Empty list means global (all companies). Omit or send null to leave unchanged.

default_ar_account_id

integer | null

default_currency

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

term_id

integer | null

parent_id

integer | null

customer_type

enum<string> | null

Available options:

individual,

company,

intercompany

tax_exemption_reason_code

string | null

tax_exemption_reason_code_origin

enum<string> | null

Available options:

AVALARA

tin

string | null

Tax identification number. Set it together with tin_type. Format by type: ein 12-3456789, ssn 123-45-6789, rfc 3 or 4 uppercase letters, a YYMMDD date, 2 uppercase letters or digits, then a digit or A, for example ABC010203XY9. On an update, send an empty string or null to clear it.

Maximum string length: 13

tin_type

Type of tax identification number: ein, ssn, utr, or rfc (Mexico). Set it together with tin. On an update, send an empty string or null to clear it.

Allowed value: ""

default_billable_markup_pct

default_billable_consolidation

enum<string> | null

Available options:

by_line,

consolidated

default_billable_expense_item_id

integer | null

attachments

AttachmentSchemaOut · object[] | null

Show child attributes

classification_line_ids

integer[] | null

Classification lines stored on this record.

Response

term_id

integer | null

required

term_name

string

required

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

integer

required

address

string

required

country

string

required

name

string

required

unique_id

string | null

required

website

string

required

string

required

customer_type

string

required

is_active

boolean

required

phone

string

required

record_status

string

required

is_taxable

boolean

required

default_tax_code

string

required

tax_registration_number

string

required

default_currency

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

full_address

AddressSchemaIn · object | null

required

Show child attributes

shipping_address

AddressSchemaIn · object | null

required

Show child attributes

attachments

PublicAttachmentSchemaOut · object[]

Show child attributes

gst_registration_numbers

GstRegistrationItemSchemaOut · object[]

Show child attributes

vat_registration_numbers

VatRegistrationItemSchemaOut · object[]

Show child attributes

classification_line_ids

integer[]

custom_fields

CustomFieldValuePairOutputSchema · 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

approval_status

string | null

next_approvers

ApproverDictSchema · object[] | null

Show child attributes

rejected_by

RejectedBySchema · object | null

Schema for rejector information including rejection reason.

Show child attributes

date_style

enum<string> | null

Date display style: short, medium, long, or custom. Null means the organization default applies.

Available options:

short,

medium,

long,

custom

date_format_custom

string | null

Day.js / Moment-style date pattern (max 16 chars). Tokens: YYYY, YY, MMMM, MMM, MM, M, DD, D. Separators: / . - , and space. Examples: DD.MM.YYYY, MM/DD/YYYY, YYYY-MM-DD. Not ICU or raw Intl.

Maximum string length: 16

code

string | null

tin

string

default:""

Tax identification number. The value is an empty string when the number is not set.

tin_type

string

default:""

Type of tax identification number: ein, ssn, utr, or rfc (Mexico). The value is an empty string when the type is not set.

business_id

string

default:""

default_ar_account_id

integer | null

parent_id

integer | null

tax_exemption_reason_code

string | null

tax_exemption_reason_code_origin

enum<string> | null

Available options:

AVALARA

default_billable_markup_pct

string | null

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

default_billable_consolidation

enum<string> | null

Available options:

by_line,

consolidated

default_billable_expense_item_id

integer | null

company_id

integer | null

company_name

string | null

allowed_company_ids

integer[]

merged_into_id

integer | null

When you merge this customer into another customer, the ID of that customer.

classifications

RecordClassificationsSchemaOut · object[]

Show child attributes

Overview

Organization

Accounting Setup

Transactions

Money In

Money Out

Financial & Banking

Assets

Tax

Financial Planning

Reporting

Governance

Developers

Monitoring

OAuth

Update customer (partial)

Authorizations

Headers

Path Parameters

Body

Response