Error Messages

These are the potential error messages that can be returned by the Public API. '%n' are text substitutions for fields names, values and embedded error messages.

Card Payment

Code	Message
CardSettleMandatory	CardSettle must be set to Y.
InvalidCardResult	Card Result '%1' is not a known response from %2.
InvalidCardTransType	CardTransType must be A.
InvalidExpiryDate	This needs to be a month in the format mmyy.

Customer Associate

Code	Message
ContactCategoriesBlank	One or more categories is blank.
ContactCategoryUnique	Only one customer contact can have the category %1.
CustomerNotActive	Contacts cannot be %1 for inactive customers.
CustomerTypeDeposit	Contacts cannot be %1 for customers with a type of Deposit.
DetailsNotMatched	Contact details did not match.
EmailRequired	%1 This requires an e-mail address to be entered.
Invalid	%1
TaskReviewCycle	This contact cannot be deleted as it has a task review cycle associated with it.
UniqueUsername	This user name has already been used by a customer login.

General

Code	Message
Alphanumeric	%1 must be alphanumeric.
AlreadyExists	%1 already exists.
AuthSchemeNotFound	Authorisation scheme not found.
Custom	%1
DateDaysPast	%1 cannot be more than %2 days in the past.
DateTime	%1 is not a valid date and time.
DateToday	%1 cannot be before today.
DeleteError	%1 could not be deleted.
DeleteErrorReason	%1 could not be deleted for the following reason. %2
EmptyBody	Request did not contain a body.
Exists	%1 does not exist.
Forbidden	Forbidden.
ForbiddenProperty	Request contained a forbidden property (%1).
InvalidAccessKey	Access key %1.
InvalidAuthFormat	Invalid format of authorisation header.
InvalidChars	The %1 cannot include the following characters: %2.
InvalidCredentials	Invalid username or password.
InvalidDate	%1 is not a valid date.
InvalidServer	Invalid server.
JsonPatchExceededArray	Patch '%1' operation on path '%2' is past end of existing array.
JsonPatchForbiddenResource	Patch '%1' operation on resource %2 is not allowed.
JsonPatchInvalidChars	%1 contains invalid characters.
JsonPatchInvalidOp	Patch operation op '%1' is invalid.
JsonPatchInvalidPath	Patch '%1' operation has invalid path '%2' specified.
JsonPatchMissingOp	Patch operation is missing.
JsonPatchMissingPath	Patch '%1' operation has no path specified.
JsonPatchPathNotFound	Patch '%1' operation on path '%2' not found in resource.
MaxLength	The maximum length for %1 is %2 characters.
MaxLines	The maximum number of lines for %1 is %2.
MaxValue	The maximum value for %1 is %2.
MinLength	The minimum length for %1 is %2 characters.
ModifiedOnServer	This %1 resource has been modified on server.
NotActive	%1 is not active.
NotFound	%1 was not found.
NotSupported	%1 is not supported.
PositiveInteger	%1 must be a positive integer.
PositiveNumber	%1 must be a positive number.
PositiveNumberDecs	%1 must be a positive number formatted to %2 decimal places.
ReadOnly	%1 is read only.
RecordInuse	This %1 resource is currently in use.
Required	%1 is required.
RequiredProperty	Request did not contain a required property (%1).
SaveError	%1 could not be saved. %2.
TaskReasonNotForCategory	Task Reason %1 is not applicable for Task Category %2.
TimeHHMM	%1 must be in the format HH:MM.
Unique	The %1 must be unique.
Unlicensed	The system does not have the correct license for this endpoint.
UnparsableJSON	The request content was unparsable as JSON.

Common

Code	Message
InvalidEmail	'%1' is not a valid e-mail address.
InvalidInput	%1 must be %2.
InvalidPostCode	%1
InvalidTimeStamp	Invalid timestamp format.
ObjMatchPath	The %1 object does not match the path.
UIDFormat	UID can only contain numeric characters.
Unavailable	%1 is unavailable.

Customer

Code	Message
AccountManagerMismatch	The account manager for a child account must match the account manager for the parent account.
AccountTypeInvalid	Account Type: %1 is invalid.
AddressConfiguration	The system is configured to not allow %1.
ChildParent	The parent account number cannot be that of a child account.
ContGrouping	Grouping %1: %2
DefaultPricingRestriction	The default pricing method cannot be set to either of the 'Matrix Pricing' pricing methods as discretionary margin pricing is enabled in order entry.
DeliveryPoint	DeliveryPoint must be Y or N.
DepotRestriction	Restrictions have been defined against the selected customer type that mean the depot for the customer is restricted to the following depot codes : %1.
DetailsNotMatched	Customer details did not match.
Invalid	%1
InvalidChildField	%1 is an invalid child field.
InvalidRDCO	The RDCO number must be 8 numeric characters or 8 characters followed by a space followed by 5 characters.
InvalidSalesRepForDepot	The sales rep %1 does not exist in the list for depot %2.
InvalidType	Only the following default system type can be used: %1. Other user defined customer types can be used. Please contact a System Administrator.
InvalidVATNumber	%1
NoValidCountyROM1	No valid county found from Address for ROM1 reporting.
ParentNotDeposit	The parent account cannot be a deposit type account.
PrefCommValues	%1 must be one of the following values: %2.
Save	%1
UnpricedTickets	Tickets cannot be unpriced for %1 customers.
VATNumberRequired	A VAT number is required %1.

Day Time Window

Code	Message
InvalidDay	Not a valid day.
MaxTimeWindows	A maximum number of time window entries allowed is 3.
Overlap	One or more delivery times overlap.

Order

Code	Message
AddressConfiguration	The system is configured to not allow %1.
DepotClosed	The order depot has been marked as closed.
DepotCompany	The order depot must belong to the same company as that of the customer.
DepotInterCompany	Inter company orders cannot be placed via Codas API.
HowCreated	How created must be set to %1.
Invalid	%1 is invalid
InvalidDeliveryType	Delivery type must be ND.
InvalidLatestDeliveryDate	Latest delivery date cannot be before intended delivery date.
InvalidOrderNumber	The customer order number cannot be set to Y.
Load	This order is on a load and cannot be updated.
NoValidCountyROM1	No valid county found from Address for ROM1 reporting.
Status	This order has a status which prevents it from being updated.
SuspenseDepot	The order depot cannot be a suspense depot.
WindowDayOverlap	The delivery days overlap other delivery days.

Order Line

Code	Message
MaxMargin	The unit price entered must be reduced to %1 based on the market movements. If you think this is incorrect please contact your supplier contact.

Payment

Code	Message
AdHocCardPayment	Ad hoc Payments cannot be entered for Card Payment types.
BatchTypeMismatch	The type does not match the payment type of the batch.
CompanyMismatch	The company of the batch does not match the company of the customer.
CurrencyRateInvalid	Currency rate cannot be defined for local currency customers.
CustomerFinishDated	Payments cannot be entered for customers who are finish dated.
CustomerNotActive	Payments cannot be entered for customers who are not active.
CustomerNotUpdateLedger	Payments cannot be entered for customers whose customer type is set to not update the ledger.
DIEProductsUndefined	The debit and credit realised DIE product codes must be defined before a payment can be made for a foreign currency customer.
ForeignCurrencyCustomer	Payments cannot be entered for foreign currency customers.
ForeignCurrencyCustomerNoCompany	Payments cannot be entered for foreign currency customers with no company defined.
ForeignCurrencyNominalControlNotSetup	The nominal control account for 'Sales Ledger Realised DIE', for currency %1, must be set up before a payment can be made.
ForeignCurrencyPaymentType	This type is not allowed for a foreign currency customer.
ForeignValueNotEqual	Foreign currency payment value must equal the payment value multiplied by the currency rate.
FuturePaymentDate	The payment date cannot be in the future.
HowCreated	How created code %1 is forbidden.
IncorrectCardSystem	CardSystem must be %1.
InvalidCurrencyRate	%1
InvalidCustomerDebtorStatus	The customer debtor status %1 prevents entry of payments.
InvalidField	%1 is only allowed for %2.
InvalidValue	Payment line value must be a non-zero integer.
InvalidValueMustEqual	Payment value must equal the total of payment line values.
NotForeignCurrencyCustomer	Foreign currency payment value cannot be defined for local currency customers.
TypeMismatch	The payment type must have a master type of '%1'.

Payment Line

Code	Message
AllocatedExceedsOutstanding	The value allocated to transaction reference %1 cannot exceed the outstanding amount.
AllocatedMustBeNotNegative	The value allocated to transaction reference %1 cannot be less than zero.
AllocatedMustEqualOutstanding	The value allocated to transaction reference %1 must equal the outstanding amount.
ForeignValueEqual	Foreign currency payment line value must equal the payment line value multiplied by the currency rate.
InvalidForeignValue	Foreign currency payment line value must be a non-zero integer.
NoOutstandingValue	Transaction reference %1 has no outstanding value to allocate.
TransactionAllocated	Transaction reference %1 has already been allocated.
TransactionOnHold	Transaction reference %1 is on hold.
TransactionReferenceUsed	Transaction reference %1 has been used multiple times.

Product

Code	Message
DispactDepotUnavailable	Product %1 is an %2 product which cannot be selected for this Dispatch Depot.
NotForSale	Product %1 is not for sale.
NotPermittedForDepot	Product %1 is not permitted at the dispatch depot.
NotPermittedForMarket	Product %1 is not permitted by the customer's market.
Surcharge	Product %1 is defined as a surcharge product, for card surcharges on orders, against a VAT rate.
SurchargeDefault	Product %1 is the default product code for card surcharges on orders.

Prospect

Code	Message
AddressConfiguration	The system is configured to not allow %1.
ContactGrouping	The system is configured to not allow %1 for %2.
Custom	%1: %2.
DetailsNotMatched	Prospect details did not match.
Invalid	%1.
NotFound	%1: '%2' was not found.

Quote

Code	Message
AddressConfiguration	The system is configured to not allow %1.
DepotClosed	The Quote depot has been marked as closed.
DepotCompany	The Quote depot must belong to the same company as that of the customer.
DepotInterCompany	Inter company Quotes cannot be placed via Codas API.
HowCreated	How created must be set to %1.
Invalid	%1 is invalid
InvalidDeliveryType	Delivery type must be ND.
InvalidLatestDeliveryDate	Latest delivery date cannot be before the Earliest delivery date.
InvalidOrderNumber	The customer order number cannot be set to Y.
Load	This Quote is on a load and cannot be updated.
NoValidCountyROM1	No valid county found from Address for ROM1 reporting.
Status	This order has a status which prevents it from being updated.
SuspenseDepot	The Quote depot cannot be a suspense depot.
WindowDayOverlap	The delivery days overlap other delivery days.

QuoteLine

Code	Message
MaxMargin	The unit price entered must be reduced to %1 based on the market movements. If you think this is incorrect please contact your supplier contact.

Third Party Interface

Code	Message
Missing	ThirdPartyInterface property is missing.

Time Window

Code	Message
InvalidRange	The 'To' time, must be greater than or equal to the 'From' time.

Use Statement

Code	Message
InvalidProduct	Use statement product not valid for RDCO.
NatureOfSupplyRequiresNumber	The nature of supply of this use code is RDCO but the customer does not have an RDCO number.
NotOnOrder	Use statement product not on the order.
ProtectUseCode	You cannot enter use codes beginning with 7 or 8. These are generated automatically by Codas.

Worknote

Code	Message
Custom	%1: %2.
EquipPartLoc	%1 must be an Equipment Parts Location.
EquipPartProd	%1 must be an Equipment Maintenance Part Product.
EquipTypeProd	Product must have a category of Equipment Maintenance and an Equipment Type of %1.
InvalidTime	The %1 %2 the %3.
MiscStock	%1 cannot be part of Miscellaneous Stocks.
MiscStocksLoc	%1 must be included in Miscellaneous Stocks.
ParentChildReuse	TicketNumber: %1 has already been used for a child of the same parent of this customer or for the parent itself.
PartType	%1 has a restricted Product Type.
PositiveOrZeroInteger	%1 must be a positive or zero integer%2.
RechargeReuse	TicketNumber: %1 has already been used for recharge customer: %2.
Reuse	TicketNumber: %1 has already been used for this customer.
UnlinkedUser	%1 must be linked to a Codas User.