Update One Carrier Invoice
curl --request PUT \
--url https://api.upwell.com/api/rest/carrier_invoices/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"additionalReferenceNumbers": "<unknown>",
"approvedAt": "2023-11-07T05:31:56Z",
"assignedAt": "2023-11-07T05:31:56Z",
"assignedById": "<string>",
"assignedToId": "<string>",
"balance": 123,
"billId": "<string>",
"billOfLadingNumber": "<string>",
"carrierBillingAddressId": "<string>",
"carrierId": "<string>",
"carrierName": "<string>",
"carrierProNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdFromEmailMessageId": "<string>",
"customerInvoiceId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"documentsModifiedAt": "<unknown>",
"documentsTypeOrCustomerVisibilityUpdatedAt": "<unknown>",
"dueDate": "2023-12-25",
"factorAddressId": "<string>",
"factorId": "<string>",
"id": "<string>",
"integrationId": "<string>",
"invoiceNumber": "<string>",
"issueDate": "2023-12-25",
"loadNumber": "<string>",
"matchingDisabled": true,
"mergedIntoCarrierInvoiceId": "<string>",
"metadata": "<unknown>",
"quickPayRequestReasoning": "<string>",
"quickPayRequestText": "<string>",
"quickPayRequested": true,
"receivedAt": "2023-11-07T05:31:56Z",
"referenceNumbers": "<unknown>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}
'import requests
url = "https://api.upwell.com/api/rest/carrier_invoices/{id}"
payload = {
"id": "<string>",
"input": {
"additionalReferenceNumbers": "<unknown>",
"approvedAt": "2023-11-07T05:31:56Z",
"assignedAt": "2023-11-07T05:31:56Z",
"assignedById": "<string>",
"assignedToId": "<string>",
"balance": 123,
"billId": "<string>",
"billOfLadingNumber": "<string>",
"carrierBillingAddressId": "<string>",
"carrierId": "<string>",
"carrierName": "<string>",
"carrierProNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdFromEmailMessageId": "<string>",
"customerInvoiceId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"documentsModifiedAt": "<unknown>",
"documentsTypeOrCustomerVisibilityUpdatedAt": "<unknown>",
"dueDate": "2023-12-25",
"factorAddressId": "<string>",
"factorId": "<string>",
"id": "<string>",
"integrationId": "<string>",
"invoiceNumber": "<string>",
"issueDate": "2023-12-25",
"loadNumber": "<string>",
"matchingDisabled": True,
"mergedIntoCarrierInvoiceId": "<string>",
"metadata": "<unknown>",
"quickPayRequestReasoning": "<string>",
"quickPayRequestText": "<string>",
"quickPayRequested": True,
"receivedAt": "2023-11-07T05:31:56Z",
"referenceNumbers": "<unknown>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
additionalReferenceNumbers: '<unknown>',
approvedAt: '2023-11-07T05:31:56Z',
assignedAt: '2023-11-07T05:31:56Z',
assignedById: '<string>',
assignedToId: '<string>',
balance: 123,
billId: '<string>',
billOfLadingNumber: '<string>',
carrierBillingAddressId: '<string>',
carrierId: '<string>',
carrierName: '<string>',
carrierProNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
createdFromEmailMessageId: '<string>',
customerInvoiceId: '<string>',
customerPoNumber: '<string>',
customerReferenceNumber: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
documentsModifiedAt: '<unknown>',
documentsTypeOrCustomerVisibilityUpdatedAt: '<unknown>',
dueDate: '2023-12-25',
factorAddressId: '<string>',
factorId: '<string>',
id: '<string>',
integrationId: '<string>',
invoiceNumber: '<string>',
issueDate: '2023-12-25',
loadNumber: '<string>',
matchingDisabled: true,
mergedIntoCarrierInvoiceId: '<string>',
metadata: '<unknown>',
quickPayRequestReasoning: '<string>',
quickPayRequestText: '<string>',
quickPayRequested: true,
receivedAt: '2023-11-07T05:31:56Z',
referenceNumbers: '<unknown>',
shipmentId: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
totalAmount: 123,
totalTaxAmount: 123,
updatedAt: '2023-11-07T05:31:56Z'
}
})
};
fetch('https://api.upwell.com/api/rest/carrier_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/carrier_invoices/{id}",
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([
'id' => '<string>',
'input' => [
'additionalReferenceNumbers' => '<unknown>',
'approvedAt' => '2023-11-07T05:31:56Z',
'assignedAt' => '2023-11-07T05:31:56Z',
'assignedById' => '<string>',
'assignedToId' => '<string>',
'balance' => 123,
'billId' => '<string>',
'billOfLadingNumber' => '<string>',
'carrierBillingAddressId' => '<string>',
'carrierId' => '<string>',
'carrierName' => '<string>',
'carrierProNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'createdFromEmailMessageId' => '<string>',
'customerInvoiceId' => '<string>',
'customerPoNumber' => '<string>',
'customerReferenceNumber' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'documentsModifiedAt' => '<unknown>',
'documentsTypeOrCustomerVisibilityUpdatedAt' => '<unknown>',
'dueDate' => '2023-12-25',
'factorAddressId' => '<string>',
'factorId' => '<string>',
'id' => '<string>',
'integrationId' => '<string>',
'invoiceNumber' => '<string>',
'issueDate' => '2023-12-25',
'loadNumber' => '<string>',
'matchingDisabled' => true,
'mergedIntoCarrierInvoiceId' => '<string>',
'metadata' => '<unknown>',
'quickPayRequestReasoning' => '<string>',
'quickPayRequestText' => '<string>',
'quickPayRequested' => true,
'receivedAt' => '2023-11-07T05:31:56Z',
'referenceNumbers' => '<unknown>',
'shipmentId' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'totalAmount' => 123,
'totalTaxAmount' => 123,
'updatedAt' => '2023-11-07T05:31:56Z'
]
]),
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/carrier_invoices/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"additionalReferenceNumbers\": \"<unknown>\",\n \"approvedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedById\": \"<string>\",\n \"assignedToId\": \"<string>\",\n \"balance\": 123,\n \"billId\": \"<string>\",\n \"billOfLadingNumber\": \"<string>\",\n \"carrierBillingAddressId\": \"<string>\",\n \"carrierId\": \"<string>\",\n \"carrierName\": \"<string>\",\n \"carrierProNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"customerInvoiceId\": \"<string>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"documentsModifiedAt\": \"<unknown>\",\n \"documentsTypeOrCustomerVisibilityUpdatedAt\": \"<unknown>\",\n \"dueDate\": \"2023-12-25\",\n \"factorAddressId\": \"<string>\",\n \"factorId\": \"<string>\",\n \"id\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"loadNumber\": \"<string>\",\n \"matchingDisabled\": true,\n \"mergedIntoCarrierInvoiceId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"quickPayRequestReasoning\": \"<string>\",\n \"quickPayRequestText\": \"<string>\",\n \"quickPayRequested\": true,\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"referenceNumbers\": \"<unknown>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"totalTaxAmount\": 123,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.upwell.com/api/rest/carrier_invoices/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"additionalReferenceNumbers\": \"<unknown>\",\n \"approvedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedById\": \"<string>\",\n \"assignedToId\": \"<string>\",\n \"balance\": 123,\n \"billId\": \"<string>\",\n \"billOfLadingNumber\": \"<string>\",\n \"carrierBillingAddressId\": \"<string>\",\n \"carrierId\": \"<string>\",\n \"carrierName\": \"<string>\",\n \"carrierProNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"customerInvoiceId\": \"<string>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"documentsModifiedAt\": \"<unknown>\",\n \"documentsTypeOrCustomerVisibilityUpdatedAt\": \"<unknown>\",\n \"dueDate\": \"2023-12-25\",\n \"factorAddressId\": \"<string>\",\n \"factorId\": \"<string>\",\n \"id\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"loadNumber\": \"<string>\",\n \"matchingDisabled\": true,\n \"mergedIntoCarrierInvoiceId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"quickPayRequestReasoning\": \"<string>\",\n \"quickPayRequestText\": \"<string>\",\n \"quickPayRequested\": true,\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"referenceNumbers\": \"<unknown>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"totalTaxAmount\": 123,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/carrier_invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"additionalReferenceNumbers\": \"<unknown>\",\n \"approvedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedById\": \"<string>\",\n \"assignedToId\": \"<string>\",\n \"balance\": 123,\n \"billId\": \"<string>\",\n \"billOfLadingNumber\": \"<string>\",\n \"carrierBillingAddressId\": \"<string>\",\n \"carrierId\": \"<string>\",\n \"carrierName\": \"<string>\",\n \"carrierProNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"customerInvoiceId\": \"<string>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"documentsModifiedAt\": \"<unknown>\",\n \"documentsTypeOrCustomerVisibilityUpdatedAt\": \"<unknown>\",\n \"dueDate\": \"2023-12-25\",\n \"factorAddressId\": \"<string>\",\n \"factorId\": \"<string>\",\n \"id\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"loadNumber\": \"<string>\",\n \"matchingDisabled\": true,\n \"mergedIntoCarrierInvoiceId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"quickPayRequestReasoning\": \"<string>\",\n \"quickPayRequestText\": \"<string>\",\n \"quickPayRequested\": true,\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"referenceNumbers\": \"<unknown>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"totalTaxAmount\": 123,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"updateCarrierInvoice": {
"balance": 123,
"billId": "<string>",
"carrierId": "<string>",
"carrierInvoiceLineItems": [
{
"description": "<string>",
"id": "<string>",
"item": "<string>",
"lineNumber": "<string>",
"quantity": "<unknown>",
"totalAmount": 123,
"unitPrice": 123
}
],
"createdAt": "2023-11-07T05:31:56Z",
"dueDate": "2023-12-25",
"exceptions": "<string>",
"id": "<string>",
"invoiceNumber": "<string>",
"issueDate": "2023-12-25",
"loadNumber": "<string>",
"metadata": "<unknown>",
"receivedAt": "2023-11-07T05:31:56Z",
"referenceNumbers": "<unknown>",
"shipmentId": "<string>",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"error": "Not-NULL violation. null value in column \"shipment_id\" of relation \"shipments\" violates not-null constraint",
"code": "constraint-violation"
}Carrier Invoices
Update One Carrier Invoice
Update a carrier invoice by ID
PUT
/
api
/
rest
/
carrier_invoices
/
{id}
Update One Carrier Invoice
curl --request PUT \
--url https://api.upwell.com/api/rest/carrier_invoices/{id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"id": "<string>",
"input": {
"additionalReferenceNumbers": "<unknown>",
"approvedAt": "2023-11-07T05:31:56Z",
"assignedAt": "2023-11-07T05:31:56Z",
"assignedById": "<string>",
"assignedToId": "<string>",
"balance": 123,
"billId": "<string>",
"billOfLadingNumber": "<string>",
"carrierBillingAddressId": "<string>",
"carrierId": "<string>",
"carrierName": "<string>",
"carrierProNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdFromEmailMessageId": "<string>",
"customerInvoiceId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"documentsModifiedAt": "<unknown>",
"documentsTypeOrCustomerVisibilityUpdatedAt": "<unknown>",
"dueDate": "2023-12-25",
"factorAddressId": "<string>",
"factorId": "<string>",
"id": "<string>",
"integrationId": "<string>",
"invoiceNumber": "<string>",
"issueDate": "2023-12-25",
"loadNumber": "<string>",
"matchingDisabled": true,
"mergedIntoCarrierInvoiceId": "<string>",
"metadata": "<unknown>",
"quickPayRequestReasoning": "<string>",
"quickPayRequestText": "<string>",
"quickPayRequested": true,
"receivedAt": "2023-11-07T05:31:56Z",
"referenceNumbers": "<unknown>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}
'import requests
url = "https://api.upwell.com/api/rest/carrier_invoices/{id}"
payload = {
"id": "<string>",
"input": {
"additionalReferenceNumbers": "<unknown>",
"approvedAt": "2023-11-07T05:31:56Z",
"assignedAt": "2023-11-07T05:31:56Z",
"assignedById": "<string>",
"assignedToId": "<string>",
"balance": 123,
"billId": "<string>",
"billOfLadingNumber": "<string>",
"carrierBillingAddressId": "<string>",
"carrierId": "<string>",
"carrierName": "<string>",
"carrierProNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdFromEmailMessageId": "<string>",
"customerInvoiceId": "<string>",
"customerPoNumber": "<string>",
"customerReferenceNumber": "<string>",
"deletedAt": "2023-11-07T05:31:56Z",
"documentsModifiedAt": "<unknown>",
"documentsTypeOrCustomerVisibilityUpdatedAt": "<unknown>",
"dueDate": "2023-12-25",
"factorAddressId": "<string>",
"factorId": "<string>",
"id": "<string>",
"integrationId": "<string>",
"invoiceNumber": "<string>",
"issueDate": "2023-12-25",
"loadNumber": "<string>",
"matchingDisabled": True,
"mergedIntoCarrierInvoiceId": "<string>",
"metadata": "<unknown>",
"quickPayRequestReasoning": "<string>",
"quickPayRequestText": "<string>",
"quickPayRequested": True,
"receivedAt": "2023-11-07T05:31:56Z",
"referenceNumbers": "<unknown>",
"shipmentId": "<string>",
"sourceSystem": "<string>",
"sourceSystemId": "<string>",
"sourceSystemMeta": "<unknown>",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '<string>',
input: {
additionalReferenceNumbers: '<unknown>',
approvedAt: '2023-11-07T05:31:56Z',
assignedAt: '2023-11-07T05:31:56Z',
assignedById: '<string>',
assignedToId: '<string>',
balance: 123,
billId: '<string>',
billOfLadingNumber: '<string>',
carrierBillingAddressId: '<string>',
carrierId: '<string>',
carrierName: '<string>',
carrierProNumber: '<string>',
createdAt: '2023-11-07T05:31:56Z',
createdFromEmailMessageId: '<string>',
customerInvoiceId: '<string>',
customerPoNumber: '<string>',
customerReferenceNumber: '<string>',
deletedAt: '2023-11-07T05:31:56Z',
documentsModifiedAt: '<unknown>',
documentsTypeOrCustomerVisibilityUpdatedAt: '<unknown>',
dueDate: '2023-12-25',
factorAddressId: '<string>',
factorId: '<string>',
id: '<string>',
integrationId: '<string>',
invoiceNumber: '<string>',
issueDate: '2023-12-25',
loadNumber: '<string>',
matchingDisabled: true,
mergedIntoCarrierInvoiceId: '<string>',
metadata: '<unknown>',
quickPayRequestReasoning: '<string>',
quickPayRequestText: '<string>',
quickPayRequested: true,
receivedAt: '2023-11-07T05:31:56Z',
referenceNumbers: '<unknown>',
shipmentId: '<string>',
sourceSystem: '<string>',
sourceSystemId: '<string>',
sourceSystemMeta: '<unknown>',
totalAmount: 123,
totalTaxAmount: 123,
updatedAt: '2023-11-07T05:31:56Z'
}
})
};
fetch('https://api.upwell.com/api/rest/carrier_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/carrier_invoices/{id}",
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([
'id' => '<string>',
'input' => [
'additionalReferenceNumbers' => '<unknown>',
'approvedAt' => '2023-11-07T05:31:56Z',
'assignedAt' => '2023-11-07T05:31:56Z',
'assignedById' => '<string>',
'assignedToId' => '<string>',
'balance' => 123,
'billId' => '<string>',
'billOfLadingNumber' => '<string>',
'carrierBillingAddressId' => '<string>',
'carrierId' => '<string>',
'carrierName' => '<string>',
'carrierProNumber' => '<string>',
'createdAt' => '2023-11-07T05:31:56Z',
'createdFromEmailMessageId' => '<string>',
'customerInvoiceId' => '<string>',
'customerPoNumber' => '<string>',
'customerReferenceNumber' => '<string>',
'deletedAt' => '2023-11-07T05:31:56Z',
'documentsModifiedAt' => '<unknown>',
'documentsTypeOrCustomerVisibilityUpdatedAt' => '<unknown>',
'dueDate' => '2023-12-25',
'factorAddressId' => '<string>',
'factorId' => '<string>',
'id' => '<string>',
'integrationId' => '<string>',
'invoiceNumber' => '<string>',
'issueDate' => '2023-12-25',
'loadNumber' => '<string>',
'matchingDisabled' => true,
'mergedIntoCarrierInvoiceId' => '<string>',
'metadata' => '<unknown>',
'quickPayRequestReasoning' => '<string>',
'quickPayRequestText' => '<string>',
'quickPayRequested' => true,
'receivedAt' => '2023-11-07T05:31:56Z',
'referenceNumbers' => '<unknown>',
'shipmentId' => '<string>',
'sourceSystem' => '<string>',
'sourceSystemId' => '<string>',
'sourceSystemMeta' => '<unknown>',
'totalAmount' => 123,
'totalTaxAmount' => 123,
'updatedAt' => '2023-11-07T05:31:56Z'
]
]),
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/carrier_invoices/{id}"
payload := strings.NewReader("{\n \"id\": \"<string>\",\n \"input\": {\n \"additionalReferenceNumbers\": \"<unknown>\",\n \"approvedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedById\": \"<string>\",\n \"assignedToId\": \"<string>\",\n \"balance\": 123,\n \"billId\": \"<string>\",\n \"billOfLadingNumber\": \"<string>\",\n \"carrierBillingAddressId\": \"<string>\",\n \"carrierId\": \"<string>\",\n \"carrierName\": \"<string>\",\n \"carrierProNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"customerInvoiceId\": \"<string>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"documentsModifiedAt\": \"<unknown>\",\n \"documentsTypeOrCustomerVisibilityUpdatedAt\": \"<unknown>\",\n \"dueDate\": \"2023-12-25\",\n \"factorAddressId\": \"<string>\",\n \"factorId\": \"<string>\",\n \"id\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"loadNumber\": \"<string>\",\n \"matchingDisabled\": true,\n \"mergedIntoCarrierInvoiceId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"quickPayRequestReasoning\": \"<string>\",\n \"quickPayRequestText\": \"<string>\",\n \"quickPayRequested\": true,\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"referenceNumbers\": \"<unknown>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"totalTaxAmount\": 123,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.upwell.com/api/rest/carrier_invoices/{id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"<string>\",\n \"input\": {\n \"additionalReferenceNumbers\": \"<unknown>\",\n \"approvedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedById\": \"<string>\",\n \"assignedToId\": \"<string>\",\n \"balance\": 123,\n \"billId\": \"<string>\",\n \"billOfLadingNumber\": \"<string>\",\n \"carrierBillingAddressId\": \"<string>\",\n \"carrierId\": \"<string>\",\n \"carrierName\": \"<string>\",\n \"carrierProNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"customerInvoiceId\": \"<string>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"documentsModifiedAt\": \"<unknown>\",\n \"documentsTypeOrCustomerVisibilityUpdatedAt\": \"<unknown>\",\n \"dueDate\": \"2023-12-25\",\n \"factorAddressId\": \"<string>\",\n \"factorId\": \"<string>\",\n \"id\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"loadNumber\": \"<string>\",\n \"matchingDisabled\": true,\n \"mergedIntoCarrierInvoiceId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"quickPayRequestReasoning\": \"<string>\",\n \"quickPayRequestText\": \"<string>\",\n \"quickPayRequested\": true,\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"referenceNumbers\": \"<unknown>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"totalTaxAmount\": 123,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.upwell.com/api/rest/carrier_invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"<string>\",\n \"input\": {\n \"additionalReferenceNumbers\": \"<unknown>\",\n \"approvedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedAt\": \"2023-11-07T05:31:56Z\",\n \"assignedById\": \"<string>\",\n \"assignedToId\": \"<string>\",\n \"balance\": 123,\n \"billId\": \"<string>\",\n \"billOfLadingNumber\": \"<string>\",\n \"carrierBillingAddressId\": \"<string>\",\n \"carrierId\": \"<string>\",\n \"carrierName\": \"<string>\",\n \"carrierProNumber\": \"<string>\",\n \"createdAt\": \"2023-11-07T05:31:56Z\",\n \"createdFromEmailMessageId\": \"<string>\",\n \"customerInvoiceId\": \"<string>\",\n \"customerPoNumber\": \"<string>\",\n \"customerReferenceNumber\": \"<string>\",\n \"deletedAt\": \"2023-11-07T05:31:56Z\",\n \"documentsModifiedAt\": \"<unknown>\",\n \"documentsTypeOrCustomerVisibilityUpdatedAt\": \"<unknown>\",\n \"dueDate\": \"2023-12-25\",\n \"factorAddressId\": \"<string>\",\n \"factorId\": \"<string>\",\n \"id\": \"<string>\",\n \"integrationId\": \"<string>\",\n \"invoiceNumber\": \"<string>\",\n \"issueDate\": \"2023-12-25\",\n \"loadNumber\": \"<string>\",\n \"matchingDisabled\": true,\n \"mergedIntoCarrierInvoiceId\": \"<string>\",\n \"metadata\": \"<unknown>\",\n \"quickPayRequestReasoning\": \"<string>\",\n \"quickPayRequestText\": \"<string>\",\n \"quickPayRequested\": true,\n \"receivedAt\": \"2023-11-07T05:31:56Z\",\n \"referenceNumbers\": \"<unknown>\",\n \"shipmentId\": \"<string>\",\n \"sourceSystem\": \"<string>\",\n \"sourceSystemId\": \"<string>\",\n \"sourceSystemMeta\": \"<unknown>\",\n \"totalAmount\": 123,\n \"totalTaxAmount\": 123,\n \"updatedAt\": \"2023-11-07T05:31:56Z\"\n }\n}"
response = http.request(request)
puts response.read_body{
"updateCarrierInvoice": {
"balance": 123,
"billId": "<string>",
"carrierId": "<string>",
"carrierInvoiceLineItems": [
{
"description": "<string>",
"id": "<string>",
"item": "<string>",
"lineNumber": "<string>",
"quantity": "<unknown>",
"totalAmount": 123,
"unitPrice": 123
}
],
"createdAt": "2023-11-07T05:31:56Z",
"dueDate": "2023-12-25",
"exceptions": "<string>",
"id": "<string>",
"invoiceNumber": "<string>",
"issueDate": "2023-12-25",
"loadNumber": "<string>",
"metadata": "<unknown>",
"receivedAt": "2023-11-07T05:31:56Z",
"referenceNumbers": "<unknown>",
"shipmentId": "<string>",
"totalAmount": 123,
"totalTaxAmount": 123,
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"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 PUT /api/rest/carrier_invoices/{id}
Invoices (payables) received from carriers (e.g. via email)
Show child attributes
Show child attributes
⌘I