Suppliers

Create suppliers

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

POST

/fm/suppliers

Create suppliers

curl --request POST \
  --url https://api.catch-e.com/fm/suppliers \
  --header 'Authorization: <api-key>' \
  --header 'Audit-User-Id: <string>' \
  --header 'Content-Type: application/vnd.catch-e-api.v1+json' \
  --data '
[
  {
    "aba_format_type": "supplier",
    "abn": "<string>",
    "account": "<string>",
    "account_contact": "<string>",
    "account_email": "jsmith@example.com",
    "account_phone": "+61423456789",
    "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>",
    "financier": {
      "aftermarket_separate_supply_flag": "yes",
      "discount_margin": 123,
      "establishment_fee_funded_flag": "yes",
      "external_code": "<string>",
      "finance_method": "future-value",
      "financier_value_mandatory_flag": "yes",
      "gst_on_payout_flag": "yes",
      "no_of_additional_monthly_rentals": 123,
      "payments_arrears_interest_flag": "yes",
      "payout_email": "<string>",
      "periods_deferred": 123,
      "residual_cash_pool_rate": 123,
      "residual_fee_rate": 123,
      "residual_value_as_future_value_flag": "yes",
      "supplier_id_residual_insurer": "<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": "+61423456789",
    "name": "<string>",
    "note": "<string>",
    "oil_price_per_litre": 123,
    "parts_discount": 123,
    "payee_id": "<string>",
    "payment_delivery_type": "email",
    "payment_due": "<string>",
    "payment_method_id": "<string>",
    "phone": "+61423456789",
    "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_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>"
  }
]
'

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

Headers

Audit-User-Idstringheader

(Optional) User Id to use for audit purposes. This header requires the Audit:UserIdOverride permission to be associated with your role.

Maximum string length: 5

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

Body

JSON payload

itemsobject[]

Show child attributes

Response

Supplier created successfully

_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