Suppliers

Get a list of configured suppliers

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

GET

/fm/suppliers

curl --request GET \
  --url 'https://api.catch-e.com/fm/suppliers?name=%3Cstring%3E&external_code=%3Cstring%3E&supplier_code=%3Cstring%3E&supplier_type=dealership&exclude_empty_name_flag=no&status=active&interface_type=card-services&page=1&page_size=25' \
  --header 'Authorization: <api-key>'

{
  "_embedded": {
    "fm_suppliers": [
      {
        "aba_format_type": "supplier",
        "abn": "<string>",
        "account": "<string>",
        "account_contact": "<string>",
        "account_email": "jsmith@example.com",
        "account_phone": "<string>",
        "address1": "<string>",
        "address2": "<string>",
        "allow_duplicate_reference_flag": "no",
        "bank_account_number": "<string>",
        "bank_account_suffix": "<string>",
        "bank_bsb": "<string>",
        "bpay_biller_code": 123,
        "channel_id": "<string>",
        "city": "<string>",
        "contact": "<string>",
        "country_id": "<string>",
        "credit_limit": 123,
        "discount_days": "<string>",
        "discount_prompt_pay": 123,
        "discount_volumn": 123,
        "due_days": "<string>",
        "email": "jsmith@example.com",
        "external_code": "<string>",
        "external_role_disclose_transactions_flag": "yes",
        "fax": "<string>",
        "gl_code": "<string>",
        "insurance_broker_fee_monthly": 123,
        "interface_type": "maclease",
        "labour_per_hour_retail": 123,
        "labour_per_hour_retail_discount": 123,
        "labour_rate": 123,
        "labour_rate_date": "2023-12-25",
        "mobile": "<string>",
        "name": "<string>",
        "note": "<string>",
        "oil_price_per_litre": 123,
        "parts_discount": 123,
        "payee_id": null,
        "payment_delivery_type": "email",
        "payment_due": "<string>",
        "payment_method_id": "<string>",
        "phone": "<string>",
        "pl_export_flag": "yes",
        "postcode": "<string>",
        "preferred_supplier_flag": "no",
        "procurement_fee": 123,
        "rcti_flag": "no",
        "salutation": "<string>",
        "state": "VIC",
        "status": "<string>",
        "sundries_cost": 123,
        "supplier_code": "<string>",
        "supplier_group_id": "<string>",
        "supplier_id": "<string>",
        "supplier_id_agent": "<string>",
        "supplier_payment_term_id": "<string>",
        "supplier_type": "dealership",
        "tax_code": "<string>",
        "tax_code_freight": "<string>",
        "tax_id": "<string>",
        "template_id_coc": "<string>",
        "website": "<string>"
      }
    ]
  },
  "_links": {
    "self": {
      "href": "https://api.catch-e.com/fm/suppliers"
    }
  },
  "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

namestringquery

Optional supplier name.

This field supports the wildcard % operator.

Maximum string length: 50

Pattern: ^[a-zA-Z0-9\s\-\_\&\.\@\$\#\%]+$

external_codestringquery

Optional external code.

This field supports the wildcard % operator.

Maximum string length: 18

supplier_codestringquery

Optional supplier code.

This field supports the wildcard % operator.

Maximum string length: 10

Pattern: ^[a-zA-Z0-9\-\_\%]+$

supplier_typeenum<string>[]query

Optional supplier type.

Maximum array length: 40

exclude_empty_name_flagenum<string>querydefault:no

Optional flag. Set 'yes' to exclude suppliers with an empty name field

Available options: yes, no

statusenum<string>[]querydefault:active

Optional status

Maximum array length: 2

interface_typeenum<string>query

Optional interface type.

Available options: card-services, maintenance-controller, claim, contract-events

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