Returns list of invoices
curl --request GET \
--url https://api-lg-k.arms.cedarai.com/shipper/invoices \
--header 'Carrier: <carrier>' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>'{
"invoices": [
{
"id": "<string>",
"freight_bill_number": "<string>",
"invoice_number": "<string>",
"billing_carrier": "<string>",
"billing_date": "<string>",
"total_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"balance": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_amount_waybill_total": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_amount_this_carrier": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"payment_due_date": "<string>",
"audit_status": "PENDING_APPROVAL",
"audit_comments": "<string>",
"shipment_name": "<string>",
"equipment": [
{
"initial": "<string>",
"number": "<string>"
}
],
"bill_of_lading_identifier": "<string>",
"bill_of_lading_date": "<string>",
"waybill_number": 123,
"waybill_date": "<string>",
"paying_party": {
"name": "<string>",
"number": "<string>"
},
"commodity_code": "<string>",
"commodity_description": "<string>",
"origin": {
"name": "<string>",
"city": "<string>",
"state_or_province": "<string>"
},
"destination": {
"name": "<string>",
"city": "<string>",
"state_or_province": "<string>"
},
"billed_freight_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"billed_fuel_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"billed_misc_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_freight_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_fuel_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_misc_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"invoice_documents": [
{
"created_at": "<string>",
"edi_invoice": {
"send_date": "<string>",
"invoice_x12": "<string>"
},
"parsed_invoice": {
"type": "PDF_INVOICE",
"document_uuid": "<string>",
"lead_equipment_id": {
"initial": "<string>",
"number": "<string>"
},
"bill_of_lading_id": {
"identifier": "<string>",
"date": {
"year": 123,
"month": 123,
"day": 123
},
"type": "<string>"
},
"waybill_id": {
"number": 123,
"date": "<string>"
},
"freight_bill_number": "<string>",
"invoice_number": "<string>",
"billing_carrier": "<string>",
"billing_date": "<string>",
"total_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"payment_due_date": "<string>",
"paying_party": {
"name": "<string>",
"number": "<string>"
},
"equipment_ids": [
{
"initial": "<string>",
"number": "<string>"
}
],
"commodity_code": "<string>",
"commodity_description": "<string>",
"origin": {
"name": "<string>",
"city": "<string>",
"state_or_province": "<string>"
},
"destination": {
"name": "<string>",
"city": "<string>",
"state_or_province": "<string>"
},
"pdf_page_number": 123,
"freight_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"fuel_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"misc_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"quantity": 123,
"qualifier": "<string>"
}
}
],
"extended_references": [
{
"qualifier": "<string>",
"value": "<string>"
}
],
"voucher_id": "<string>",
"transportation_origin": {
"city": "<string>",
"state": "<string>"
},
"transportation_destination": {
"city": "<string>",
"state": "<string>"
},
"rule_11_origin": {
"city": "<string>",
"state": "<string>"
},
"rule_11_destination": {
"city": "<string>",
"state": "<string>"
}
}
],
"previous_token": "<string>",
"next_token": "<string>"
}Carrier ID - can be a numeric id or a string identifier
Filter invoices matching any of the specified audit statuses
PENDING_APPROVAL, APPROVED, REJECTED Filter invoices matching any of the voucher statuses
HAS_VOUCHER, NO_VOUCHER The requested page size
Was this page helpful?
curl --request GET \
--url https://api-lg-k.arms.cedarai.com/shipper/invoices \
--header 'Carrier: <carrier>' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>'{
"invoices": [
{
"id": "<string>",
"freight_bill_number": "<string>",
"invoice_number": "<string>",
"billing_carrier": "<string>",
"billing_date": "<string>",
"total_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"balance": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_amount_waybill_total": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_amount_this_carrier": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"payment_due_date": "<string>",
"audit_status": "PENDING_APPROVAL",
"audit_comments": "<string>",
"shipment_name": "<string>",
"equipment": [
{
"initial": "<string>",
"number": "<string>"
}
],
"bill_of_lading_identifier": "<string>",
"bill_of_lading_date": "<string>",
"waybill_number": 123,
"waybill_date": "<string>",
"paying_party": {
"name": "<string>",
"number": "<string>"
},
"commodity_code": "<string>",
"commodity_description": "<string>",
"origin": {
"name": "<string>",
"city": "<string>",
"state_or_province": "<string>"
},
"destination": {
"name": "<string>",
"city": "<string>",
"state_or_province": "<string>"
},
"billed_freight_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"billed_fuel_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"billed_misc_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_freight_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_fuel_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"accrual_misc_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"invoice_documents": [
{
"created_at": "<string>",
"edi_invoice": {
"send_date": "<string>",
"invoice_x12": "<string>"
},
"parsed_invoice": {
"type": "PDF_INVOICE",
"document_uuid": "<string>",
"lead_equipment_id": {
"initial": "<string>",
"number": "<string>"
},
"bill_of_lading_id": {
"identifier": "<string>",
"date": {
"year": 123,
"month": 123,
"day": 123
},
"type": "<string>"
},
"waybill_id": {
"number": 123,
"date": "<string>"
},
"freight_bill_number": "<string>",
"invoice_number": "<string>",
"billing_carrier": "<string>",
"billing_date": "<string>",
"total_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"payment_due_date": "<string>",
"paying_party": {
"name": "<string>",
"number": "<string>"
},
"equipment_ids": [
{
"initial": "<string>",
"number": "<string>"
}
],
"commodity_code": "<string>",
"commodity_description": "<string>",
"origin": {
"name": "<string>",
"city": "<string>",
"state_or_province": "<string>"
},
"destination": {
"name": "<string>",
"city": "<string>",
"state_or_province": "<string>"
},
"pdf_page_number": 123,
"freight_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"fuel_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"misc_amount": {
"currency": "<string>",
"dollars": "<string>",
"cents": 123
},
"quantity": 123,
"qualifier": "<string>"
}
}
],
"extended_references": [
{
"qualifier": "<string>",
"value": "<string>"
}
],
"voucher_id": "<string>",
"transportation_origin": {
"city": "<string>",
"state": "<string>"
},
"transportation_destination": {
"city": "<string>",
"state": "<string>"
},
"rule_11_origin": {
"city": "<string>",
"state": "<string>"
},
"rule_11_destination": {
"city": "<string>",
"state": "<string>"
}
}
],
"previous_token": "<string>",
"next_token": "<string>"
}