Posting Classes

Get Posting Classes

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

GET

/gl/posting-classes

Get Posting Classes

curl --request GET \
  --url 'https://api.catch-e.com/gl/posting-classes?posting_class_code=%3Cstring%3E&posting_class_group_id=%3Cstring%3E&name=%3Cstring%3E&fields=%3Cstring%3E&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "gl_posting_classes": [
      {
        "1link_export_flag": "no",
        "completed_flag_default": "yes",
        "event_flag": "no",
        "external_role_disclose_transactions_flag": "yes",
        "external_role_event_create_flag": "no",
        "external_role_event_follow_up_flag": "no",
        "external_role_event_view_flag": "yes",
        "fbt_operating_method_flag": "yes",
        "name": "<string>",
        "payment_flag": "no",
        "posting_class_code": "<string>",
        "posting_class_group_id": "<string>",
        "posting_class_id": "<string>",
        "qt_profile_table_name": "qt_quotes",
        "supplier_id": "<string>",
        "system_event_flag": "no",
        "template_id": "<string>",
        "termination_cost_flag": "no"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/gl/posting-classes"
    }
  },
  "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

posting_class_codestringquery

Optional Posting class code

posting_class_group_idstringquery

Optional Posting class group ID

namestringquery

Optional Name

This field supports the wildcard % operator.

fieldsstring[]query

Define fields required. If no fields are specified, then all fields are returned.

pageintegerquerydefault:1

Optional page number

Required range: 1 <= x <= 2147483647

page_sizeintegerquerydefault:25

Optional page size

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