Originators

Get a list of Originators

This method requires the Originators:Get permission to be associated with your role.

GET

/gb/originators

curl --request GET \
  --url 'https://api.catch-e.com/gb/originators?supplier_id=%3Cstring%3E&originator_code=%3Cstring%3E&user_code=%3Cstring%3E&description=%3Cstring%3E&include_inactive_flag=no&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "originator_id": [
      {
        "description": "<string>",
        "originator_code": "<string>",
        "originator_id": "<string>",
        "status_flag": "no",
        "supplier_id": "<string>",
        "user_code": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/gb/originators"
    }
  },
  "page": 1,
  "page_count": 1,
  "page_size": 25,
  "total_items": 1
}

Authorizations

Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd

Query Parameters

supplier_idstringqueryrequired

Mandatory (Originators are linked to Supplier/Financier).

originator_codestringquery

This field supports the wildcard % operator.

user_codestringquery

This field supports the wildcard % operator.

descriptionstringquery

This field supports the wildcard % operator.

include_inactive_flagenum<string>querydefault:no

Set to yes if inactive Originators required in the list.

Available options: yes, no

pageintegerquerydefault:1

Required range: -1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Required range: -1 <= x <= 2147483647

Response

Success

_embeddedobject

Show child attributes

_linksobject

pageinteger

Example: 1

page_countinteger

Example: 1

page_sizeinteger

Example: 25

total_itemsinteger

Example: 1

Still need help? Ask the team