List terms

GET 
/api/v3/terms

Request

Responses

200

Object was fetched successfully

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable

response

object[]

Array [

terms_id integer

Terms ID number

name string

Terms name

days integer

Number of days

]

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": [
    {
      "terms_id": 0,
      "name": "string",
      "days": 0
    }
  ]
}

Example 1

{
  "code": 200,
  "status": "OK",
  "message": "",
  "response": [
    {
      "terms_id": 3,
      "name": "Due on Receipt",
      "days": 0
    },
    {
      "terms_id": 1,
      "name": "Net 15",
      "days": 15
    },
    {
      "terms_id": 2,
      "name": "Net 30",
      "days": 30
    }
  ]
}

400

Bad request

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 400,
  "status": "Error",
  "message": "Missing or invalid parameter.",
  "details": {},
  "response": false
}

401

Authentication error

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response boolean

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 401,
  "status": "Error",
  "message": "Invalid or incorrect authorization [Missing (basic) authorization header.]",
  "details": {},
  "response": false
}

404

Object not found

application/json

Schema

Schema

code integer
status string
message stringnullable
details objectnullable
response booleannullable

Example (from schema)

{
  "code": 0,
  "status": "string",
  "message": "string",
  "details": {},
  "response": true
}

Example 1

{
  "code": 404,
  "status": "Error",
  "message": "This object does not exist.",
  "details": {},
  "response": null
}

Loading...