Error Codes

Error Code is a unique Upodi-specific generated code where the first number refers to what type of object and the four next digits refer to the nature of the error.

For example "errorcode": 32000

32000 would tell us the error is related to the Payment Method object

32000 would tell us the error is because the model didn't meet the requirements. We probably left out something important.

Objects:

Code

Object

1

Transactions

2

Customer

3

Payment Method

4

Contact

5

Discount

6

Subscription

7

SubscriptionCharge

8

Invoice

9

Product Plan

11

Unit of Measure

12

Business Unit

13

Tax Rule

Type of error:

Code

Type

Description/Reason

1000

Bad Request

Unspecified error. Upodi is monitoring these and continuously improving error messages

2000

Bad Model State

Model did not meet requirements. Could be string too long/short, Integer out of range, required parameter missing etc.

3000

Bad Parameter

Required parameter in the URL is missing or has incorrect value

4000

Entity Not Found

When a requested object is not found

5000

Unprocessable Entity

Illegal action attempted. For example trying to pause a non-activated subscription, marking a paid invoice as paid etc.

6000

Already Exists

When attempting to create an already existing object where this is not allowed

7000

Authentication Failure

Invalid or missing API key

8000

OData

Error on OData BadRequest. We refer to the OData documentation for specific OData support.

POST
https://api.upodi.io/v3/customers
HTTP/1.1
{
  "CompanyName": "Alphabet Inc",
  "CurrencyCode": "USD"
}

HTTP/1.1 400 (Bad Request)
{
  "Type": "request_error",
  "Message": "The FullName field is required.",
  "Errorcode": 22000,
  "Httpstatuscode": 400,
  "Helplink": "https://go.upodi.com/22000/fullname"
}




PUT
https://api.upodi.io/v3/invoices/be37ca9a-03d5-4b24-aeed-5b20790e9497/markpaid/
HTTP/1.1
{
  "PaymentDate": "2018-12-07T23:01:00Z"
}

HTTP/1.1 422 (Unprocessable Entity)
{
    "Type": "request_error",
    "Message": "Invoice with id: be37ca9a-03d5-4b24-aeed-5b20790e9497, has already been marked as paid",
    "Errorcode": 85000,
    "Httpstatuscode": 422,
    "Helplink": "https://go.upodi.com/85000/"
}