getSupplier
getSupplier
Overview
Allows you to retrieve Supplier details. This method requires the Suppliers:Get permission to be associated with your role.
By default only 'admin' role is linked in [gb_role_api_permissions].
HTTP Method
Use the HTTP Method 'GET' for consuming this web service.
Input Fields (Header)
Header should contain the 'Content-Type' Key with the Value = 'application/json' or 'application/hjson'.
Input Fields (Path)
Input URL Examples
For supplier details
https://api.catch-e.com/fm/suppliers/:supplierId (Successful) Output Example
{ "supplier_id": 100002, "supplier_group_id": 0, "external_code": "", "supplier_code": "AAA106", "name": "AAA Vehicles R Us", "supplier_type": null, "preferred_supplier_flag": "no", "interface_type": null, "gl_code": "", "supplier_id_agent": 0, "template_id_coc": 0, "status": "Active", "address1": "10 Downing Street", "address2": "Plaza Complex", "city": "Sydney", "state": "NSW", "postcode": 2000, "phone": "02 999 2020", "mobile": null, "fax": "", "email": "sandra.connor@catch-e.com.au", "website": "", "salutation": "", "contact": "", "payment_due": "Day of Month after EOM", "due_days": "30th after", "payment_delivery_type": "email", "account": "", "account_contact": null, "account_phone": null, "account_email": null, "payment_method": "", "aba_format_type": "supplier", "bank_bsb": null, "bank_account_number": null, "bpay_biller_code": null, "rcti_flag": "no", "discount_days": "1st after EOM", "discount_prompt_pay": 0, "payment_term": "Net 30th after EOM", "credit_limit": 0, "discount_volumn": 0, "tax_id": "", "tax_code_freight": "GST", "tax_code": "GST", "abn": "12 123 123 123", "labour_rate": null, "labour_rate_date": null, "parts_discount": 0, "sundries_cost": 0, "insurance_broker_fee_monthly": 0, "oil_price_per_litre": 0, "procurement_fee": 0, "pl_export_flag": "yes", "allow_duplicate_reference_flag": "no", "note": null, "dirty_flag": "2015-04-30 08:03:43", "_links": { "self": { "href": "https://api.test.catch-e.com/fm/suppliers/100002" } } } Error Codes
Example error output
{ "type": "http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html", "title": "Not Found", "status": 404, "detail": "Invalid supplier id" } Was this helpful?
More in Suppliers API
updateSupplierStill need help? Ask the team