# Upwell Developer Docs ## Docs - [Carrier Payables Screen](https://docs.upwell.com/accounts-payable/carrier-invoice-audit.md): Learn how to manage and process carrier invoices using the payables screen - [Online Payments](https://docs.upwell.com/accounts-receivable/online-payments.md): Digital payment processing capabilities for freight brokers and logistics providers - [Accounts Receivable Management](https://docs.upwell.com/accounts-receivable/receivables.md): Streamline your freight billing and collections with Upwell's intelligent receivables management platform - [Payment Reminders](https://docs.upwell.com/accounts-receivable/reminders.md): Accelerate collections with Upwell's payment reminder system - [Remittances Management](https://docs.upwell.com/accounts-receivable/remittances.md): Automate payment application and reconciliation with Upwell's intelligent remittances platform - [Shipper Profiles](https://docs.upwell.com/accounts-receivable/shipper-profiles.md): Comprehensive customer management for freight brokers and logistics providers - [Create One Address](https://docs.upwell.com/api-reference/addresses/create-one-address.md): Create a new address - [Delete One Address](https://docs.upwell.com/api-reference/addresses/delete-one-address.md): Delete an address by ID - [Get Many Addresses](https://docs.upwell.com/api-reference/addresses/get-many-addresses.md): Query a list of addresses - [Get One Address](https://docs.upwell.com/api-reference/addresses/get-one-address.md): Get an address by ID - [Update One Address](https://docs.upwell.com/api-reference/addresses/update-one-address.md): Update an address by ID - [Create One Bill Line Item](https://docs.upwell.com/api-reference/bill-line-items/create-one-bill-line-item.md): Create a new bill line item - [Delete One Bill Line Item](https://docs.upwell.com/api-reference/bill-line-items/delete-one-bill-line-item.md): Delete an bill line item by ID - [Update One Bill Line Item](https://docs.upwell.com/api-reference/bill-line-items/update-one-bill-line-item.md): Update an bill line item by ID - [Create bill payment](https://docs.upwell.com/api-reference/bill-payments/create-bill-payment.md): Create a new bill payment record. - [Delete bill payment](https://docs.upwell.com/api-reference/bill-payments/delete-bill-payment.md): Delete a bill payment by its ID. - [Get bill payment](https://docs.upwell.com/api-reference/bill-payments/get-bill-payment.md): Retrieve a single bill payment by its ID. - [List bill payments](https://docs.upwell.com/api-reference/bill-payments/list-bill-payments.md): Retrieve a paginated list of bill payments with optional filtering and sorting. - [Search bill payments](https://docs.upwell.com/api-reference/bill-payments/search-bill-payments.md): Search for bill payments by source system and source system ID. - [Update bill payment](https://docs.upwell.com/api-reference/bill-payments/update-bill-payment.md): Update an existing bill payment by its ID. - [Create Many Bills](https://docs.upwell.com/api-reference/bills/create-many-bills.md): Create multiple bills at once - [Create One Bill](https://docs.upwell.com/api-reference/bills/create-one-bill.md): Create a new bill - [Delete One Bill](https://docs.upwell.com/api-reference/bills/delete-one-bill.md): Delete a bill by ID - [Get Many Bills](https://docs.upwell.com/api-reference/bills/get-many-bills.md): Query a list of bills - [Get One Bill](https://docs.upwell.com/api-reference/bills/get-one-bill.md): Get a bill by ID - [Search Bills](https://docs.upwell.com/api-reference/bills/search-bills.md): Advanced search for bills with complex filtering criteria - [Update One Bill](https://docs.upwell.com/api-reference/bills/update-one-bill.md): Update a bill by ID - [Get carrier invoice approval request](https://docs.upwell.com/api-reference/carrier-invoice-approval-requests/get-carrier-invoice-approval-request.md): Retrieve a single carrier invoice approval request by its ID. - [List carrier invoice approval requests](https://docs.upwell.com/api-reference/carrier-invoice-approval-requests/list-carrier-invoice-approval-requests.md): Retrieve a paginated list of carrier invoice approval requests with optional filtering and sorting. - [Update Carrier Invoice Approval Request](https://docs.upwell.com/api-reference/carrier-invoice-approval-requests/update-carrier-invoice-approval-request.md): Update a carrier invoice approval request status and response payload - [Create Carrier Invoice Document](https://docs.upwell.com/api-reference/carrier-invoice-documents/create-carrier-invoice-document.md): Create a new carrier invoice document - [Delete Carrier Invoice Document](https://docs.upwell.com/api-reference/carrier-invoice-documents/delete-carrier-invoice-document.md): Delete a carrier invoice document by ID - [Get Many Carrier Invoice Documents](https://docs.upwell.com/api-reference/carrier-invoice-documents/get-many-carrier-invoice-documents.md): Query a list of carrier invoice documents - [Approve One Carrier Invoice](https://docs.upwell.com/api-reference/carrier-invoices/approve-one-carrier-invoice.md): Approve a carrier invoice by ID - [Create Many Carrier Invoices](https://docs.upwell.com/api-reference/carrier-invoices/create-many-carrier-invoices.md): Create multiple carrier invoices at once - [Create One Carrier Invoice](https://docs.upwell.com/api-reference/carrier-invoices/create-one-carrier-invoice.md): Create a new carrier invoice - [Delete One Carrier Invoice](https://docs.upwell.com/api-reference/carrier-invoices/delete-one-carrier-invoice.md): Delete a carrier invoice by ID - [Get Many Carrier Invoices](https://docs.upwell.com/api-reference/carrier-invoices/get-many-carrier-invoices.md): Query a list of carrier invoices - [Get One Carrier Invoice](https://docs.upwell.com/api-reference/carrier-invoices/get-one-carrier-invoice.md): Get a carrier invoice by ID - [Update One Carrier Invoice](https://docs.upwell.com/api-reference/carrier-invoices/update-one-carrier-invoice.md): Update a carrier invoice by ID - [Create Many Carrier Payment Line Items](https://docs.upwell.com/api-reference/carrier-payment-line-items/create-many-carrier-payment-line-items.md): Create multiple carrier payment line items at once - [Create One Carrier Payment Line Item](https://docs.upwell.com/api-reference/carrier-payment-line-items/create-one-carrier-payment-line-item.md): Create a new carrier payment line item - [Delete One Carrier Payment Line Item](https://docs.upwell.com/api-reference/carrier-payment-line-items/delete-one-carrier-payment-line-item.md): Delete a carrier payment line item by ID - [Get Many Carrier Payment Line Items](https://docs.upwell.com/api-reference/carrier-payment-line-items/get-many-carrier-payment-line-items.md): Query a list of carrier payment line items - [Get One Carrier Payment Line Item](https://docs.upwell.com/api-reference/carrier-payment-line-items/get-one-carrier-payment-line-item.md): Get a carrier payment line item by ID - [Update One Carrier Payment Line Item](https://docs.upwell.com/api-reference/carrier-payment-line-items/update-one-carrier-payment-line-item.md): Update a carrier payment line item by ID - [Create Many Carriers](https://docs.upwell.com/api-reference/carriers/create-many-carriers.md): Create multiple carriers at once - [Create One Carrier](https://docs.upwell.com/api-reference/carriers/create-one-carrier.md): Create a new carrier - [Delete One Carrier](https://docs.upwell.com/api-reference/carriers/delete-one-carrier.md): Delete a carrier by ID - [Delete One Carrier By Source System Id](https://docs.upwell.com/api-reference/carriers/delete-one-carrier-by-source-system-id.md): Delete a carrier by source system id - [Get Many Carriers](https://docs.upwell.com/api-reference/carriers/get-many-carriers.md): Query a list of carriers - [Get One Carrier](https://docs.upwell.com/api-reference/carriers/get-one-carrier.md): Get a carrier by ID - [Search Carriers](https://docs.upwell.com/api-reference/carriers/search-carriers.md): Search for carriers based on specified criteria - [Update One Carrier](https://docs.upwell.com/api-reference/carriers/update-one-carrier.md): Update a carrier by ID - [Update One Carrier By Source System Id](https://docs.upwell.com/api-reference/carriers/update-one-carrier-by-source-system-id.md): Update a carrier by source system id - [Create company](https://docs.upwell.com/api-reference/companies/create-company.md): Create a new company record. - [Delete company](https://docs.upwell.com/api-reference/companies/delete-company.md): Delete a company by its ID. - [Get company](https://docs.upwell.com/api-reference/companies/get-company.md): Retrieve a single company by its ID. - [List companies](https://docs.upwell.com/api-reference/companies/list-companies.md): Retrieve a paginated list of companies with optional filtering and sorting. - [Update company](https://docs.upwell.com/api-reference/companies/update-company.md): Update an existing company by its ID. - [Create Many Customer Payment Line Items](https://docs.upwell.com/api-reference/customer-payment-line-items/create-many-customer-payment-line-items.md): Create multiple customer payment line items at once - [Create One Customer Payment Line Item](https://docs.upwell.com/api-reference/customer-payment-line-items/create-one-customer-payment-line-item.md): Create a new customer payment line item - [Delete One Customer Payment Line Item](https://docs.upwell.com/api-reference/customer-payment-line-items/delete-one-customer-payment-line-item.md): Delete a specific customer payment line item - [Get Many Customer Payment Line Items](https://docs.upwell.com/api-reference/customer-payment-line-items/get-many-customer-payment-line-items.md): Retrieve a list of customer payment line items - [Get One Customer Payment Line Item](https://docs.upwell.com/api-reference/customer-payment-line-items/get-one-customer-payment-line-item.md): Retrieve details of a specific customer payment line item - [Search Customer Payment Line Items](https://docs.upwell.com/api-reference/customer-payment-line-items/search-customer-payment-line-items.md): Search for customer payment line items based on specified criteria - [Update One Customer Payment Line Item](https://docs.upwell.com/api-reference/customer-payment-line-items/update-one-customer-payment-line-item.md): Update details of a specific customer payment line item - [Create Many Customer Payments](https://docs.upwell.com/api-reference/customer-payments/create-many-customer-payments.md): Create multiple customer payments at once - [Create One Customer Payment](https://docs.upwell.com/api-reference/customer-payments/create-one-customer-payment.md): Create a new customer payment - [Delete One Customer Payment](https://docs.upwell.com/api-reference/customer-payments/delete-one-customer-payment.md): Delete a specific customer payment - [Get Many Customer Payments](https://docs.upwell.com/api-reference/customer-payments/get-many-customer-payments.md): Retrieve a list of customer payments - [Get One Customer Payment](https://docs.upwell.com/api-reference/customer-payments/get-one-customer-payment.md): Retrieve details of a specific customer payment - [Search Customer Payments](https://docs.upwell.com/api-reference/customer-payments/search-customer-payments.md): Search for customer payments based on specified criteria - [Update One Customer Payment](https://docs.upwell.com/api-reference/customer-payments/update-one-customer-payment.md): Update details of a specific customer payment - [Create Many Customers](https://docs.upwell.com/api-reference/customers/create-many-customers.md): Create multiple customers at once - [Create One Customer](https://docs.upwell.com/api-reference/customers/create-one-customer.md): Create a new customer - [Delete One Customer](https://docs.upwell.com/api-reference/customers/delete-one-customer.md): Delete a customer by ID - [Delete One Customer By Source System Id](https://docs.upwell.com/api-reference/customers/delete-one-customer-by-source-system-id.md): Delete a customer by source system id - [Get Many Customers](https://docs.upwell.com/api-reference/customers/get-many-customers.md): Query a list of customers - [Get One Customer](https://docs.upwell.com/api-reference/customers/get-one-customer.md): Get a customer by ID - [Search Customers](https://docs.upwell.com/api-reference/customers/search-customers.md): Search for customers based on specified criteria - [Update One Customer](https://docs.upwell.com/api-reference/customers/update-one-customer.md): Update a customer by ID - [Update One Customer By Source System Id](https://docs.upwell.com/api-reference/customers/update-one-customer-by-source-system-id.md): Update a customer by source system id - [Create One Document Reference Specification](https://docs.upwell.com/api-reference/document-reference-specifications/create-one-document-reference-specification.md): Create a new document reference specification - [Delete One Document Reference Specification](https://docs.upwell.com/api-reference/document-reference-specifications/delete-one-document-reference-specification.md): Delete a document reference specification by ID - [Get Many Document Reference Specifications](https://docs.upwell.com/api-reference/document-reference-specifications/get-many-document-reference-specifications.md): Query a list of document reference specifications - [Get One Document Reference Specification](https://docs.upwell.com/api-reference/document-reference-specifications/get-one-document-reference-specification.md): Get a document reference specification by ID - [Update One Document Reference Specification](https://docs.upwell.com/api-reference/document-reference-specifications/update-one-document-reference-specification.md): Update a document reference specification by ID - [Generate Upload Presigned Url](https://docs.upwell.com/api-reference/documents/generate-upload-presigned-url.md): Generate a presigned URL for direct S3 file upload - [Update One Document](https://docs.upwell.com/api-reference/documents/update-one-document.md): Update a document by ID - [Approve customer invoice](https://docs.upwell.com/api-reference/invoice-approval/approve-customer-invoice.md): Approve a customer invoice for sending. If the invoice has open exceptions, approval will fail unless overrideExceptions=true is passed, which will close all open exceptions and approve the invoice. - [List invoices ready for approval](https://docs.upwell.com/api-reference/invoice-approval/list-invoices-ready-for-approval.md): Retrieve a paginated list of customer invoices that are ready for approval. Returns invoices in CREATED status with approvedToSend=false and no open exceptions. - [Create Invoice Document](https://docs.upwell.com/api-reference/invoice-documents/create-invoice-document.md): Create a new invoice document - [Delete Invoice Document](https://docs.upwell.com/api-reference/invoice-documents/delete-invoice-document.md): Delete an invoice document by ID - [Get Many Invoice Documents](https://docs.upwell.com/api-reference/invoice-documents/get-many-invoice-documents.md): Query a list of invoice documents - [Create One Invoice Line Item](https://docs.upwell.com/api-reference/invoice-line-items/create-one-invoice-line-item.md): Create a new invoice line item - [Delete One Invoice Line Item](https://docs.upwell.com/api-reference/invoice-line-items/delete-one-invoice-line-item.md): Delete an invoice line item by ID - [Update One Invoice Line Item](https://docs.upwell.com/api-reference/invoice-line-items/update-one-invoice-line-item.md): Update an invoice line item by ID - [Link invoice to shipment](https://docs.upwell.com/api-reference/invoice-shipments/link-invoice-to-shipment.md): Create an association between an invoice and a shipment. - [Unlink invoice from shipment](https://docs.upwell.com/api-reference/invoice-shipments/unlink-invoice-from-shipment.md): Remove the association between an invoice and a shipment. - [Create One Invoice](https://docs.upwell.com/api-reference/invoices/create-one-invoice.md): Create a new invoice - [Delete One Invoice](https://docs.upwell.com/api-reference/invoices/delete-one-invoice.md): Delete an invoice by ID - [Delete One Invoice By Source System Id](https://docs.upwell.com/api-reference/invoices/delete-one-invoice-by-source-system-id.md): Delete an invoice by source system id - [Get Many Invoices](https://docs.upwell.com/api-reference/invoices/get-many-invoices.md): Query a list of invoices - [Get One Invoice](https://docs.upwell.com/api-reference/invoices/get-one-invoice.md): Get an invoice by ID - [Search Invoices](https://docs.upwell.com/api-reference/invoices/search-invoices.md): Search for invoices by source system and source system ID - [Update One Invoice](https://docs.upwell.com/api-reference/invoices/update-one-invoice.md): Update an invoice by ID - [Update One Invoice By Source System Id](https://docs.upwell.com/api-reference/invoices/update-one-invoice-by-source-system-id.md): Update an invoice by source system id - [Create One Rule](https://docs.upwell.com/api-reference/rules/create-one-rule.md): Create a new rule - [Delete One Rule](https://docs.upwell.com/api-reference/rules/delete-one-rule.md): Delete a rule by ID - [Get Many Rules](https://docs.upwell.com/api-reference/rules/get-many-rules.md): Query a list of rules - [Get One Rule](https://docs.upwell.com/api-reference/rules/get-one-rule.md): Get a rule by ID - [Update One Rule](https://docs.upwell.com/api-reference/rules/update-one-rule.md): Update a rule by ID - [Create Shipment Document](https://docs.upwell.com/api-reference/shipment-documents/create-shipment-document.md): Create a new shipment document - [Delete Shipment Document](https://docs.upwell.com/api-reference/shipment-documents/delete-shipment-document.md): Delete a shipment document by ID - [Get Many Shipment Documents](https://docs.upwell.com/api-reference/shipment-documents/get-many-shipment-documents.md): Query a list of shipment documents - [Create One Shipment Line Item](https://docs.upwell.com/api-reference/shipment-line-items/create-one-shipment-line-item.md): Create a new shipment line item - [Delete One Shipment Line Item](https://docs.upwell.com/api-reference/shipment-line-items/delete-one-shipment-line-item.md): Delete a shipment line item by ID - [Get One Shipment Line Item](https://docs.upwell.com/api-reference/shipment-line-items/get-one-shipment-line-item.md): Get a shipment line item by ID - [Search Shipment Line Items](https://docs.upwell.com/api-reference/shipment-line-items/search-shipment-line-items.md): Search for shipment line items by source system and source system ID - [Update One Shipment Line Item](https://docs.upwell.com/api-reference/shipment-line-items/update-one-shipment-line-item.md): Update a shipment line item by ID - [Create One Shipment](https://docs.upwell.com/api-reference/shipments/create-one-shipment.md): Create a new shipment - [Delete One Shipment](https://docs.upwell.com/api-reference/shipments/delete-one-shipment.md): Delete a shipment by ID - [Delete One Shipment By Source System Id](https://docs.upwell.com/api-reference/shipments/delete-one-shipment-by-source-system-id.md): Delete a shipment by source system id - [Get Many Shipments](https://docs.upwell.com/api-reference/shipments/get-many-shipments.md): Query a list of shipments - [Get One Shipment](https://docs.upwell.com/api-reference/shipments/get-one-shipment.md): Get a shipment by ID - [Search Shipments](https://docs.upwell.com/api-reference/shipments/search-shipments.md): Search for shipments based on specified criteria - [Update One Shipment](https://docs.upwell.com/api-reference/shipments/update-one-shipment.md): Update a shipment by ID - [Update One Shipment By Source System Id](https://docs.upwell.com/api-reference/shipments/update-one-shipment-by-source-system-id.md): Update a shipment by source system id - [Create One Stop](https://docs.upwell.com/api-reference/stops/create-one-stop.md): Create a new stop - [Delete One Stop](https://docs.upwell.com/api-reference/stops/delete-one-stop.md): Delete a stop by ID - [Get Many Stops](https://docs.upwell.com/api-reference/stops/get-many-stops.md): Query a list of stops - [Get One Stop](https://docs.upwell.com/api-reference/stops/get-one-stop.md): Get a stop by ID - [Update One Stop](https://docs.upwell.com/api-reference/stops/update-one-stop.md): Update a stop by ID - [Create One Vendor](https://docs.upwell.com/api-reference/vendors/create-one-vendor.md): Create a new vendor - [Delete One Vendor](https://docs.upwell.com/api-reference/vendors/delete-one-vendor.md): Delete a vendor by ID - [Get One Vendor](https://docs.upwell.com/api-reference/vendors/get-one-vendor.md): Get a vendor by ID - [Search Vendors](https://docs.upwell.com/api-reference/vendors/search-vendors.md): Search for vendors based on Source System and Source System ID - [Update One Vendor](https://docs.upwell.com/api-reference/vendors/update-one-vendor.md): Update a vendor by ID - [Handle carrier invoice events](https://docs.upwell.com/api-reference/webhooks/handle-carrier-invoice-events.md): Triggered when a carrier invoice record is created, updated, or deleted - [Handle carrier invoice shipment creation events](https://docs.upwell.com/api-reference/webhooks/handle-carrier-invoice-shipment-creation-events.md): Triggered when a carrier invoice is linked to a newly created shipment - [Handle carrier invoice shipment update events](https://docs.upwell.com/api-reference/webhooks/handle-carrier-invoice-shipment-update-events.md): Triggered when a carrier invoice's shipment information is updated - [Handle carrier invoice status approved events](https://docs.upwell.com/api-reference/webhooks/handle-carrier-invoice-status-approved-events.md): Triggered when the `status` of a carrier invoice record is updated to `approved`. - [Handle carrier invoice status portal exception events](https://docs.upwell.com/api-reference/webhooks/handle-carrier-invoice-status-portal-exception-events.md): Triggered when the `status` of a carrier invoice record is updated to `portal_exception`. - [Handle invoice status portal exception events](https://docs.upwell.com/api-reference/webhooks/handle-invoice-status-portal-exception-events.md): Triggered when the `status` of an invoice record is updated to `portal_exception`. - [Handle invoice status sent events](https://docs.upwell.com/api-reference/webhooks/handle-invoice-status-sent-events.md): Triggered when the `status` of an invoice record is updated to `sent`. - [Handle payments events](https://docs.upwell.com/api-reference/webhooks/handle-payments-events.md): Triggered when a payments record is created, updated, or deleted. - [Handle shipment documents events](https://docs.upwell.com/api-reference/webhooks/handle-shipment-documents-events.md): Triggered when a shipment document file associations record is created, updated, or deleted. - [Handles invoice events](https://docs.upwell.com/api-reference/webhooks/handles-invoice-events.md): Triggered when an invoice record is created, updated, or deleted. - [Handles remittance events](https://docs.upwell.com/api-reference/webhooks/handles-remittance-events.md): Triggered when a remittance record is created, updated, or deleted. - [Authentication](https://docs.upwell.com/authentication.md): Learn how to authenticate your requests to the Upwell API - [Welcome to Upwell](https://docs.upwell.com/introduction.md): Streamline your logistics accounts payable and receivable processes with our intelligent automation platform - [Quickstart](https://docs.upwell.com/quickstart.md): Get started with Upwell in 5 simple steps - [Troubleshooting Guide](https://docs.upwell.com/troubleshooting.md): Common issues and solutions for using the Upwell platform - [Dashboard Overview](https://docs.upwell.com/user-interface/dashboard-overview.md): Understand the Upwell dashboard interface and its key components - [Navigation Guide](https://docs.upwell.com/user-interface/navigation-guide.md): Understanding the Upwell dashboard navigation and main sections ## OpenAPI Specs - [openapi](https://docs.upwell.com/api-reference/openapi.json)