Posting Maps

Get Posting Maps

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

GET

/gl/posting-maps

Get Posting Maps

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

{
  "_embedded": {
    "gl_posting_maps": [
      {
        "1link_export_flag": "no",
        "1link_scheme_id": "<string>",
        "allow_external_approvals_flag": "no",
        "apply_redundancy_insurance_validation_flag": "no",
        "approval_note": "<string>",
        "auto_extend_flag": "no",
        "auto_post_claims_flag": "no",
        "billing_adjustments_itemised_flag": "yes",
        "budgets_financed_flag": "no",
        "claim_sub_page_flag": "no",
        "comprehensive_insurance_fund_1st_year_flag": "no",
        "depreciable_amount_ex_regctp_flag": "no",
        "disclose_running_costs_flag": "no",
        "documentation_fee_rate_flag": "no",
        "driver_contract_access_flag": "no",
        "driver_pack_flag": "no",
        "fbt_email": "no",
        "finance_payments_at_cof_flag": "no",
        "funds_check_on_claim_sub_page_flag": "no",
        "funds_check_on_reg_ctp_flag": "no",
        "gst_code_id_residual": "<string>",
        "gst_on_finance_payment_method": "standard",
        "include_client_establishment_fee_flag": "no",
        "insurance_group_id": "<string>",
        "insurance_loading_flag": "no",
        "insurance_rating_type": "client",
        "mail_to_quote_request": "<string>",
        "maintenance_risk_type_id": "<string>",
        "name": "<string>",
        "order_delivery_for": "client",
        "order_invoice_to": "client",
        "order_manager_as_assigned_flag": "no",
        "order_registration_notification_to": "client",
        "order_registration_to": "client",
        "package_item_profile_car_id": "<string>",
        "payout_sub_page_flag": "no",
        "posting_map_code": "<string>",
        "posting_map_group": "lease",
        "posting_map_id": "<string>",
        "quote_excess_km_rate_flag": "no",
        "quote_maximum_payload": "<string>",
        "quote_note": "<string>",
        "quote_procurement_fee_flag": "no",
        "quote_redundancy_insurance_flag": "no",
        "quote_template": "<string>",
        "residual_reserve": 123,
        "residual_value_risk_type_id": "<string>",
        "service_due_overdue_report_flag": "yes",
        "sl_export_flag": "yes",
        "status_flag": "active",
        "supplier_id_financier": "<string>",
        "template_id_fbt_operating": "<string>",
        "template_id_fbt_statutory": "<string>",
        "url": "<string>",
        "validate_amount_financed_flag": "no"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/gl/posting-maps"
    }
  },
  "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_map_codestringquery

Optional Posting map code

posting_map_groupstringquery

Optional Posting map group

namestringquery

Optional Name

This field supports the wildcard % operator.

include_inactive_flagenum<string>querydefault:no

Set to yes if inactive Posting maps required in the list. Note 'deleted' records cannot be returned.

Available options: yes, no

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