Errors and Warnings

Complex Filtering (GET Contracts)

Invalid data type supplied for field

400

Bad Request

The field name and provided value that caused the error are identified. Multiple errors may be included.

{
    "errors": [
        {
            "message": "V200: Validation Errors",
            "extensions": [
                {
                    "code": "contractFilter",
                    "messages": [
                        "The contractFilter field is required."
                    ]
                },
                {
                    "code": "contractFilterSet[0].activeContracts",
                    "messages": [
                        "Could not convert string to boolean: all. Path 'contractFilterSet[0].activeContracts', line 7, position 32."
                    ]
                },
                {
                    "code": "contractFilterSet[0].userDefinedFieldFilters[0].userDefinedFieldId",
                    "messages": [
                        "Could not convert string to integer: abc. Path 'contractFilterSet[0].userDefinedFieldFilters[0].userDefinedFieldId', line 11, position 37."
                    ]
                }
            ]
        }
    ]
}

Query String Filtering (eg; GET users, Get counterparties)

Invalid data type supplied for parameter

400

Bad Request

{
    "errors": [
        {
            "message": "V200: Validation Errors",
            "extensions": [
                {
                    "code": "id",
                    "messages": [
                        "The value 'john' is not valid."
                    ]
                },
                {
                    "code": "pageSize",
                    "messages": [
                        "The field must be null or greater than 0."
                    ]
                }
            ]
        }
    ]
}

IP Access Restriction

403

Forbidden

Attempted access from an IP Address outside of the restricted range / within denied access range.

{
  "code": "AR001",
  "message": "Invalid address range for [source ip]"
}

User is not authorized

403

Forbidden

The user context under which the API is logged in must have permission to the function within the specified business unit.

An unauthorized message may also be shown if the business unit Id provided does not exist.

{
    "errors": [
        {
            "message": "A010: Authorization Errors",
            "extensions": [
                {
                    "key": "A010",
                    "value": [
                        "No Business Unit was found matching Id 7 or you do not have permission"
                    ]
                }
            ]
        }
    ]
}

Validation errors occurred

400

Bad Request

Where the create/update supports the failOnWarnings flag, when set to true, warnings that can be overridden will be shown as errors, with the [Warning] prefix to the message.

{
    "errors": [
        {
            "message": "V200: Validation Errors",
            "extensions": [
                {
                    "code": "Contract",
                    "message": [
                        "[Warning]: One or more possible duplicates were found - Contract Id 2063: [Supplier Agreement with Acme Limited] [2024-05-10]"
                    ]
                }
            ]
        }
    ]
}

Validation warning occurred

Create or Update

201

Created

200

OK

Attempting to process the same record as above with the failOnWarnings flag set to false results in a successful create, with the warning returned in the Warnings array.

{
    "contractId": 2064,
    "warnings": [
        {
            "code": "Contract",
            "message": "One or more possible duplicates were found - Contract Id 2063: [Supplier Agreement with Acme Limited] [2024-05-10]"
        }
    ]
}