Carrier Payment Line Items
Vendors
Invoice Line Items
Carrier Invoices
Carrier Invoice Documents
Addresses
Carriers
Bill Line Items
Customer Payments
Bills
Customer Payment Line Items
Invoice Shipments
Invoices
Customers
Carrier Invoice Approval Requests
Shipments
Shipment Documents
Bill Payments
Webhooks
- HOOKHandle carrier invoice events
- HOOKHandle carrier invoice status approved events
- HOOKHandle carrier invoice status portal exception events
- HOOKHandle carrier invoice shipment creation events
- HOOKHandle carrier invoice shipment update events
- HOOKHandle payments events
- HOOKHandles invoice events
- HOOKHandle invoice status portal exception events
- HOOKHandle invoice status sent events
- HOOKHandles remittance events
- HOOKHandle shipment documents events
Create One Rule
Copy
Ask AI
curl --request POST \
--url https://api.upwell.com/api/rest/rules \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"actionType": "CREATE_EXCEPTION",
"actionValue": "<unknown>",
"createdAt": "<unknown>",
"criteriaField": "<string>",
"criteriaObject": "EMAIL_MESSAGE",
"criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
"criteriaValue": "<string>",
"customerId": "<string>",
"enabled": true,
"exceptionConfig": "<unknown>",
"exceptionType": "CARRIER_INVOICE_BOL_PO_NUMBER_MISMATCH",
"id": "<string>",
"priority": 123,
"ruleActionType": {},
"ruleType": {},
"type": "CARRIER_INVOICE_EXCEPTION",
"updatedAt": "<unknown>"
}
}
'Copy
Ask AI
{
"createRule": {
"actionType": "CREATE_EXCEPTION",
"actionValue": "<unknown>",
"createdAt": "<unknown>",
"criteriaField": "<string>",
"criteriaObject": "EMAIL_MESSAGE",
"criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
"criteriaValue": "<string>",
"customerId": "<string>",
"id": "<string>",
"priority": 123,
"type": "CARRIER_INVOICE_EXCEPTION",
"updatedAt": "<unknown>"
}
}Rules
Create One Rule
Create a new rule
POST
/
api
/
rest
/
rules
Create One Rule
Copy
Ask AI
curl --request POST \
--url https://api.upwell.com/api/rest/rules \
--header 'Content-Type: application/json' \
--data '
{
"input": {
"actionType": "CREATE_EXCEPTION",
"actionValue": "<unknown>",
"createdAt": "<unknown>",
"criteriaField": "<string>",
"criteriaObject": "EMAIL_MESSAGE",
"criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
"criteriaValue": "<string>",
"customerId": "<string>",
"enabled": true,
"exceptionConfig": "<unknown>",
"exceptionType": "CARRIER_INVOICE_BOL_PO_NUMBER_MISMATCH",
"id": "<string>",
"priority": 123,
"ruleActionType": {},
"ruleType": {},
"type": "CARRIER_INVOICE_EXCEPTION",
"updatedAt": "<unknown>"
}
}
'Copy
Ask AI
{
"createRule": {
"actionType": "CREATE_EXCEPTION",
"actionValue": "<unknown>",
"createdAt": "<unknown>",
"criteriaField": "<string>",
"criteriaObject": "EMAIL_MESSAGE",
"criteriaOperator": "ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY",
"criteriaValue": "<string>",
"customerId": "<string>",
"id": "<string>",
"priority": 123,
"type": "CARRIER_INVOICE_EXCEPTION",
"updatedAt": "<unknown>"
}
}Headers
Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY
Body
application/json
Query parameters can also be provided in the request body as a JSON object
input type for inserting data into table "rules"
Show child attributes
Show child attributes
Available options:
CREATE_EXCEPTION, EXEMPT_FROM_DOCUMENT_REQUIREMENTS, MATCH_FIELDS_ACROSS_DOCUMENTS, REQUIRE_DOCUMENT_SET, REQUIRE_SIGNATURE_IN_LOCATION, REQUIRE_STAMP_FROM_ENTITY, SET_CUSTOMER_BY_CASS_ID, SET_CUSTOMER_BY_CUSTOMER_NAME, SET_REQUIRED_DOCUMENTS, VALIDATE_DOCUMENT_CONTENT, VALIDATE_LOCATION_CRITERIA, VALIDATE_REFERENCE_NUMBER Available options:
EMAIL_MESSAGE, PARSED_INVOICE Available options:
ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY, ARRAY_HAS_OBJECT_WITH_PROPERTY, CONTAINED_IN, CONTAINS, EQ, GT, GTE, HAS_KEY, HAS_KEYS_ALL, HAS_KEYS_ANY, ILIKE, IN, IREGEX, IS_NULL, LIKE, LT, LTE, NEQ, NILIKE, NIN, NLIKE, NREGEX, NSIMILAR, REGEX, SIMILAR Available options:
CARRIER_INVOICE_BOL_PO_NUMBER_MISMATCH, CARRIER_INVOICE_HAS_LUMPER_LINE_ITEM_AND_NO_LUMPER_RECEIPT, CARRIER_INVOICE_MISSING, CARRIER_INVOICE_MISSING_ISSUE_DATE, CARRIER_INVOICE_MISSING_POD, CARRIER_INVOICE_MISSING_POD_FOR_EACH_DELIVERY_STOP, CARRIER_INVOICE_TOTAL_AMOUNT_BILL_TOTAL_AMOUNT_MISMATCH, CARRIER_INVOICE_TOTAL_AMOUNT_MISMATCH, CARRIER_INVOICE_TOTAL_AMOUNT_MISMATCH_BILL_OR_SHIPMENT, CARRIER_INVOICE_TOTAL_AMOUNT_SHIPMENT_CARRIER_TOTAL_RATE_MISMATCH, CARRIER_NAME_MISMATCH, CARRIER_NAME_MISMATCH_BILL_OR_SHIPMENT, CARRIER_NAME_MISMATCH_WITH_ASSIGNED_CARRIER, CARRIER_NAME_MISMATCH_WITH_BILL, CARRIER_NAME_MISMATCH_WITH_SHIPMENT, DAMAGE_OR_SHORTAGE, DOCUMENT_CONTENT_VALIDATION_EXCEPTION, DOCUMENT_LOAD_NUMBER_MISMATCH, INVOICE_AMOUNT_MISMATCH, LOCATION_RULE_VIOLATION_EXCEPTION, MATCHING_INVOICE_NOT_FOUND, MULTIPLE_MATCHING_INVOICES_FOUND, MULTI_DOCUMENT_SET_INCOMPLETE_EXCEPTION, NO_ASSIGNED_CARRIER, NO_CARRIER_NAME, NO_MATCHING_SHIPMENT, OVERPAYMENT, REFERENCE_NUMBER_MISMATCH_EXCEPTION, REFERENCE_NUMBER_MISSING_EXCEPTION, REMITTANCE_LINE_ITEMS_EXCEPTION, REMIT_TO_MISMATCH, SHIPPER_INVOICE_DOCUMENT_RULES_EXCEPTION, SHIPPER_RULE_AI_REVIEW_REQUIRED, SIGNATURE_VALIDATION_EXCEPTION, STAMP_VALIDATION_EXCEPTION, UNDERPAYMENT RuleActionTypeObjRelInsertInput (simplified)
RuleTypeObjRelInsertInput (simplified)
Available options:
CARRIER_INVOICE_EXCEPTION, DOCUMENT_BASIC, DOCUMENT_CONTENT_VALIDATION, DOCUMENT_CUSTOM, LOCATION_BASED_RULE, MULTI_DOCUMENT_SET, NO_DOCUMENTS_REQUIRED, ON_CREATION_FROM_EMAIL, REFERENCE_NUMBER, REFERENCE_NUMBER_MATCHING, REFERENCE_NUMBER_REQUIRED, SIGNATURE_REQUIRED, STAMP_REQUIRED Response
200 - application/json
Responses for POST /api/rest/rules
Rules used for matching, document requirements, etc
Show child attributes
Show child attributes
Available options:
CREATE_EXCEPTION, EXEMPT_FROM_DOCUMENT_REQUIREMENTS, MATCH_FIELDS_ACROSS_DOCUMENTS, REQUIRE_DOCUMENT_SET, REQUIRE_SIGNATURE_IN_LOCATION, REQUIRE_STAMP_FROM_ENTITY, SET_CUSTOMER_BY_CASS_ID, SET_CUSTOMER_BY_CUSTOMER_NAME, SET_REQUIRED_DOCUMENTS, VALIDATE_DOCUMENT_CONTENT, VALIDATE_LOCATION_CRITERIA, VALIDATE_REFERENCE_NUMBER Available options:
EMAIL_MESSAGE, PARSED_INVOICE Available options:
ARRAY_DOES_NOT_HAVE_OBJECT_WITH_PROPERTY, ARRAY_HAS_OBJECT_WITH_PROPERTY, CONTAINED_IN, CONTAINS, EQ, GT, GTE, HAS_KEY, HAS_KEYS_ALL, HAS_KEYS_ANY, ILIKE, IN, IREGEX, IS_NULL, LIKE, LT, LTE, NEQ, NILIKE, NIN, NLIKE, NREGEX, NSIMILAR, REGEX, SIMILAR Available options:
CARRIER_INVOICE_EXCEPTION, DOCUMENT_BASIC, DOCUMENT_CONTENT_VALIDATION, DOCUMENT_CUSTOM, LOCATION_BASED_RULE, MULTI_DOCUMENT_SET, NO_DOCUMENTS_REQUIRED, ON_CREATION_FROM_EMAIL, REFERENCE_NUMBER, REFERENCE_NUMBER_MATCHING, REFERENCE_NUMBER_REQUIRED, SIGNATURE_REQUIRED, STAMP_REQUIRED āI