Update One Carrier Payment Line Item

curl --request PUT \
  --url https://api.upwell.com/api/rest/carrier_payment_line_items/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "input": {
    "amount": 123,
    "billId": "<string>",
    "billingAccountNumber": "<string>",
    "billingName": "<string>",
    "carrierId": "<string>",
    "checkOrAchNumber": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "notes": "<string>",
    "referenceNumber": 123,
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "status": "<string>",
    "transactionDate": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
'

import requests

url = "https://api.upwell.com/api/rest/carrier_payment_line_items/{id}"

payload = {
    "id": "<string>",
    "input": {
        "amount": 123,
        "billId": "<string>",
        "billingAccountNumber": "<string>",
        "billingName": "<string>",
        "carrierId": "<string>",
        "checkOrAchNumber": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "notes": "<string>",
        "referenceNumber": 123,
        "sourceSystem": "<string>",
        "sourceSystemId": "<string>",
        "status": "<string>",
        "transactionDate": "<string>",
        "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: {
      amount: 123,
      billId: '<string>',
      billingAccountNumber: '<string>',
      billingName: '<string>',
      carrierId: '<string>',
      checkOrAchNumber: '<string>',
      createdAt: '2023-11-07T05:31:56Z',
      id: '<string>',
      notes: '<string>',
      referenceNumber: 123,
      sourceSystem: '<string>',
      sourceSystemId: '<string>',
      status: '<string>',
      transactionDate: '<string>',
      updatedAt: '2023-11-07T05:31:56Z'
    }
  })
};

fetch('https://api.upwell.com/api/rest/carrier_payment_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/carrier_payment_line_items/{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' => [
        'amount' => 123,
        'billId' => '<string>',
        'billingAccountNumber' => '<string>',
        'billingName' => '<string>',
        'carrierId' => '<string>',
        'checkOrAchNumber' => '<string>',
        'createdAt' => '2023-11-07T05:31:56Z',
        'id' => '<string>',
        'notes' => '<string>',
        'referenceNumber' => 123,
        'sourceSystem' => '<string>',
        'sourceSystemId' => '<string>',
        'status' => '<string>',
        'transactionDate' => '<string>',
        '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_payment_line_items/{id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"amount\": 123,\n    \"billId\": \"<string>\",\n    \"billingAccountNumber\": \"<string>\",\n    \"billingName\": \"<string>\",\n    \"carrierId\": \"<string>\",\n    \"checkOrAchNumber\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"referenceNumber\": 123,\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"transactionDate\": \"<string>\",\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_payment_line_items/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"amount\": 123,\n    \"billId\": \"<string>\",\n    \"billingAccountNumber\": \"<string>\",\n    \"billingName\": \"<string>\",\n    \"carrierId\": \"<string>\",\n    \"checkOrAchNumber\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"referenceNumber\": 123,\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"transactionDate\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.upwell.com/api/rest/carrier_payment_line_items/{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    \"amount\": 123,\n    \"billId\": \"<string>\",\n    \"billingAccountNumber\": \"<string>\",\n    \"billingName\": \"<string>\",\n    \"carrierId\": \"<string>\",\n    \"checkOrAchNumber\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"referenceNumber\": 123,\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"transactionDate\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\"\n  }\n}"

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

{
  "updateCarrierPaymentLineItem": {
    "amount": 123,
    "billId": "<string>",
    "billingAccountNumber": "<string>",
    "billingName": "<string>",
    "carrierId": "<string>",
    "checkOrAchNumber": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "notes": "<string>",
    "referenceNumber": 123,
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "status": "<string>",
    "transactionDate": "<string>",
    "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"
}

{
  "error": "Authentication hook unauthorized this request",
  "path": "$",
  "code": "access-denied"
}

PUT

api

rest

carrier_payment_line_items

{id}

Update One Carrier Payment Line Item

curl --request PUT \
  --url https://api.upwell.com/api/rest/carrier_payment_line_items/{id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "input": {
    "amount": 123,
    "billId": "<string>",
    "billingAccountNumber": "<string>",
    "billingName": "<string>",
    "carrierId": "<string>",
    "checkOrAchNumber": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "notes": "<string>",
    "referenceNumber": 123,
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "status": "<string>",
    "transactionDate": "<string>",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}
'

import requests

url = "https://api.upwell.com/api/rest/carrier_payment_line_items/{id}"

payload = {
    "id": "<string>",
    "input": {
        "amount": 123,
        "billId": "<string>",
        "billingAccountNumber": "<string>",
        "billingName": "<string>",
        "carrierId": "<string>",
        "checkOrAchNumber": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "notes": "<string>",
        "referenceNumber": 123,
        "sourceSystem": "<string>",
        "sourceSystemId": "<string>",
        "status": "<string>",
        "transactionDate": "<string>",
        "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: {
      amount: 123,
      billId: '<string>',
      billingAccountNumber: '<string>',
      billingName: '<string>',
      carrierId: '<string>',
      checkOrAchNumber: '<string>',
      createdAt: '2023-11-07T05:31:56Z',
      id: '<string>',
      notes: '<string>',
      referenceNumber: 123,
      sourceSystem: '<string>',
      sourceSystemId: '<string>',
      status: '<string>',
      transactionDate: '<string>',
      updatedAt: '2023-11-07T05:31:56Z'
    }
  })
};

fetch('https://api.upwell.com/api/rest/carrier_payment_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/carrier_payment_line_items/{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' => [
        'amount' => 123,
        'billId' => '<string>',
        'billingAccountNumber' => '<string>',
        'billingName' => '<string>',
        'carrierId' => '<string>',
        'checkOrAchNumber' => '<string>',
        'createdAt' => '2023-11-07T05:31:56Z',
        'id' => '<string>',
        'notes' => '<string>',
        'referenceNumber' => 123,
        'sourceSystem' => '<string>',
        'sourceSystemId' => '<string>',
        'status' => '<string>',
        'transactionDate' => '<string>',
        '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_payment_line_items/{id}"

	payload := strings.NewReader("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"amount\": 123,\n    \"billId\": \"<string>\",\n    \"billingAccountNumber\": \"<string>\",\n    \"billingName\": \"<string>\",\n    \"carrierId\": \"<string>\",\n    \"checkOrAchNumber\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"referenceNumber\": 123,\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"transactionDate\": \"<string>\",\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_payment_line_items/{id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"<string>\",\n  \"input\": {\n    \"amount\": 123,\n    \"billId\": \"<string>\",\n    \"billingAccountNumber\": \"<string>\",\n    \"billingName\": \"<string>\",\n    \"carrierId\": \"<string>\",\n    \"checkOrAchNumber\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"referenceNumber\": 123,\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"transactionDate\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.upwell.com/api/rest/carrier_payment_line_items/{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    \"amount\": 123,\n    \"billId\": \"<string>\",\n    \"billingAccountNumber\": \"<string>\",\n    \"billingName\": \"<string>\",\n    \"carrierId\": \"<string>\",\n    \"checkOrAchNumber\": \"<string>\",\n    \"createdAt\": \"2023-11-07T05:31:56Z\",\n    \"id\": \"<string>\",\n    \"notes\": \"<string>\",\n    \"referenceNumber\": 123,\n    \"sourceSystem\": \"<string>\",\n    \"sourceSystemId\": \"<string>\",\n    \"status\": \"<string>\",\n    \"transactionDate\": \"<string>\",\n    \"updatedAt\": \"2023-11-07T05:31:56Z\"\n  }\n}"

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

{
  "updateCarrierPaymentLineItem": {
    "amount": 123,
    "billId": "<string>",
    "billingAccountNumber": "<string>",
    "billingName": "<string>",
    "carrierId": "<string>",
    "checkOrAchNumber": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "<string>",
    "notes": "<string>",
    "referenceNumber": 123,
    "sourceSystem": "<string>",
    "sourceSystemId": "<string>",
    "status": "<string>",
    "transactionDate": "<string>",
    "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"
}

{
  "error": "Authentication hook unauthorized this request",
  "path": "$",
  "code": "access-denied"
}

Authorizations

Authorization

string

header

required

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

string

required

"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

string

Upwell identifier for this record. Store it to retrieve or update the record.

input

BillPaymentLineItemsSetInput · object

Object containing the fields to create or update. Only the fields in this endpoint schema are accepted.

Show child attributes

Response

Responses for PUT /api/rest/carrier_payment_line_items/{id}

updateCarrierPaymentLineItem

BillPaymentLineItems · object | null

columns and relationships of "bill_payment_line_items"

Show child attributes

Overview

Carrier Payment Line Items

Vendors

Invoice Line Items

Customers

Carrier Invoices

Carrier Invoice Documents

Documents

Addresses

Carriers

Bill Line Items

Stops

Vendor Invoices

Document Reference Specifications

Customer Payments

Bills

Purchase Orders

Customer Payment Line Items

Rules

Invoice Shipments

Companies

Invoices

Invoice Approval

Invoice Documents

Carrier Invoice Approval Requests

API Reference

Shipment Line Items

Shipments

Shipment Documents

Bill Payments

Webhooks

Update One Carrier Payment Line Item

Authorizations

Path Parameters

Body

Response