Update One Vendor Invoice Line Item
curl --request PATCH \
--url https://api.upwell.com/api/rest/vendor-invoice-line-items/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"chargeType": "<string>",
"customerPartNumber": "<string>",
"description": "<string>",
"discountPercent": "<unknown>",
"extendedAmount": 123,
"lineNumber": 123,
"notes": "<string>",
"poLineNumber": "<string>",
"poNumber": "<string>",
"quantity": "<unknown>",
"quantityBackordered": "<unknown>",
"quantityOrdered": "<unknown>",
"quantityShipped": "<unknown>",
"taxAmount": 123,
"taxable": true,
"unitOfMeasure": "<string>",
"unitPriceAmount": 123,
"unitPriceBasis": "<unknown>",
"vendorPartNumber": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/vendor-invoice-line-items/{id}"
payload = {
"id": "<string>",
"input": {
"chargeType": "<string>",
"customerPartNumber": "<string>",
"description": "<string>",
"discountPercent": "<unknown>",
"extendedAmount": 123,
"lineNumber": 123,
"notes": "<string>",
"poLineNumber": "<string>",
"poNumber": "<string>",
"quantity": "<unknown>",
"quantityBackordered": "<unknown>",
"quantityOrdered": "<unknown>",
"quantityShipped": "<unknown>",
"taxAmount": 123,
"taxable": True,
"unitOfMeasure": "<string>",
"unitPriceAmount": 123,
"unitPriceBasis": "<unknown>",
"vendorPartNumber": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
chargeType: '<string>',
customerPartNumber: '<string>',
description: '<string>',
discountPercent: '<unknown>',
extendedAmount: 123,
lineNumber: 123,
notes: '<string>',
poLineNumber: '<string>',
poNumber: '<string>',
quantity: '<unknown>',
quantityBackordered: '<unknown>',
quantityOrdered: '<unknown>',
quantityShipped: '<unknown>',
taxAmount: 123,
taxable: true,
unitOfMeasure: '<string>',
unitPriceAmount: 123,
unitPriceBasis: '<unknown>',
vendorPartNumber: '<string>',
weight: '<unknown>',
weightUnit: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/vendor-invoice-line-items/{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-invoice-line-items/{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' => [
'chargeType' => '<string>',
'customerPartNumber' => '<string>',
'description' => '<string>',
'discountPercent' => '<unknown>',
'extendedAmount' => 123,
'lineNumber' => 123,
'notes' => '<string>',
'poLineNumber' => '<string>',
'poNumber' => '<string>',
'quantity' => '<unknown>',
'quantityBackordered' => '<unknown>',
'quantityOrdered' => '<unknown>',
'quantityShipped' => '<unknown>',
'taxAmount' => 123,
'taxable' => true,
'unitOfMeasure' => '<string>',
'unitPriceAmount' => 123,
'unitPriceBasis' => '<unknown>',
'vendorPartNumber' => '<string>',
'weight' => '<unknown>',
'weightUnit' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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-invoice-line-items/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"chargeType\": \"<string>\",\n \"customerPartNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"discountPercent\": \"<unknown>\",\n \"extendedAmount\": 123,\n \"lineNumber\": 123,\n \"notes\": \"<string>\",\n \"poLineNumber\": \"<string>\",\n \"poNumber\": \"<string>\",\n \"quantity\": \"<unknown>\",\n \"quantityBackordered\": \"<unknown>\",\n \"quantityOrdered\": \"<unknown>\",\n \"quantityShipped\": \"<unknown>\",\n \"taxAmount\": 123,\n \"taxable\": true,\n \"unitOfMeasure\": \"<string>\",\n \"unitPriceAmount\": 123,\n \"unitPriceBasis\": \"<unknown>\",\n \"vendorPartNumber\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<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.upwell.com/api/rest/vendor-invoice-line-items/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"chargeType\": \"<string>\",\n \"customerPartNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"discountPercent\": \"<unknown>\",\n \"extendedAmount\": 123,\n \"lineNumber\": 123,\n \"notes\": \"<string>\",\n \"poLineNumber\": \"<string>\",\n \"poNumber\": \"<string>\",\n \"quantity\": \"<unknown>\",\n \"quantityBackordered\": \"<unknown>\",\n \"quantityOrdered\": \"<unknown>\",\n \"quantityShipped\": \"<unknown>\",\n \"taxAmount\": 123,\n \"taxable\": true,\n \"unitOfMeasure\": \"<string>\",\n \"unitPriceAmount\": 123,\n \"unitPriceBasis\": \"<unknown>\",\n \"vendorPartNumber\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/vendor-invoice-line-items/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"chargeType\": \"<string>\",\n \"customerPartNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"discountPercent\": \"<unknown>\",\n \"extendedAmount\": 123,\n \"lineNumber\": 123,\n \"notes\": \"<string>\",\n \"poLineNumber\": \"<string>\",\n \"poNumber\": \"<string>\",\n \"quantity\": \"<unknown>\",\n \"quantityBackordered\": \"<unknown>\",\n \"quantityOrdered\": \"<unknown>\",\n \"quantityShipped\": \"<unknown>\",\n \"taxAmount\": 123,\n \"taxable\": true,\n \"unitOfMeasure\": \"<string>\",\n \"unitPriceAmount\": 123,\n \"unitPriceBasis\": \"<unknown>\",\n \"vendorPartNumber\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"updateVendorInvoiceLineItem": {
"id": "<string>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Vendor Invoices
Update One Vendor Invoice Line Item
Update parsed vendor invoice line item 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-invoice-line-items
/
{id}
Update One Vendor Invoice Line Item
curl --request PATCH \
--url https://api.upwell.com/api/rest/vendor-invoice-line-items/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"chargeType": "<string>",
"customerPartNumber": "<string>",
"description": "<string>",
"discountPercent": "<unknown>",
"extendedAmount": 123,
"lineNumber": 123,
"notes": "<string>",
"poLineNumber": "<string>",
"poNumber": "<string>",
"quantity": "<unknown>",
"quantityBackordered": "<unknown>",
"quantityOrdered": "<unknown>",
"quantityShipped": "<unknown>",
"taxAmount": 123,
"taxable": true,
"unitOfMeasure": "<string>",
"unitPriceAmount": 123,
"unitPriceBasis": "<unknown>",
"vendorPartNumber": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
'import requests
url = "https://api.upwell.com/api/rest/vendor-invoice-line-items/{id}"
payload = {
"id": "<string>",
"input": {
"chargeType": "<string>",
"customerPartNumber": "<string>",
"description": "<string>",
"discountPercent": "<unknown>",
"extendedAmount": 123,
"lineNumber": 123,
"notes": "<string>",
"poLineNumber": "<string>",
"poNumber": "<string>",
"quantity": "<unknown>",
"quantityBackordered": "<unknown>",
"quantityOrdered": "<unknown>",
"quantityShipped": "<unknown>",
"taxAmount": 123,
"taxable": True,
"unitOfMeasure": "<string>",
"unitPriceAmount": 123,
"unitPriceBasis": "<unknown>",
"vendorPartNumber": "<string>",
"weight": "<unknown>",
"weightUnit": "<string>"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
chargeType: '<string>',
customerPartNumber: '<string>',
description: '<string>',
discountPercent: '<unknown>',
extendedAmount: 123,
lineNumber: 123,
notes: '<string>',
poLineNumber: '<string>',
poNumber: '<string>',
quantity: '<unknown>',
quantityBackordered: '<unknown>',
quantityOrdered: '<unknown>',
quantityShipped: '<unknown>',
taxAmount: 123,
taxable: true,
unitOfMeasure: '<string>',
unitPriceAmount: 123,
unitPriceBasis: '<unknown>',
vendorPartNumber: '<string>',
weight: '<unknown>',
weightUnit: '<string>'
}
})
};
fetch('https://api.upwell.com/api/rest/vendor-invoice-line-items/{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-invoice-line-items/{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' => [
'chargeType' => '<string>',
'customerPartNumber' => '<string>',
'description' => '<string>',
'discountPercent' => '<unknown>',
'extendedAmount' => 123,
'lineNumber' => 123,
'notes' => '<string>',
'poLineNumber' => '<string>',
'poNumber' => '<string>',
'quantity' => '<unknown>',
'quantityBackordered' => '<unknown>',
'quantityOrdered' => '<unknown>',
'quantityShipped' => '<unknown>',
'taxAmount' => 123,
'taxable' => true,
'unitOfMeasure' => '<string>',
'unitPriceAmount' => 123,
'unitPriceBasis' => '<unknown>',
'vendorPartNumber' => '<string>',
'weight' => '<unknown>',
'weightUnit' => '<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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-invoice-line-items/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"chargeType\": \"<string>\",\n \"customerPartNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"discountPercent\": \"<unknown>\",\n \"extendedAmount\": 123,\n \"lineNumber\": 123,\n \"notes\": \"<string>\",\n \"poLineNumber\": \"<string>\",\n \"poNumber\": \"<string>\",\n \"quantity\": \"<unknown>\",\n \"quantityBackordered\": \"<unknown>\",\n \"quantityOrdered\": \"<unknown>\",\n \"quantityShipped\": \"<unknown>\",\n \"taxAmount\": 123,\n \"taxable\": true,\n \"unitOfMeasure\": \"<string>\",\n \"unitPriceAmount\": 123,\n \"unitPriceBasis\": \"<unknown>\",\n \"vendorPartNumber\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<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.upwell.com/api/rest/vendor-invoice-line-items/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"chargeType\": \"<string>\",\n \"customerPartNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"discountPercent\": \"<unknown>\",\n \"extendedAmount\": 123,\n \"lineNumber\": 123,\n \"notes\": \"<string>\",\n \"poLineNumber\": \"<string>\",\n \"poNumber\": \"<string>\",\n \"quantity\": \"<unknown>\",\n \"quantityBackordered\": \"<unknown>\",\n \"quantityOrdered\": \"<unknown>\",\n \"quantityShipped\": \"<unknown>\",\n \"taxAmount\": 123,\n \"taxable\": true,\n \"unitOfMeasure\": \"<string>\",\n \"unitPriceAmount\": 123,\n \"unitPriceBasis\": \"<unknown>\",\n \"vendorPartNumber\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/vendor-invoice-line-items/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"chargeType\": \"<string>\",\n \"customerPartNumber\": \"<string>\",\n \"description\": \"<string>\",\n \"discountPercent\": \"<unknown>\",\n \"extendedAmount\": 123,\n \"lineNumber\": 123,\n \"notes\": \"<string>\",\n \"poLineNumber\": \"<string>\",\n \"poNumber\": \"<string>\",\n \"quantity\": \"<unknown>\",\n \"quantityBackordered\": \"<unknown>\",\n \"quantityOrdered\": \"<unknown>\",\n \"quantityShipped\": \"<unknown>\",\n \"taxAmount\": 123,\n \"taxable\": true,\n \"unitOfMeasure\": \"<string>\",\n \"unitPriceAmount\": 123,\n \"unitPriceBasis\": \"<unknown>\",\n \"vendorPartNumber\": \"<string>\",\n \"weight\": \"<unknown>\",\n \"weightUnit\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"updateVendorInvoiceLineItem": {
"id": "<string>"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Authorizations
Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.
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
Responses for PATCH /api/rest/vendor-invoice-line-items/{id}
Line items for vendor invoice supporting documents (EDI 810 IT1-equivalent)
Show child attributes
Show child attributes
⌘I