Update vendor

curl --request PUT \
  --url https://api.public.every.io/company/v1/vendors/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "display_name": "<string>",
  "email": "jsmith@example.com",
  "w9": {
    "tax_ein": "<string>",
    "address_street": "<string>",
    "address_street2": "<string>",
    "address_city": "<string>",
    "address_state": "<string>",
    "address_postal_code": "<string>",
    "address_country": "<string>",
    "mandatory_w9_legal": true
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    email: 'jsmith@example.com',
    w9: {
      tax_ein: '<string>',
      address_street: '<string>',
      address_street2: '<string>',
      address_city: '<string>',
      address_state: '<string>',
      address_postal_code: '<string>',
      address_country: '<string>',
      mandatory_w9_legal: true
    }
  })
};

fetch('https://api.public.every.io/company/v1/vendors/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.public.every.io/company/v1/vendors/{id}"

payload = {
    "display_name": "<string>",
    "email": "jsmith@example.com",
    "w9": {
        "tax_ein": "<string>",
        "address_street": "<string>",
        "address_street2": "<string>",
        "address_city": "<string>",
        "address_state": "<string>",
        "address_postal_code": "<string>",
        "address_country": "<string>",
        "mandatory_w9_legal": True
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "w9_complete": true,
  "w9": {
    "mandatory_w9_legal": true,
    "entity_type": "<string>",
    "ein_type": "<string>",
    "tax_ein": "*****6789",
    "address_street": "<string>",
    "address_street2": "<string>",
    "address_city": "<string>",
    "address_state": "<string>",
    "address_postal_code": "<string>",
    "address_country": "<string>"
  },
  "email": "<string>",
  "created_at": "2023-12-25"
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

PUT

vendors

{id}

Update vendor

curl --request PUT \
  --url https://api.public.every.io/company/v1/vendors/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "display_name": "<string>",
  "email": "jsmith@example.com",
  "w9": {
    "tax_ein": "<string>",
    "address_street": "<string>",
    "address_street2": "<string>",
    "address_city": "<string>",
    "address_state": "<string>",
    "address_postal_code": "<string>",
    "address_country": "<string>",
    "mandatory_w9_legal": true
  }
}
'

const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_name: '<string>',
    email: 'jsmith@example.com',
    w9: {
      tax_ein: '<string>',
      address_street: '<string>',
      address_street2: '<string>',
      address_city: '<string>',
      address_state: '<string>',
      address_postal_code: '<string>',
      address_country: '<string>',
      mandatory_w9_legal: true
    }
  })
};

fetch('https://api.public.every.io/company/v1/vendors/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.public.every.io/company/v1/vendors/{id}"

payload = {
    "display_name": "<string>",
    "email": "jsmith@example.com",
    "w9": {
        "tax_ein": "<string>",
        "address_street": "<string>",
        "address_street2": "<string>",
        "address_city": "<string>",
        "address_state": "<string>",
        "address_postal_code": "<string>",
        "address_country": "<string>",
        "mandatory_w9_legal": True
    }
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "company_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "w9_complete": true,
  "w9": {
    "mandatory_w9_legal": true,
    "entity_type": "<string>",
    "ein_type": "<string>",
    "tax_ein": "*****6789",
    "address_street": "<string>",
    "address_street2": "<string>",
    "address_city": "<string>",
    "address_state": "<string>",
    "address_postal_code": "<string>",
    "address_country": "<string>"
  },
  "email": "<string>",
  "created_at": "2023-12-25"
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "vendor_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

{
  "message": "<string>",
  "errors": [
    {}
  ]
}

Authorizations

x-api-key

string

header

required

Path Parameters

string<uuid>

required

Body

application/json

Every field is optional and only the supplied ones are written, down to the individual fields of w9. Send at least one.

display_name

string

The vendor name, as shown in the Every dashboard

Minimum string length: 1

string<email> | null

The vendor contact email

object

The W9 fields themselves, with nothing required. PUT /v1/vendors/{id} takes them as they are, so a caller can correct one field; CreateVendorW9 is the same set with the create's required list. Every property is nullable: VendorW9Details nulls the fields a vendor hasn't filed, and this is the same shape a caller reads that response into and sends back, less the masked tax_ein.

Show child attributes

Response

The vendor updated

A single vendor, with the W9 details it was created or updated with. The list omits them: a taxpayer id is not something to hand out a page at a time, and even here tax_ein is masked.

string<uuid>

required

company_id

string<uuid>

required

display_name

string

required

The vendor name, as shown in the Every dashboard

w9_complete

boolean

required

Whether the vendor's W9 details are on file. False while the vendor still has an onboarding form to fill in, whether it was asked through this API or in the Every dashboard.

object

required

The stored W9 details, in the shape w9 is written in, so they can be read, completed and sent back. Null fields are the ones the vendor has not provided. tax_ein is the one field that does not round-trip: it is served masked, and an update that sends the mask back is refused.

Show child attributes

string | null

The vendor contact email

created_at

string<date> | null

The date the vendor was created

Overview

Company

Vendors

Bank accounts

Payments

Reference data

Update vendor

Authorizations

Path Parameters

Body

Response