Shipper Invoices API
Get Shipper Invoice
Returns a single invoice
GET
/
shipper
/
invoices
/
{id}
Get Shipper Invoice
curl --request GET \
--url https://api-lg-k.arms.cedarai.com/shipper/invoices/{id} \
--header 'Carrier: <carrier>' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>'import requests
url = "https://api-lg-k.arms.cedarai.com/shipper/invoices/{id}"
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>'
}
};
fetch('https://api-lg-k.arms.cedarai.com/shipper/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-lg-k.arms.cedarai.com/shipper/invoices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <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"
"net/http"
"io"
)
func main() {
url := "https://api-lg-k.arms.cedarai.com/shipper/invoices/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-lg-k.arms.cedarai.com/shipper/invoices/{id}")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k.arms.cedarai.com/shipper/invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"invoice": {
"accrual_amount_this_carrier": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"accrual_amount_waybill_total": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"accrual_freight_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"accrual_fuel_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"accrual_misc_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"audit_comments": "<string>",
"balance": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"bill_of_lading_date": "<string>",
"bill_of_lading_identifier": "<string>",
"billed_freight_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"billed_fuel_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"billed_misc_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"billing_carrier": "<string>",
"billing_date": "<string>",
"commodity_code": "<string>",
"commodity_description": "<string>",
"destination": {
"city": "<string>",
"name": "<string>",
"state_or_province": "<string>"
},
"equipment": [
{
"initial": "<string>",
"number": "<string>"
}
],
"extended_references": [
{
"qualifier": "<string>",
"value": "<string>"
}
],
"freight_bill_number": "<string>",
"id": "<string>",
"invoice_documents": [
{
"created_at": "<string>",
"edi_invoice": {
"invoice_x12": "<string>",
"send_date": "<string>"
},
"parsed_invoice": {
"bill_of_lading_id": {
"date": {
"day": 123,
"month": 123,
"year": 123
},
"identifier": "<string>",
"type": "<string>"
},
"billing_carrier": "<string>",
"billing_date": "<string>",
"commodity_code": "<string>",
"commodity_description": "<string>",
"destination": {
"city": "<string>",
"name": "<string>",
"state_or_province": "<string>"
},
"document_uuid": "<string>",
"equipment_ids": [
{
"initial": "<string>",
"number": "<string>"
}
],
"freight_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"freight_bill_number": "<string>",
"fuel_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"invoice_number": "<string>",
"lead_equipment_id": {
"initial": "<string>",
"number": "<string>"
},
"misc_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"origin": {
"city": "<string>",
"name": "<string>",
"state_or_province": "<string>"
},
"paying_party": {
"name": "<string>",
"number": "<string>"
},
"payment_due_date": "<string>",
"pdf_page_number": 123,
"qualifier": "<string>",
"quantity": 123,
"total_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"waybill_id": {
"date": "<string>",
"number": 123
}
}
}
],
"invoice_number": "<string>",
"origin": {
"city": "<string>",
"name": "<string>",
"state_or_province": "<string>"
},
"paying_party": {
"name": "<string>",
"number": "<string>"
},
"payment_due_date": "<string>",
"rule_11_destination": {
"city": "<string>",
"state": "<string>"
},
"rule_11_origin": {
"city": "<string>",
"state": "<string>"
},
"shipment_name": "<string>",
"total_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"transportation_destination": {
"city": "<string>",
"state": "<string>"
},
"transportation_origin": {
"city": "<string>",
"state": "<string>"
},
"voucher_id": "<string>",
"waybill_date": "<string>",
"waybill_number": 123
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Was this page helpful?
⌘I
Get Shipper Invoice
curl --request GET \
--url https://api-lg-k.arms.cedarai.com/shipper/invoices/{id} \
--header 'Carrier: <carrier>' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>'import requests
url = "https://api-lg-k.arms.cedarai.com/shipper/invoices/{id}"
headers = {
"Carrier": "<carrier>",
"x-arms-api-key": "<api-key>",
"x-arms-assume-user": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {
Carrier: '<carrier>',
'x-arms-api-key': '<api-key>',
'x-arms-assume-user': '<api-key>'
}
};
fetch('https://api-lg-k.arms.cedarai.com/shipper/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-lg-k.arms.cedarai.com/shipper/invoices/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Carrier: <carrier>",
"x-arms-api-key: <api-key>",
"x-arms-assume-user: <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"
"net/http"
"io"
)
func main() {
url := "https://api-lg-k.arms.cedarai.com/shipper/invoices/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Carrier", "<carrier>")
req.Header.Add("x-arms-api-key", "<api-key>")
req.Header.Add("x-arms-assume-user", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api-lg-k.arms.cedarai.com/shipper/invoices/{id}")
.header("Carrier", "<carrier>")
.header("x-arms-api-key", "<api-key>")
.header("x-arms-assume-user", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api-lg-k.arms.cedarai.com/shipper/invoices/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Carrier"] = '<carrier>'
request["x-arms-api-key"] = '<api-key>'
request["x-arms-assume-user"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"invoice": {
"accrual_amount_this_carrier": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"accrual_amount_waybill_total": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"accrual_freight_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"accrual_fuel_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"accrual_misc_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"audit_comments": "<string>",
"balance": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"bill_of_lading_date": "<string>",
"bill_of_lading_identifier": "<string>",
"billed_freight_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"billed_fuel_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"billed_misc_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"billing_carrier": "<string>",
"billing_date": "<string>",
"commodity_code": "<string>",
"commodity_description": "<string>",
"destination": {
"city": "<string>",
"name": "<string>",
"state_or_province": "<string>"
},
"equipment": [
{
"initial": "<string>",
"number": "<string>"
}
],
"extended_references": [
{
"qualifier": "<string>",
"value": "<string>"
}
],
"freight_bill_number": "<string>",
"id": "<string>",
"invoice_documents": [
{
"created_at": "<string>",
"edi_invoice": {
"invoice_x12": "<string>",
"send_date": "<string>"
},
"parsed_invoice": {
"bill_of_lading_id": {
"date": {
"day": 123,
"month": 123,
"year": 123
},
"identifier": "<string>",
"type": "<string>"
},
"billing_carrier": "<string>",
"billing_date": "<string>",
"commodity_code": "<string>",
"commodity_description": "<string>",
"destination": {
"city": "<string>",
"name": "<string>",
"state_or_province": "<string>"
},
"document_uuid": "<string>",
"equipment_ids": [
{
"initial": "<string>",
"number": "<string>"
}
],
"freight_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"freight_bill_number": "<string>",
"fuel_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"invoice_number": "<string>",
"lead_equipment_id": {
"initial": "<string>",
"number": "<string>"
},
"misc_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"origin": {
"city": "<string>",
"name": "<string>",
"state_or_province": "<string>"
},
"paying_party": {
"name": "<string>",
"number": "<string>"
},
"payment_due_date": "<string>",
"pdf_page_number": 123,
"qualifier": "<string>",
"quantity": 123,
"total_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"waybill_id": {
"date": "<string>",
"number": 123
}
}
}
],
"invoice_number": "<string>",
"origin": {
"city": "<string>",
"name": "<string>",
"state_or_province": "<string>"
},
"paying_party": {
"name": "<string>",
"number": "<string>"
},
"payment_due_date": "<string>",
"rule_11_destination": {
"city": "<string>",
"state": "<string>"
},
"rule_11_origin": {
"city": "<string>",
"state": "<string>"
},
"shipment_name": "<string>",
"total_amount": {
"cents": 123,
"currency": "<string>",
"dollars": "<string>"
},
"transportation_destination": {
"city": "<string>",
"state": "<string>"
},
"transportation_origin": {
"city": "<string>",
"state": "<string>"
},
"voucher_id": "<string>",
"waybill_date": "<string>",
"waybill_number": 123
}
}{
"code": 123,
"details": [
{
"@type": "<string>"
}
],
"message": "<string>"
}