Update SalesOrderV2 record

curl --request PUT \
  --url https://api.dualentry.com/public/v3-alpha/sales-orders/{record_number}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "memo": "<string>",
  "date": "2023-12-25",
  "company_id": 123,
  "customer_id": 123,
  "exchange_rate": 123,
  "items": [
    {
      "item_id": 123,
      "quantity": 123,
      "rate": 123,
      "position": 123,
      "memo": "<string>",
      "tax": {
        "code": "<string>",
        "rate": 123,
        "amount": 123,
        "is_taxable": true,
        "tax_exempt_amount": 123,
        "vat_rate_id": 123,
        "gst_tax_rate_id": 123,
        "tax_metadata": {}
      },
      "custom_fields": [
        {}
      ],
      "id": 123,
      "classifications": []
    }
  ],
  "supply_date": "2023-12-25",
  "place_of_supply": "<string>",
  "tax_registration_numbers": {
    "company": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ],
    "counterparty": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ]
  },
  "tax_metadata": {},
  "bill_to_address": "",
  "ship_to_address": "",
  "billing_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>"
  },
  "custom_fields": [
    {}
  ],
  "auto_calculate_tax": "required",
  "record_status": "posted",
  "attachments": [],
  "term_id": 123,
  "reference_number": ""
}
'

import requests

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

payload = {
    "memo": "<string>",
    "date": "2023-12-25",
    "company_id": 123,
    "customer_id": 123,
    "exchange_rate": 123,
    "items": [
        {
            "item_id": 123,
            "quantity": 123,
            "rate": 123,
            "position": 123,
            "memo": "<string>",
            "tax": {
                "code": "<string>",
                "rate": 123,
                "amount": 123,
                "is_taxable": True,
                "tax_exempt_amount": 123,
                "vat_rate_id": 123,
                "gst_tax_rate_id": 123,
                "tax_metadata": {}
            },
            "custom_fields": [{}],
            "id": 123,
            "classifications": []
        }
    ],
    "supply_date": "2023-12-25",
    "place_of_supply": "<string>",
    "tax_registration_numbers": {
        "company": [
            {
                "type": "<string>",
                "number": "<string>",
                "region": "<string>"
            }
        ],
        "counterparty": [
            {
                "type": "<string>",
                "number": "<string>",
                "region": "<string>"
            }
        ]
    },
    "tax_metadata": {},
    "bill_to_address": "",
    "ship_to_address": "",
    "billing_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>"
    },
    "custom_fields": [{}],
    "auto_calculate_tax": "required",
    "record_status": "posted",
    "attachments": [],
    "term_id": 123,
    "reference_number": ""
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    memo: '<string>',
    date: '2023-12-25',
    company_id: 123,
    customer_id: 123,
    exchange_rate: 123,
    items: [
      {
        item_id: 123,
        quantity: 123,
        rate: 123,
        position: 123,
        memo: '<string>',
        tax: {
          code: '<string>',
          rate: 123,
          amount: 123,
          is_taxable: true,
          tax_exempt_amount: 123,
          vat_rate_id: 123,
          gst_tax_rate_id: 123,
          tax_metadata: {}
        },
        custom_fields: [{}],
        id: 123,
        classifications: []
      }
    ],
    supply_date: '2023-12-25',
    place_of_supply: '<string>',
    tax_registration_numbers: {
      company: [{type: '<string>', number: '<string>', region: '<string>'}],
      counterparty: [{type: '<string>', number: '<string>', region: '<string>'}]
    },
    tax_metadata: {},
    bill_to_address: '',
    ship_to_address: '',
    billing_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>'
    },
    custom_fields: [{}],
    auto_calculate_tax: 'required',
    record_status: 'posted',
    attachments: [],
    term_id: 123,
    reference_number: ''
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/sales-orders/{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/sales-orders/{record_number}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'memo' => '<string>',
    'date' => '2023-12-25',
    'company_id' => 123,
    'customer_id' => 123,
    'exchange_rate' => 123,
    'items' => [
        [
                'item_id' => 123,
                'quantity' => 123,
                'rate' => 123,
                'position' => 123,
                'memo' => '<string>',
                'tax' => [
                                'code' => '<string>',
                                'rate' => 123,
                                'amount' => 123,
                                'is_taxable' => true,
                                'tax_exempt_amount' => 123,
                                'vat_rate_id' => 123,
                                'gst_tax_rate_id' => 123,
                                'tax_metadata' => [
                                                                
                                ]
                ],
                'custom_fields' => [
                                [
                                                                
                                ]
                ],
                'id' => 123,
                'classifications' => [
                                
                ]
        ]
    ],
    'supply_date' => '2023-12-25',
    'place_of_supply' => '<string>',
    'tax_registration_numbers' => [
        'company' => [
                [
                                'type' => '<string>',
                                'number' => '<string>',
                                'region' => '<string>'
                ]
        ],
        'counterparty' => [
                [
                                'type' => '<string>',
                                'number' => '<string>',
                                'region' => '<string>'
                ]
        ]
    ],
    'tax_metadata' => [
        
    ],
    'bill_to_address' => '',
    'ship_to_address' => '',
    'billing_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>'
    ],
    'custom_fields' => [
        [
                
        ]
    ],
    'auto_calculate_tax' => 'required',
    'record_status' => 'posted',
    'attachments' => [
        
    ],
    'term_id' => 123,
    'reference_number' => ''
  ]),
  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/sales-orders/{record_number}/"

	payload := strings.NewReader("{\n  \"memo\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"customer_id\": 123,\n  \"exchange_rate\": 123,\n  \"items\": [\n    {\n      \"item_id\": 123,\n      \"quantity\": 123,\n      \"rate\": 123,\n      \"position\": 123,\n      \"memo\": \"<string>\",\n      \"tax\": {\n        \"code\": \"<string>\",\n        \"rate\": 123,\n        \"amount\": 123,\n        \"is_taxable\": true,\n        \"tax_exempt_amount\": 123,\n        \"vat_rate_id\": 123,\n        \"gst_tax_rate_id\": 123,\n        \"tax_metadata\": {}\n      },\n      \"custom_fields\": [\n        {}\n      ],\n      \"id\": 123,\n      \"classifications\": []\n    }\n  ],\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_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  \"custom_fields\": [\n    {}\n  ],\n  \"auto_calculate_tax\": \"required\",\n  \"record_status\": \"posted\",\n  \"attachments\": [],\n  \"term_id\": 123,\n  \"reference_number\": \"\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.dualentry.com/public/v3-alpha/sales-orders/{record_number}/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memo\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"customer_id\": 123,\n  \"exchange_rate\": 123,\n  \"items\": [\n    {\n      \"item_id\": 123,\n      \"quantity\": 123,\n      \"rate\": 123,\n      \"position\": 123,\n      \"memo\": \"<string>\",\n      \"tax\": {\n        \"code\": \"<string>\",\n        \"rate\": 123,\n        \"amount\": 123,\n        \"is_taxable\": true,\n        \"tax_exempt_amount\": 123,\n        \"vat_rate_id\": 123,\n        \"gst_tax_rate_id\": 123,\n        \"tax_metadata\": {}\n      },\n      \"custom_fields\": [\n        {}\n      ],\n      \"id\": 123,\n      \"classifications\": []\n    }\n  ],\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_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  \"custom_fields\": [\n    {}\n  ],\n  \"auto_calculate_tax\": \"required\",\n  \"record_status\": \"posted\",\n  \"attachments\": [],\n  \"term_id\": 123,\n  \"reference_number\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"memo\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"customer_id\": 123,\n  \"exchange_rate\": 123,\n  \"items\": [\n    {\n      \"item_id\": 123,\n      \"quantity\": 123,\n      \"rate\": 123,\n      \"position\": 123,\n      \"memo\": \"<string>\",\n      \"tax\": {\n        \"code\": \"<string>\",\n        \"rate\": 123,\n        \"amount\": 123,\n        \"is_taxable\": true,\n        \"tax_exempt_amount\": 123,\n        \"vat_rate_id\": 123,\n        \"gst_tax_rate_id\": 123,\n        \"tax_metadata\": {}\n      },\n      \"custom_fields\": [\n        {}\n      ],\n      \"id\": 123,\n      \"classifications\": []\n    }\n  ],\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_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  \"custom_fields\": [\n    {}\n  ],\n  \"auto_calculate_tax\": \"required\",\n  \"record_status\": \"posted\",\n  \"attachments\": [],\n  \"term_id\": 123,\n  \"reference_number\": \"\"\n}"

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

{
  "bill_to_address": "<string>",
  "ship_to_address": "<string>",
  "invoiced_status": "invoiced",
  "term_id": 123,
  "term_name": "<string>",
  "internal_id": 123,
  "number": 123,
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "customer_id": 123,
  "customer_name": "<string>",
  "currency_iso_4217_code": "AED",
  "exchange_rate": "<string>",
  "amount": "<string>",
  "invoiced_total": "<string>",
  "due_total": "<string>",
  "memo": "<string>",
  "date": "2023-12-25",
  "record_status": "draft",
  "reference_number": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "billing_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>"
  },
  "custom_fields": [],
  "attachments": [],
  "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>"
  },
  "code": "<string>",
  "items": [],
  "recurring_record_number": 123,
  "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>"
}

Sales Orders

Update SalesOrderV2 record

Update an existing SalesOrderV2 record with the provided data. Validates all required fields and business rules.

Side effects

If an approval workflow matches this request, DualEntry can set record_status back to draft.

Additional validations

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 and error_code tax_not_calculated when the organization uses manual tax mode with the tax reminder on, the request posts the record, and the request sends lines but none of them carries tax. Set auto_calculate_tax to required, or send tax on the lines.
Fails with 422 if you set an inactive, archived, or draft customer or vendor, or an inactive 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.

PUT

public

v3-alpha

sales-orders

{record_number}

Update SalesOrderV2 record

curl --request PUT \
  --url https://api.dualentry.com/public/v3-alpha/sales-orders/{record_number}/ \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "memo": "<string>",
  "date": "2023-12-25",
  "company_id": 123,
  "customer_id": 123,
  "exchange_rate": 123,
  "items": [
    {
      "item_id": 123,
      "quantity": 123,
      "rate": 123,
      "position": 123,
      "memo": "<string>",
      "tax": {
        "code": "<string>",
        "rate": 123,
        "amount": 123,
        "is_taxable": true,
        "tax_exempt_amount": 123,
        "vat_rate_id": 123,
        "gst_tax_rate_id": 123,
        "tax_metadata": {}
      },
      "custom_fields": [
        {}
      ],
      "id": 123,
      "classifications": []
    }
  ],
  "supply_date": "2023-12-25",
  "place_of_supply": "<string>",
  "tax_registration_numbers": {
    "company": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ],
    "counterparty": [
      {
        "type": "<string>",
        "number": "<string>",
        "region": "<string>"
      }
    ]
  },
  "tax_metadata": {},
  "bill_to_address": "",
  "ship_to_address": "",
  "billing_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>"
  },
  "custom_fields": [
    {}
  ],
  "auto_calculate_tax": "required",
  "record_status": "posted",
  "attachments": [],
  "term_id": 123,
  "reference_number": ""
}
'

import requests

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

payload = {
    "memo": "<string>",
    "date": "2023-12-25",
    "company_id": 123,
    "customer_id": 123,
    "exchange_rate": 123,
    "items": [
        {
            "item_id": 123,
            "quantity": 123,
            "rate": 123,
            "position": 123,
            "memo": "<string>",
            "tax": {
                "code": "<string>",
                "rate": 123,
                "amount": 123,
                "is_taxable": True,
                "tax_exempt_amount": 123,
                "vat_rate_id": 123,
                "gst_tax_rate_id": 123,
                "tax_metadata": {}
            },
            "custom_fields": [{}],
            "id": 123,
            "classifications": []
        }
    ],
    "supply_date": "2023-12-25",
    "place_of_supply": "<string>",
    "tax_registration_numbers": {
        "company": [
            {
                "type": "<string>",
                "number": "<string>",
                "region": "<string>"
            }
        ],
        "counterparty": [
            {
                "type": "<string>",
                "number": "<string>",
                "region": "<string>"
            }
        ]
    },
    "tax_metadata": {},
    "bill_to_address": "",
    "ship_to_address": "",
    "billing_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>"
    },
    "custom_fields": [{}],
    "auto_calculate_tax": "required",
    "record_status": "posted",
    "attachments": [],
    "term_id": 123,
    "reference_number": ""
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    memo: '<string>',
    date: '2023-12-25',
    company_id: 123,
    customer_id: 123,
    exchange_rate: 123,
    items: [
      {
        item_id: 123,
        quantity: 123,
        rate: 123,
        position: 123,
        memo: '<string>',
        tax: {
          code: '<string>',
          rate: 123,
          amount: 123,
          is_taxable: true,
          tax_exempt_amount: 123,
          vat_rate_id: 123,
          gst_tax_rate_id: 123,
          tax_metadata: {}
        },
        custom_fields: [{}],
        id: 123,
        classifications: []
      }
    ],
    supply_date: '2023-12-25',
    place_of_supply: '<string>',
    tax_registration_numbers: {
      company: [{type: '<string>', number: '<string>', region: '<string>'}],
      counterparty: [{type: '<string>', number: '<string>', region: '<string>'}]
    },
    tax_metadata: {},
    bill_to_address: '',
    ship_to_address: '',
    billing_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>'
    },
    custom_fields: [{}],
    auto_calculate_tax: 'required',
    record_status: 'posted',
    attachments: [],
    term_id: 123,
    reference_number: ''
  })
};

fetch('https://api.dualentry.com/public/v3-alpha/sales-orders/{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/sales-orders/{record_number}/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'memo' => '<string>',
    'date' => '2023-12-25',
    'company_id' => 123,
    'customer_id' => 123,
    'exchange_rate' => 123,
    'items' => [
        [
                'item_id' => 123,
                'quantity' => 123,
                'rate' => 123,
                'position' => 123,
                'memo' => '<string>',
                'tax' => [
                                'code' => '<string>',
                                'rate' => 123,
                                'amount' => 123,
                                'is_taxable' => true,
                                'tax_exempt_amount' => 123,
                                'vat_rate_id' => 123,
                                'gst_tax_rate_id' => 123,
                                'tax_metadata' => [
                                                                
                                ]
                ],
                'custom_fields' => [
                                [
                                                                
                                ]
                ],
                'id' => 123,
                'classifications' => [
                                
                ]
        ]
    ],
    'supply_date' => '2023-12-25',
    'place_of_supply' => '<string>',
    'tax_registration_numbers' => [
        'company' => [
                [
                                'type' => '<string>',
                                'number' => '<string>',
                                'region' => '<string>'
                ]
        ],
        'counterparty' => [
                [
                                'type' => '<string>',
                                'number' => '<string>',
                                'region' => '<string>'
                ]
        ]
    ],
    'tax_metadata' => [
        
    ],
    'bill_to_address' => '',
    'ship_to_address' => '',
    'billing_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>'
    ],
    'custom_fields' => [
        [
                
        ]
    ],
    'auto_calculate_tax' => 'required',
    'record_status' => 'posted',
    'attachments' => [
        
    ],
    'term_id' => 123,
    'reference_number' => ''
  ]),
  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/sales-orders/{record_number}/"

	payload := strings.NewReader("{\n  \"memo\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"customer_id\": 123,\n  \"exchange_rate\": 123,\n  \"items\": [\n    {\n      \"item_id\": 123,\n      \"quantity\": 123,\n      \"rate\": 123,\n      \"position\": 123,\n      \"memo\": \"<string>\",\n      \"tax\": {\n        \"code\": \"<string>\",\n        \"rate\": 123,\n        \"amount\": 123,\n        \"is_taxable\": true,\n        \"tax_exempt_amount\": 123,\n        \"vat_rate_id\": 123,\n        \"gst_tax_rate_id\": 123,\n        \"tax_metadata\": {}\n      },\n      \"custom_fields\": [\n        {}\n      ],\n      \"id\": 123,\n      \"classifications\": []\n    }\n  ],\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_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  \"custom_fields\": [\n    {}\n  ],\n  \"auto_calculate_tax\": \"required\",\n  \"record_status\": \"posted\",\n  \"attachments\": [],\n  \"term_id\": 123,\n  \"reference_number\": \"\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.dualentry.com/public/v3-alpha/sales-orders/{record_number}/")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"memo\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"customer_id\": 123,\n  \"exchange_rate\": 123,\n  \"items\": [\n    {\n      \"item_id\": 123,\n      \"quantity\": 123,\n      \"rate\": 123,\n      \"position\": 123,\n      \"memo\": \"<string>\",\n      \"tax\": {\n        \"code\": \"<string>\",\n        \"rate\": 123,\n        \"amount\": 123,\n        \"is_taxable\": true,\n        \"tax_exempt_amount\": 123,\n        \"vat_rate_id\": 123,\n        \"gst_tax_rate_id\": 123,\n        \"tax_metadata\": {}\n      },\n      \"custom_fields\": [\n        {}\n      ],\n      \"id\": 123,\n      \"classifications\": []\n    }\n  ],\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_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  \"custom_fields\": [\n    {}\n  ],\n  \"auto_calculate_tax\": \"required\",\n  \"record_status\": \"posted\",\n  \"attachments\": [],\n  \"term_id\": 123,\n  \"reference_number\": \"\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"memo\": \"<string>\",\n  \"date\": \"2023-12-25\",\n  \"company_id\": 123,\n  \"customer_id\": 123,\n  \"exchange_rate\": 123,\n  \"items\": [\n    {\n      \"item_id\": 123,\n      \"quantity\": 123,\n      \"rate\": 123,\n      \"position\": 123,\n      \"memo\": \"<string>\",\n      \"tax\": {\n        \"code\": \"<string>\",\n        \"rate\": 123,\n        \"amount\": 123,\n        \"is_taxable\": true,\n        \"tax_exempt_amount\": 123,\n        \"vat_rate_id\": 123,\n        \"gst_tax_rate_id\": 123,\n        \"tax_metadata\": {}\n      },\n      \"custom_fields\": [\n        {}\n      ],\n      \"id\": 123,\n      \"classifications\": []\n    }\n  ],\n  \"supply_date\": \"2023-12-25\",\n  \"place_of_supply\": \"<string>\",\n  \"tax_registration_numbers\": {\n    \"company\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ],\n    \"counterparty\": [\n      {\n        \"type\": \"<string>\",\n        \"number\": \"<string>\",\n        \"region\": \"<string>\"\n      }\n    ]\n  },\n  \"tax_metadata\": {},\n  \"bill_to_address\": \"\",\n  \"ship_to_address\": \"\",\n  \"billing_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  \"custom_fields\": [\n    {}\n  ],\n  \"auto_calculate_tax\": \"required\",\n  \"record_status\": \"posted\",\n  \"attachments\": [],\n  \"term_id\": 123,\n  \"reference_number\": \"\"\n}"

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

{
  "bill_to_address": "<string>",
  "ship_to_address": "<string>",
  "invoiced_status": "invoiced",
  "term_id": 123,
  "term_name": "<string>",
  "internal_id": 123,
  "number": 123,
  "company_id": 123,
  "company_name": "<string>",
  "company_currency": "<string>",
  "customer_id": 123,
  "customer_name": "<string>",
  "currency_iso_4217_code": "AED",
  "exchange_rate": "<string>",
  "amount": "<string>",
  "invoiced_total": "<string>",
  "due_total": "<string>",
  "memo": "<string>",
  "date": "2023-12-25",
  "record_status": "draft",
  "reference_number": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "billing_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>"
  },
  "custom_fields": [],
  "attachments": [],
  "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>"
  },
  "code": "<string>",
  "items": [],
  "recurring_record_number": 123,
  "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>"
}

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

memo

string

required

date

string<date>

required

company_id

integer

required

customer_id

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

items

PublicSalesOrderItemIn · object[]

required

Show child attributes

supply_date

string<date> | null

Tax point date for VAT and GST.

When the saved record uses a VAT or GST tax regime and you omit this field, DualEntry sets it to transaction_date, or to date when there is no transaction_date.

Recurring templates store the value you send. Each generated record that uses VAT or GST and has no supply date gets that default on save.

On PATCH, an omitted field keeps the stored value. Send supply_date again when you change date or transaction_date.

place_of_supply

string | null

Maximum string length: 2

tax_registration_numbers

TaxRegistrationNumbersSnapshot · object | null

Show child attributes

tax_metadata

object | null

Show child attributes

bill_to_address

string | null

default:""

deprecated

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_address

string | null

default:""

deprecated

Deprecated: send the structured billing_address / shipping_address instead.

billing_address

AddressSchemaIn · object | null

Show child attributes

shipping_address

AddressSchemaIn · object | null

Show child attributes

custom_fields

Custom Fields · object[] | null

auto_calculate_tax

enum<string> | null

Configures how to handle automatic tax calculations.

If auto_calculate_tax is unset, the tax you send on each line is stored. Set it to required to have DualEntry calculate the tax, replacing the tax on every line before it saves the record.

The calculation covers native US sales tax using DualEntry's tax engine. It also covers Avalara US sales tax, VAT, and GST.

For native VAT and GST, leave this field unset and send the rate and the tax on each line. Set it to required when a tax provider returns the tax.
The request fails with 422 when the result is DualEntry's own VAT or GST, when the calculation cannot finish, or when a required address is still missing.
When the record has a customer, DualEntry reads shipping_address, then billing_address, then the address saved on the customer.
If you send neither address, DualEntry copies the customer's saved address to billing_address and shipping_address.
When the record has a vendor, DualEntry reads ship_from_address and ship_to_address, then the addresses saved on the vendor and the company.
DualEntry stores only the ship addresses you sent.

Available options:

required

record_status

enum<string>

default:posted

Available options:

draft,

posted,

archived

attachments

AttachmentSchemaOut · object[]

Show child attributes

term_id

integer | null

reference_number

string

default:""

Response

bill_to_address

string

required

deprecated

Deprecated: send the structured billing_address / shipping_address instead.

ship_to_address

string

required

deprecated

Deprecated: send the structured billing_address / shipping_address instead.

invoiced_status

enum<string>

required

Available options:

invoiced,

uninvoiced,

partially_invoiced

term_id

integer | null

required

term_name

string

required

internal_id

integer

required

number

integer

required

company_id

integer

required

company_name

string

required

company_currency

string

required

customer_id

integer

required

customer_name

string

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

string

required

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

amount

string

required

Total amount of ordered items

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

invoiced_total

string

required

Total quantity of items that were already invoiced

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

due_total

string

required

Total quantity of items yet to be invoiced

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

memo

string

required

date

string<date>

required

record_status

enum<string>

required

Available options:

draft,

posted,

archived

reference_number

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

billing_address

AddressSchemaOut · object | null

Show child attributes

shipping_address

AddressSchemaOut · object | null

Show child attributes

custom_fields

CustomFieldValuePairOutputSchema · object[]

Show child attributes

attachments

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

code

string | null

items

PublicSalesOrderItemOut · object[]

Show child attributes

recurring_record_number

integer | null

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 SalesOrderV2 record

Authorizations

Headers

Path Parameters

Body

Response