Update One Vendor Invoice
curl --request PATCH \
--url https://api.upwell.com/api/rest/vendor-invoices/{id} \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"accountNumber": "<string>",
"amountReceived": 123,
"customerNumber": "<string>",
"department": "<string>",
"dueDate": "2023-12-25",
"fobPoint": "<string>",
"freightAmount": 123,
"incoterms": "<string>",
"invoiceDate": "2023-12-25",
"invoiceNumber": "<string>",
"legibilityReasoning": "<string>",
"legibilityScore": "<unknown>",
"notes": "<string>",
"orderDate": "2023-12-25",
"paymentTermsDescription": "<string>",
"paymentTermsDiscountDays": 123,
"paymentTermsDiscountPercent": "<unknown>",
"paymentTermsNetDays": 123,
"poNumber": "<string>",
"projectNumber": "<string>",
"referenceNumbers": "<unknown>",
"requisitionerName": "<string>",
"salesOrderNumber": "<string>",
"shipVia": "<string>",
"shipmentInfo": "<unknown>",
"specialInstructions": "<string>",
"subtotalAmount": 123,
"surchargeAmount": 123,
"taxAmount": 123,
"taxExempt": true,
"totalAmount": 123
}
}
'import requests
url = "https://api.upwell.com/api/rest/vendor-invoices/{id}"
payload = {
"id": "<string>",
"input": {
"accountNumber": "<string>",
"amountReceived": 123,
"customerNumber": "<string>",
"department": "<string>",
"dueDate": "2023-12-25",
"fobPoint": "<string>",
"freightAmount": 123,
"incoterms": "<string>",
"invoiceDate": "2023-12-25",
"invoiceNumber": "<string>",
"legibilityReasoning": "<string>",
"legibilityScore": "<unknown>",
"notes": "<string>",
"orderDate": "2023-12-25",
"paymentTermsDescription": "<string>",
"paymentTermsDiscountDays": 123,
"paymentTermsDiscountPercent": "<unknown>",
"paymentTermsNetDays": 123,
"poNumber": "<string>",
"projectNumber": "<string>",
"referenceNumbers": "<unknown>",
"requisitionerName": "<string>",
"salesOrderNumber": "<string>",
"shipVia": "<string>",
"shipmentInfo": "<unknown>",
"specialInstructions": "<string>",
"subtotalAmount": 123,
"surchargeAmount": 123,
"taxAmount": 123,
"taxExempt": True,
"totalAmount": 123
}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
accountNumber: '<string>',
amountReceived: 123,
customerNumber: '<string>',
department: '<string>',
dueDate: '2023-12-25',
fobPoint: '<string>',
freightAmount: 123,
incoterms: '<string>',
invoiceDate: '2023-12-25',
invoiceNumber: '<string>',
legibilityReasoning: '<string>',
legibilityScore: '<unknown>',
notes: '<string>',
orderDate: '2023-12-25',
paymentTermsDescription: '<string>',
paymentTermsDiscountDays: 123,
paymentTermsDiscountPercent: '<unknown>',
paymentTermsNetDays: 123,
poNumber: '<string>',
projectNumber: '<string>',
referenceNumbers: '<unknown>',
requisitionerName: '<string>',
salesOrderNumber: '<string>',
shipVia: '<string>',
shipmentInfo: '<unknown>',
specialInstructions: '<string>',
subtotalAmount: 123,
surchargeAmount: 123,
taxAmount: 123,
taxExempt: true,
totalAmount: 123
}
})
};
fetch('https://api.upwell.com/api/rest/vendor-invoices/{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.upwell.com/api/rest/vendor-invoices/{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([
'id' => '<string>',
'input' => [
'accountNumber' => '<string>',
'amountReceived' => 123,
'customerNumber' => '<string>',
'department' => '<string>',
'dueDate' => '2023-12-25',
'fobPoint' => '<string>',
'freightAmount' => 123,
'incoterms' => '<string>',
'invoiceDate' => '2023-12-25',
'invoiceNumber' => '<string>',
'legibilityReasoning' => '<string>',
'legibilityScore' => '<unknown>',
'notes' => '<string>',
'orderDate' => '2023-12-25',
'paymentTermsDescription' => '<string>',
'paymentTermsDiscountDays' => 123,
'paymentTermsDiscountPercent' => '<unknown>',
'paymentTermsNetDays' => 123,
'poNumber' => '<string>',
'projectNumber' => '<string>',
'referenceNumbers' => '<unknown>',
'requisitionerName' => '<string>',
'salesOrderNumber' => '<string>',
'shipVia' => '<string>',
'shipmentInfo' => '<unknown>',
'specialInstructions' => '<string>',
'subtotalAmount' => 123,
'surchargeAmount' => 123,
'taxAmount' => 123,
'taxExempt' => true,
'totalAmount' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.upwell.com/api/rest/vendor-invoices/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"accountNumber\": \"<string>\",\n \"amountReceived\": 123,\n \"customerNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"fobPoint\": \"<string>\",\n \"freightAmount\": 123,\n \"incoterms\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"invoiceNumber\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"notes\": \"<string>\",\n \"orderDate\": \"2023-12-25\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"poNumber\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"requisitionerName\": \"<string>\",\n \"salesOrderNumber\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"shipmentInfo\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"surchargeAmount\": 123,\n \"taxAmount\": 123,\n \"taxExempt\": true,\n \"totalAmount\": 123\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.upwell.com/api/rest/vendor-invoices/{id}")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"accountNumber\": \"<string>\",\n \"amountReceived\": 123,\n \"customerNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"fobPoint\": \"<string>\",\n \"freightAmount\": 123,\n \"incoterms\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"invoiceNumber\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"notes\": \"<string>\",\n \"orderDate\": \"2023-12-25\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"poNumber\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"requisitionerName\": \"<string>\",\n \"salesOrderNumber\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"shipmentInfo\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"surchargeAmount\": 123,\n \"taxAmount\": 123,\n \"taxExempt\": true,\n \"totalAmount\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/vendor-invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"accountNumber\": \"<string>\",\n \"amountReceived\": 123,\n \"customerNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"fobPoint\": \"<string>\",\n \"freightAmount\": 123,\n \"incoterms\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"invoiceNumber\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"notes\": \"<string>\",\n \"orderDate\": \"2023-12-25\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"poNumber\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"requisitionerName\": \"<string>\",\n \"salesOrderNumber\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"shipmentInfo\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"surchargeAmount\": 123,\n \"taxAmount\": 123,\n \"taxExempt\": true,\n \"totalAmount\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"updateVendorInvoice": {
"id": "<string>"
}
}Vendor Invoices
Update One Vendor Invoice
Update parsed vendor invoice header fields. Body: { "input": { ...fields to set... } } using the record’s camelCase field names (amounts in integer cents). System-managed columns (ids, tenant/document linkage, party references, match state) are not updatable and are rejected.
PATCH
/
api
/
rest
/
vendor-invoices
/
{id}
Update One Vendor Invoice
curl --request PATCH \
--url https://api.upwell.com/api/rest/vendor-invoices/{id} \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"accountNumber": "<string>",
"amountReceived": 123,
"customerNumber": "<string>",
"department": "<string>",
"dueDate": "2023-12-25",
"fobPoint": "<string>",
"freightAmount": 123,
"incoterms": "<string>",
"invoiceDate": "2023-12-25",
"invoiceNumber": "<string>",
"legibilityReasoning": "<string>",
"legibilityScore": "<unknown>",
"notes": "<string>",
"orderDate": "2023-12-25",
"paymentTermsDescription": "<string>",
"paymentTermsDiscountDays": 123,
"paymentTermsDiscountPercent": "<unknown>",
"paymentTermsNetDays": 123,
"poNumber": "<string>",
"projectNumber": "<string>",
"referenceNumbers": "<unknown>",
"requisitionerName": "<string>",
"salesOrderNumber": "<string>",
"shipVia": "<string>",
"shipmentInfo": "<unknown>",
"specialInstructions": "<string>",
"subtotalAmount": 123,
"surchargeAmount": 123,
"taxAmount": 123,
"taxExempt": true,
"totalAmount": 123
}
}
'import requests
url = "https://api.upwell.com/api/rest/vendor-invoices/{id}"
payload = {
"id": "<string>",
"input": {
"accountNumber": "<string>",
"amountReceived": 123,
"customerNumber": "<string>",
"department": "<string>",
"dueDate": "2023-12-25",
"fobPoint": "<string>",
"freightAmount": 123,
"incoterms": "<string>",
"invoiceDate": "2023-12-25",
"invoiceNumber": "<string>",
"legibilityReasoning": "<string>",
"legibilityScore": "<unknown>",
"notes": "<string>",
"orderDate": "2023-12-25",
"paymentTermsDescription": "<string>",
"paymentTermsDiscountDays": 123,
"paymentTermsDiscountPercent": "<unknown>",
"paymentTermsNetDays": 123,
"poNumber": "<string>",
"projectNumber": "<string>",
"referenceNumbers": "<unknown>",
"requisitionerName": "<string>",
"salesOrderNumber": "<string>",
"shipVia": "<string>",
"shipmentInfo": "<unknown>",
"specialInstructions": "<string>",
"subtotalAmount": 123,
"surchargeAmount": 123,
"taxAmount": 123,
"taxExempt": True,
"totalAmount": 123
}
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
accountNumber: '<string>',
amountReceived: 123,
customerNumber: '<string>',
department: '<string>',
dueDate: '2023-12-25',
fobPoint: '<string>',
freightAmount: 123,
incoterms: '<string>',
invoiceDate: '2023-12-25',
invoiceNumber: '<string>',
legibilityReasoning: '<string>',
legibilityScore: '<unknown>',
notes: '<string>',
orderDate: '2023-12-25',
paymentTermsDescription: '<string>',
paymentTermsDiscountDays: 123,
paymentTermsDiscountPercent: '<unknown>',
paymentTermsNetDays: 123,
poNumber: '<string>',
projectNumber: '<string>',
referenceNumbers: '<unknown>',
requisitionerName: '<string>',
salesOrderNumber: '<string>',
shipVia: '<string>',
shipmentInfo: '<unknown>',
specialInstructions: '<string>',
subtotalAmount: 123,
surchargeAmount: 123,
taxAmount: 123,
taxExempt: true,
totalAmount: 123
}
})
};
fetch('https://api.upwell.com/api/rest/vendor-invoices/{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.upwell.com/api/rest/vendor-invoices/{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([
'id' => '<string>',
'input' => [
'accountNumber' => '<string>',
'amountReceived' => 123,
'customerNumber' => '<string>',
'department' => '<string>',
'dueDate' => '2023-12-25',
'fobPoint' => '<string>',
'freightAmount' => 123,
'incoterms' => '<string>',
'invoiceDate' => '2023-12-25',
'invoiceNumber' => '<string>',
'legibilityReasoning' => '<string>',
'legibilityScore' => '<unknown>',
'notes' => '<string>',
'orderDate' => '2023-12-25',
'paymentTermsDescription' => '<string>',
'paymentTermsDiscountDays' => 123,
'paymentTermsDiscountPercent' => '<unknown>',
'paymentTermsNetDays' => 123,
'poNumber' => '<string>',
'projectNumber' => '<string>',
'referenceNumbers' => '<unknown>',
'requisitionerName' => '<string>',
'salesOrderNumber' => '<string>',
'shipVia' => '<string>',
'shipmentInfo' => '<unknown>',
'specialInstructions' => '<string>',
'subtotalAmount' => 123,
'surchargeAmount' => 123,
'taxAmount' => 123,
'taxExempt' => true,
'totalAmount' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$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.upwell.com/api/rest/vendor-invoices/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"accountNumber\": \"<string>\",\n \"amountReceived\": 123,\n \"customerNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"fobPoint\": \"<string>\",\n \"freightAmount\": 123,\n \"incoterms\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"invoiceNumber\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"notes\": \"<string>\",\n \"orderDate\": \"2023-12-25\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"poNumber\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"requisitionerName\": \"<string>\",\n \"salesOrderNumber\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"shipmentInfo\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"surchargeAmount\": 123,\n \"taxAmount\": 123,\n \"taxExempt\": true,\n \"totalAmount\": 123\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.upwell.com/api/rest/vendor-invoices/{id}")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"accountNumber\": \"<string>\",\n \"amountReceived\": 123,\n \"customerNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"fobPoint\": \"<string>\",\n \"freightAmount\": 123,\n \"incoterms\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"invoiceNumber\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"notes\": \"<string>\",\n \"orderDate\": \"2023-12-25\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"poNumber\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"requisitionerName\": \"<string>\",\n \"salesOrderNumber\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"shipmentInfo\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"surchargeAmount\": 123,\n \"taxAmount\": 123,\n \"taxExempt\": true,\n \"totalAmount\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/vendor-invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"accountNumber\": \"<string>\",\n \"amountReceived\": 123,\n \"customerNumber\": \"<string>\",\n \"department\": \"<string>\",\n \"dueDate\": \"2023-12-25\",\n \"fobPoint\": \"<string>\",\n \"freightAmount\": 123,\n \"incoterms\": \"<string>\",\n \"invoiceDate\": \"2023-12-25\",\n \"invoiceNumber\": \"<string>\",\n \"legibilityReasoning\": \"<string>\",\n \"legibilityScore\": \"<unknown>\",\n \"notes\": \"<string>\",\n \"orderDate\": \"2023-12-25\",\n \"paymentTermsDescription\": \"<string>\",\n \"paymentTermsDiscountDays\": 123,\n \"paymentTermsDiscountPercent\": \"<unknown>\",\n \"paymentTermsNetDays\": 123,\n \"poNumber\": \"<string>\",\n \"projectNumber\": \"<string>\",\n \"referenceNumbers\": \"<unknown>\",\n \"requisitionerName\": \"<string>\",\n \"salesOrderNumber\": \"<string>\",\n \"shipVia\": \"<string>\",\n \"shipmentInfo\": \"<unknown>\",\n \"specialInstructions\": \"<string>\",\n \"subtotalAmount\": 123,\n \"surchargeAmount\": 123,\n \"taxAmount\": 123,\n \"taxExempt\": true,\n \"totalAmount\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"updateVendorInvoice": {
"id": "<string>"
}
}Headers
Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
Path Parameters
"id" is required (enter it either in parameters or request body)
Body
application/json
Query parameters can also be provided in the request body as a JSON object
Response
200 - application/json
Responses for PATCH /api/rest/vendor-invoices/{id}
Vendor Invoice supporting document - parsed data from VENDOR_INVOICE documents (generic non-freight AP invoices), modeled for EDI 810 and PO matching
Show child attributes
Show child attributes
⌘I