Suppliers

Get a supplier by supplier id

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

GET

/fm/suppliers/{supplier_id}

curl --request GET \
  --url https://api.catch-e.com/fm/suppliers/{supplier_id} \
  --header 'Authorization: <api-key>'

{
  "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>"
}

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

Path Parameters

supplier_idstringrequired

Maximum string length: 10

Pattern: ^[1-9]{1}[0-9]{0,9}$

Response

Success

aba_format_typeenum<string>default:supplier

Available options: supplier, payment-reference

abnstring

accountstring

account_contactstring

account_emailstring

account_phonestring

address1string

address2string

allow_duplicate_reference_flagenum<string>default:no

Available options: yes, no

bank_account_numberstring

bank_account_suffixstring

bank_bsbstring

bpay_biller_codenumber

channel_idstring

citystring

contactstring

country_idstring

credit_limitnumber

discount_daysstring

discount_prompt_paynumber

discount_volumnnumber

due_daysstring

emailstring

external_codestring

external_role_disclose_transactions_flagenum<string>

Available options: yes, no

faxstring

gl_codestring

insurance_broker_fee_monthlynumber

interface_typeenum<string>

Available options: maclease, motorone, bmwdfe, boqef, st_george_nbi2, eric, maclease_partner, 255finance

labour_per_hour_retailnumber

labour_per_hour_retail_discountnumber

labour_ratenumber

labour_rate_datestring

mobilestring

namestring

notestring

oil_price_per_litrenumber

parts_discountnumber

payee_idstringdefault:null

Payee Id

payment_delivery_typeenum<string>

Available options: email, post

payment_duestring

payment_method_idstring

Payment method Id

phonestring

pl_export_flagenum<string>default:yes

Available options: yes, no

postcodestring

preferred_supplier_flagenum<string>default:no

Available options: yes, no

procurement_feenumber

rcti_flagenum<string>default:no

Available options: yes, no

salutationstring

stateenum<string>

Available options: VIC, NSW, ACT, QLD, WA, SA, TAS, NT, NZ

statusstring

sundries_costnumber

supplier_codestring

supplier_group_idstring

supplier_idstring

supplier_id_agentstring

supplier_payment_term_idstring

supplier_typeenum<string>

Available options: dealership, driver, service-centre, card-services, tyres, glass-repairs, financier, transport, detailing, disposal, body-repairs, artwork, insurer, broker, residual-insurer, maintenance-controller, rental, roadside, salary-packaging

tax_codestring

tax_code_freightstring

tax_idstring

template_id_cocstring

websitestring

Still need help? Ask the team