Update a Supplier by ID

curl --request PATCH \
  --url https://api.zivio.net/api/v3/suppliers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>' \
  --data '
{
  "supplier": {
    "supplier": {
      "name": "My New Supplier",
      "description": "Specialist in Construction",
      "headline": "Nice people to do business with",
      "tax_number": "1234568983",
      "vetting_status": "PASSED"
    }
  }
}
'

{
  "id": "77",
  "name": "Company Inc",
  "description": "A detailed biography of the supplier.",
  "headline": "Proven track record in medical procurement",
  "email": "[email protected]",
  "active": "true",
  "vetting_status": "PASSED",
  "tax_number": "9876543234",
  "tax_registered": "true",
  "cis_contractor": "true",
  "payment_terms_in_days": "30",
  "duns_number": "12345678910",
  "linkedin_url": "https://www.linkedin.com/2342342",
  "onboarding_template_name": "Sole Trader Onboarding",
  "invited_by": {
    "id": "66",
    "first_name": "Lorna",
    "last_name": "Lawless",
    "email": "[email protected]",
    "org_name": "Example Org",
    "org_id": "186",
    "business_unit": "Resident Services",
    "division": "Environment & Streetscene",
    "department": "Housing",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "true"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "custom_fields": {
    "key": "value"
  },
  "badges": [
    {
      "id": "1",
      "name": "Badge 1"
    }
  ],
  "primary_address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "invoice_address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "admin_custom_fields": {
    "key": "value"
  },
  "custom_field_detailed": {
    "key": "key",
    "value": "value"
  },
  "skills": [
    {
      "skill_id": 123,
      "skill_slug": "computer-acquisitions",
      "skill_name": "Computer Acquisitions",
      "why": "10 years experience",
      "precedence": 1
    }
  ],
  "company_registration_number": "123456789",
  "website": "https://www.companyinc.com",
  "supplier_risk_factors": [
    {
      "risk_factor_name": "Insurance Risk",
      "risk_level_name": "RED",
      "dated": "YYYY-MM-DD",
      "effective_at": "2023-11-07T05:31:56Z",
      "comments": "Please upload Professional Indemnity Insurance (minimum £1million) document. (26/07/2024)"
    }
  ],
  "bank_accounts": [
    {
      "id": "132",
      "currency": "GBP",
      "country_code": "GB",
      "account_holder_name": "Organistation Ltd",
      "account_holder_type": "Business",
      "account_number": "****1234",
      "sort_code": "123456",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "cis_rate": {
    "id": "3",
    "label": "Construction Industry Scheme Gross Payment",
    "tax_reference": "sales",
    "key": "cis_registered_contractors_deduction",
    "rate": "20.0",
    "country_code": "GB",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "archived": "false",
    "custom_fields": {
      "key": "value"
    }
  }
}

PATCH

suppliers

{id}

Update a Supplier by ID

curl --request PATCH \
  --url https://api.zivio.net/api/v3/suppliers/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --header 'zivio-tenant-id: <api-key>' \
  --data '
{
  "supplier": {
    "supplier": {
      "name": "My New Supplier",
      "description": "Specialist in Construction",
      "headline": "Nice people to do business with",
      "tax_number": "1234568983",
      "vetting_status": "PASSED"
    }
  }
}
'

{
  "id": "77",
  "name": "Company Inc",
  "description": "A detailed biography of the supplier.",
  "headline": "Proven track record in medical procurement",
  "email": "[email protected]",
  "active": "true",
  "vetting_status": "PASSED",
  "tax_number": "9876543234",
  "tax_registered": "true",
  "cis_contractor": "true",
  "payment_terms_in_days": "30",
  "duns_number": "12345678910",
  "linkedin_url": "https://www.linkedin.com/2342342",
  "onboarding_template_name": "Sole Trader Onboarding",
  "invited_by": {
    "id": "66",
    "first_name": "Lorna",
    "last_name": "Lawless",
    "email": "[email protected]",
    "org_name": "Example Org",
    "org_id": "186",
    "business_unit": "Resident Services",
    "division": "Environment & Streetscene",
    "department": "Housing",
    "vetting_status": "PASSED",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "custom_fields": {
      "key": "value"
    },
    "has_oversight": "true"
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "archived_at": "2023-11-07T05:31:56Z",
  "custom_fields": {
    "key": "value"
  },
  "badges": [
    {
      "id": "1",
      "name": "Badge 1"
    }
  ],
  "primary_address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "invoice_address": {
    "id": "326",
    "line1": "326",
    "line2": "Westbourne Grove",
    "city": "Brighton",
    "region": "East Sussex",
    "postcode": "BN99 9XX",
    "country_code": "GB",
    "formatted": "326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"
  },
  "admin_custom_fields": {
    "key": "value"
  },
  "custom_field_detailed": {
    "key": "key",
    "value": "value"
  },
  "skills": [
    {
      "skill_id": 123,
      "skill_slug": "computer-acquisitions",
      "skill_name": "Computer Acquisitions",
      "why": "10 years experience",
      "precedence": 1
    }
  ],
  "company_registration_number": "123456789",
  "website": "https://www.companyinc.com",
  "supplier_risk_factors": [
    {
      "risk_factor_name": "Insurance Risk",
      "risk_level_name": "RED",
      "dated": "YYYY-MM-DD",
      "effective_at": "2023-11-07T05:31:56Z",
      "comments": "Please upload Professional Indemnity Insurance (minimum £1million) document. (26/07/2024)"
    }
  ],
  "bank_accounts": [
    {
      "id": "132",
      "currency": "GBP",
      "country_code": "GB",
      "account_holder_name": "Organistation Ltd",
      "account_holder_type": "Business",
      "account_number": "****1234",
      "sort_code": "123456",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "cis_rate": {
    "id": "3",
    "label": "Construction Industry Scheme Gross Payment",
    "tax_reference": "sales",
    "key": "cis_registered_contractors_deduction",
    "rate": "20.0",
    "country_code": "GB",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "archived": "false",
    "custom_fields": {
      "key": "value"
    }
  }
}

Authorizations

X-API-Key

string

header

required

zivio-tenant-id

string

header

required

Path Parameters

string

required

Body

application/json

supplier

object

Show child attributes

supplier.supplier

object

Show child attributes

supplier.supplier.name

string

Example:

"My New Supplier"

supplier.supplier.description

string

Example:

"Specialist in Construction"

supplier.supplier.headline

string

Example:

"Nice people to do business with"

supplier.supplier.tax_number

string

Example:

"1234568983"

supplier.supplier.vetting_status

enum<string>

Available options:

PASSED,

FAILED,

PENDING

Response

integer

Example:

"77"

name

string

Example:

"Company Inc"

description

string

Example:

"A detailed biography of the supplier."

headline

string

Example:

"Proven track record in medical procurement"

string

Example:

"[email protected]"

active

string

Example:

"true"

vetting_status

string

Example:

"PASSED"

tax_number

string

Example:

"9876543234"

tax_registered

boolean

Example:

"true"

cis_contractor

boolean

Example:

"true"

payment_terms_in_days

integer

Example:

"30"

duns_number

string

Example:

"12345678910"

linkedin_url

string

Example:

"https://www.linkedin.com/2342342"

onboarding_template_name

string

Example:

"Sole Trader Onboarding"

invited_by

object

Show child attributes

invited_by.id

integer

Example:

"66"

invited_by.first_name

string

Example:

"Lorna"

invited_by.last_name

string

Example:

"Lawless"

invited_by.email

string

Example:

"[email protected]"

invited_by.org_name

string

Example:

"Example Org"

invited_by.org_id

integer

Example:

"186"

invited_by.business_unit

string

Example:

"Resident Services"

invited_by.division

string

Example:

"Environment & Streetscene"

invited_by.department

string

Example:

"Housing"

invited_by.vetting_status

string

Example:

"PASSED"

invited_by.created_at

string<date-time>

invited_by.updated_at

string<date-time>

invited_by.custom_fields

object

Show child attributes

invited_by.custom_fields.key

string

Example:

"value"

invited_by.has_oversight

string

Example:

"true"

created_at

string<date-time>

updated_at

string<date-time>

archived_at

string<date-time>

custom_fields

object

Show child attributes

custom_fields.key

string

Example:

"value"

badges

object[]

Show child attributes

badges.id

integer

Example:

"1"

badges.name

string

Example:

"Badge 1"

primary_address

object

Show child attributes

primary_address.id

string

Example:

"326"

primary_address.line1

string

Example:

"326"

primary_address.line2

string

Example:

"Westbourne Grove"

primary_address.city

string

Example:

"Brighton"

primary_address.region

string

Example:

"East Sussex"

primary_address.postcode

string

Example:

"BN99 9XX"

primary_address.country_code

string

Example:

"GB"

primary_address.formatted

string

Example:

"326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"

invoice_address

object

Show child attributes

invoice_address.id

string

Example:

"326"

invoice_address.line1

string

Example:

"326"

invoice_address.line2

string

Example:

"Westbourne Grove"

invoice_address.city

string

Example:

"Brighton"

invoice_address.region

string

Example:

"East Sussex"

invoice_address.postcode

string

Example:

"BN99 9XX"

invoice_address.country_code

string

Example:

"GB"

invoice_address.formatted

string

Example:

"326, Westbourne Grove, Brighton, East Sussex, BN99 9XX, United Kingdom"

admin_custom_fields

object

Show child attributes

admin_custom_fields.key

string

Example:

"value"

custom_field_detailed

object

Show child attributes

custom_field_detailed.key

string

Example:

"key"

custom_field_detailed.value

string

Example:

"value"

skills

object[]

Show child attributes

skills.skill_id

integer

Example:

123

skills.skill_slug

string

Example:

"computer-acquisitions"

skills.skill_name

string

Example:

"Computer Acquisitions"

skills.why

string

Example:

"10 years experience"

skills.precedence

integer

Example:

1

company_registration_number

string

Example:

"123456789"

website

string

Example:

"https://www.companyinc.com"

supplier_risk_factors

object[]

Show child attributes

supplier_risk_factors.risk_factor_name

string

Example:

"Insurance Risk"

supplier_risk_factors.risk_level_name

string

Example:

"RED"

supplier_risk_factors.dated

string

Example:

"YYYY-MM-DD"

supplier_risk_factors.effective_at

string<date-time>

supplier_risk_factors.comments

string

Example:

"Please upload Professional Indemnity Insurance (minimum £1million) document. (26/07/2024)"

bank_accounts

object[]

Show child attributes

bank_accounts.id

string

Example:

"132"

bank_accounts.currency

string

Example:

"GBP"

bank_accounts.country_code

string

Example:

"GB"

bank_accounts.account_holder_name

string

Example:

"Organistation Ltd"

bank_accounts.account_holder_type

string

Example:

"Business"

bank_accounts.account_number

string

Example:

"****1234"

bank_accounts.sort_code

string

Example:

"123456"

bank_accounts.created_at

string<date-time>

bank_accounts.updated_at

string<date-time>

cis_rate

object

Show child attributes

cis_rate.id

integer

Example:

"3"

cis_rate.label

string

Example:

"Construction Industry Scheme Gross Payment"

cis_rate.tax_reference

enum<string>

Available options:

sales,

cis

cis_rate.key

string

Example:

"cis_registered_contractors_deduction"

cis_rate.rate

string

Example:

"20.0"

cis_rate.country_code

string

Example:

"GB"

cis_rate.created_at

string<date-time>

cis_rate.updated_at

string<date-time>

cis_rate.archived

boolean

Example:

"false"

cis_rate.custom_fields

object

Show child attributes

cis_rate.custom_fields.key

string

Example:

"value"

Delete a Supplier by ID Retrieve a supplier's users

⌘I

Endpoints

Authorizations

Path Parameters

Body

Response