---
title: "Archive a vendor"
method: POST
path: "/v3/vendors/{vendorId}/archive"
tags: ["vendors"]
---

# Archive a vendor

`POST /v3/vendors/{vendorId}/archive`

## Request

- Base URL: `https://gateway.stage.bill.com/connect`
- URL: `https://gateway.stage.bill.com/connect/v3/vendors/{vendorId}/archive`
- Auth: none declared

Archive an existing vendor. In the response, the `archived` field is set as `true`.

You can restore an archived vendor with `POST /v3/vendors/{vendorId}/restore`. There is no change when you archive an archived vendor.

## Path parameters

- `vendorId` string, required: BILL-generated ID of the vendor. The value begins with `009`.

## Headers

- `sessionId` string, nullable: API session ID generated with `/v3/login`
- `devKey` string, nullable: Developer key generated with your BILL developer account

## Response `200`

Archive a vendor response

- VendorResponseDto: Vendors response.
  - `id` string: BILL-generated ID of the vendor. The value begins with `009`.
  - `archived` boolean, required: Set as `true` if the vendor is archived
  - `name` string: Vendor name
  - `shortName` string: Vendor short name
  - `accountNumber` string: User account number set by the vendor. When you pay the vendor, this value appears on the check memo or electronic payment record.
  - `accountType` 'NONE' | 'BUSINESS' | 'PERSON' | 'UNDEFINED': Vendor account type
  - `email` string: Vendor email address
  - `phone` string: Vendor phone number. This field is overridden when you connect with a vendor in the BILL network.
  - `address` object: Vendor address information. This information is overridden when you connect with a vendor in the BILL network.
    - `line1` string, required: Address line 1
    - `line2` string: Address line 2
    - `city` string, required: Address city
    - `stateOrProvince` string: State or province
    - `zipOrPostalCode` string, required: Zip or postal code
    - `country` 'AD' | 'AE' | 'AF' | 'AG' | 'AI' | 'AL' | 'AM' | 'AO' | 'AQ' | 'AR' | 'AS' | 'AT' | 'AU' | 'AW' | 'AZ' | 'BA' | 'BB' | 'BD' | 'BE' | 'BF' | 'BG' | 'BH' | 'BI' | 'BJ' | 'BM' | 'BN' | 'BO' | 'BR' | 'BS' | 'BT' | 'BW' | 'BY' | 'BZ' | 'CA' | 'CC' | 'CD' | 'CF' | 'CG' | 'CH' | 'CI' | 'CK' | 'CL' | 'CM' | 'CN' | 'CO' | 'CR' | 'CV' | 'CX' | 'CY' | 'CZ' | 'DE' | 'DJ' | 'DK' | 'DM' | 'DO' | 'DZ' | 'EC' | 'EE' | 'EG' | 'EH' | 'ER' | 'ES' | 'ET' | 'FI' | 'FJ' | 'FK' | 'FM' | 'FO' | 'FR' | 'GA' | 'GB' | 'GD' | 'GE' | 'GF' | 'GH' | 'GI' | 'GL' | 'GM' | 'GN' | 'GP' | 'GQ' | 'GR' | 'GS' | 'GT' | 'GW' | 'GY' | 'HK' | 'HM' | 'HN' | 'HR' | 'HT' | 'HU' | 'ID' | 'IE' | 'IL' | 'IN' | 'IO' | 'IQ' | 'IS' | 'IT' | 'JM' | 'JO' | 'JP' | 'KE' | 'KG' | 'KH' | 'KI' | 'KM' | 'KN' | 'KR' | 'KW' | 'KY' | 'KZ' | 'LA' | 'LB' | 'LC' | 'LI' | 'LK' | 'LR' | 'LS' | 'LT' | 'LU' | 'LV' | 'LY' | 'MA' | 'MC' | 'MD' | 'ME' | 'MG' | 'MH' | 'MK' | 'ML' | 'MN' | 'MO' | 'MP' | 'MQ' | 'MR' | 'MS' | 'MT' | 'MU' | 'MV' | 'MW' | 'MX' | 'MY' | 'MZ' | 'NA' | 'NC' | 'NE' | 'NF' | 'NG' | 'NI' | 'NL' | 'NO' | 'NP' | 'NR' | 'NU' | 'NZ' | 'OM' | 'PA' | 'PE' | 'PF' | 'PG' | 'PH' | 'PK' | 'PL' | 'PM' | 'PN' | 'PS' | 'PT' | 'PW' | 'PY' | 'QA' | 'RE' | 'RO' | 'RS' | 'RU' | 'RW' | 'SA' | 'SB' | 'SC' | 'SE' | 'SG' | 'SH' | 'SI' | 'SJ' | 'SK' | 'SL' | 'SM' | 'SN' | 'SO' | 'SR' | 'ST' | 'SV' | 'SZ' | 'TC' | 'TD' | 'TF' | 'TG' | 'TH' | 'TJ' | 'TK' | 'TL' | 'TM' | 'TN' | 'TO' | 'TR' | 'TT' | 'TV' | 'TW' | 'TZ' | 'UA' | 'UG' | 'UM' | 'US' | 'UY' | 'UZ' | 'VA' | 'VC' | 'VE' | 'VG' | 'VN' | 'VU' | 'WF' | 'WS' | 'YE' | 'YT' | 'ZA' | 'ZM' | 'ZW', required: Country code (ISO2)
    - `countryName` string: Country name.
  - `paymentInformation` object: Vendor payment information
    - `payeeName` string, required: Vendor name for check and electronic payments. This field is overridden when you connect with a vendor in the BILL network.
    - `email` string: Vendor email address for receiving payment information. BILL uses the vendor `email` value when this payment `email` value is not set.
    - `lastPaymentDate` string: Last payment date
    - `payByType` 'CHECK' | 'ACH' | 'RPPS' | 'OFFLINE' | 'INTERNATIONAL_E_PAYMENT' | 'VIRTUAL_CARD' | 'WALLET' | 'UNDEFINED': Payment method for BILL payments
    - `payBySubType` 'NONE' | 'WIRE' | 'IACH' | 'LOCAL' | 'MULTIPLE' | 'ACH' | 'UNDEFINED': Payment delivery method for international payments.
    - `transferMethod` 'WIRE' | 'LOCAL' | 'UNDEFINED': Default payment delivery method for international payments. This field is set when `payBySubType` is set as `MULTIPLE`. * `LOCAL`: Funds transferred with the vendor country's domestic payment network * `WIRE`: Funds transferred with bank-operated networks (For example, SWIFT)
    - `virtualCard` object: Virtual card information. **Note**: A vendor can be enrolled to accept virtual card payments even without being connected in the BILL network. See [Virtual card FAQ](https://help.bill.com/direct/s/article/360021237411) in the BILL Help Center for more information.
      - `status` 'UNDEFINED' | 'OPEN' | 'PENDING' | 'REQUIRE_MORE_INFO' | 'PAY_FOR_YOUR_OPPORTUNITY' | 'PHONE_NUMBER_NEEDED' | 'ENROLLED' | 'DECLINED' | 'CONFIRMED' | 'RECRUITING' | 'VERBAL_COMMITMENT' | 'PAYER_ASSIST' | 'ON_HOLD' | 'UNKNOWN': Virtual card enrollment status for the vendor
      - `remitEmail` string: Virtual card remittance email address set for the vendor
      - `enrollDate` string, date-time: Virtual card enrollment date
      - `declineDate` string, date-time: Virtual card declined date
      - `alternatePayByType` 'CHECK' | 'ACH' | 'RPPS' | 'PAYPAL' | 'OFFLINE' | 'INTERNATIONAL_E_PAYMENT' | 'AMEX' | 'VIRTUAL_CARD' | 'WALLET' | 'CREDIT_CARD' | 'UNDEFINED': Alternate payment method for virtual card payment
    - `bankAccount` object: Vendor bank account information. This information is overridden when you connect with a vendor in the BILL network.
      - `nameOnAccount` string: Vendor bank account name
      - `accountNumber` string, required: Vendor bank account number. This field is required for enabling electronic payments to vendors. See [Create an international vendor](https://developer.bill.com/docs/creating-an-international-vendor) for more information on how to set up vendor payment information for an international (not US) vendor.
      - `routingNumber` string: Vendor bank routing number. This field is required for enabling electronic payments to vendors. This field is empty for an IBAN `accountNumber`. See [Create an international vendor](https://developer.bill.com/docs/creating-an-international-vendor) for more information on how to set up vendor payment information for an international (not US) vendor.
      - `type` 'CHECKING' | 'SAVINGS': Vendor bank account type. This value is required for enabling electronic payments to international vendors (not United States) in specific countries.
      - `ownerType` 'BUSINESS' | 'PERSONAL': Vendor bank account owner type
      - `regulatoryFields` NameValue[]: International bank account regulatory information. The `name` and `value` fields are required for each required bank account regulatory field. See [Create an international vendor](https://developer.bill.com/docs/creating-an-international-vendor) for more information on how to set `regulatoryFields`.
        - `name` string: Name field
        - `value` string: Value field
      - `paymentCurrency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD': Payment currency. Three-letter abbreviation. This field is required for enabling electronic payments to vendors. See <a href="https://help.bill.com/hc/en-us/articles/360007172671">Country information for international payments</a> in the BILL Help Center for more information.
      - `bankInfo` object: Vendor bank account branch information
        - `swiftBIC` string: SWIFT code
        - `branchName` string: Branch name
        - `countryISO` string: Country ISO code
        - `nationalBankCode` string: National bank code
        - `institutionName` string: Bank institution name
        - `primaryKey` string: Primary key
        - `address` object: Bank address
          - `line1` string: Address line 1
          - `line2` string: Address line 2
          - `city` string: City
          - `stateOrProvince` string: State or province
          - `zipOrPostalCode` string: Zip or postal code
          - `country` string: Country
      - `status` 'NOT_VERIFIED' | 'VERIFIED' | 'PENDING' | 'BLOCKED' | 'EXPIRED' | 'INVALID' | 'UNDEFINED': Vendor bank account status.
    - `paymentPurpose` object: Payment purpose information
      - `text` string: Payment purpose text
      - `code` object: Payment purpose code
        - `name` string: Name
        - `value` string: Value
  - `additionalInfo` object: Vendor additional information
    - `taxId` string: Vendor tax ID. This value is required by the IRS for tax purposes.
    - `taxIdType` 'EIN' | 'SSN' | 'UNDEFINED': Vendor tax ID type
    - `track1099` boolean: Set as `true` if the vendor is eligible to receive an IRS form 1099 from the payer
    - `leadTimeInDays` integer: Vendor payment lead time in days
    - `combinePayments` boolean: Set as `true` to combine a bulk payment made to the vendor with `POST /v3/payments/bulk`. The default value is `true`.
    - `paymentTermId` string: BILL-generated ID of the payment term. Use payment terms to set the number of days that customers have to pay a vendor bill.
    - `companyName` string: Vendor business name. This value is required by the IRS for tax purposes.
  - `rppsId` string: BILL-generated ID of the verified national vendor (if the vendor is a verified national vendor)
  - `bankAccountStatus` 'NO_ACCOUNT' | 'NO_NET_LINKED_ACCOUNT' | 'NET_LINKED_ACCOUNT' | 'UNDEFINED': Vendor bank account status.
  - `recurringPayments` boolean: Set as `true` if the vendor has recurring payments enabled
  - `billCurrency` 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYN' | 'BZD' | 'CAD' | 'CDF' | 'CHF' | 'CLP' | 'CNY' | 'COP' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GGP' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'IMP' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JEP' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRU' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLE' | 'SLL' | 'SOS' | 'SPL' | 'SRD' | 'STN' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRY' | 'TTD' | 'TVD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XCD' | 'XDR' | 'XOF' | 'XPF' | 'YER' | 'ZAR' | 'ZMW' | 'ZWD': Bill currency
  - `createdTime` string, date-time: Created date and time
  - `updatedTime` string, date-time: Updated date and time
  - `balance` object: Vendor account balance information. When bills are created for the vendor, this information is updated.
    - `amount` number: Balance amount to be paid to the vendor
    - `lastUpdatedDate` string, date-time: Balance amount last updated date and time
  - `autoPay` object: Vendor auto-pay information. When you enable vendor auto-pay, BILL automatically pays the vendor when a bill is created for the vendor.
    - `enabled` boolean: Set as `true` if the vendor auto-pay is enabled
    - `bankAccountId` string: BILL-generated ID of the organization bank account used to set up vendor auto-pay. The value begins with `bac`.
    - `createdBy` string: BILL-generated ID of the user that set up vendor auto-pay. The value begins with `006`. You can retrieve your user ID when you sign in with `/v3/login`.
    - `maxAmount` number: Maximum bill amount for which vendor auto-pay is enabled
    - `daysBeforeDueDate` integer: Number of days before the bill payment due date. For example, if `dueBeforeDueDate` is `3`, BILL submits the vendor payment 3 days before the bill payment due date.
  - `networkStatus` 'NOT_CONNECTED' | 'PENDING' | 'CONNECTED' | 'CONNECTED_RPPS': Network connection status. This field appears in the response only when a network connection status is available for the vendor.
  - `paymentNetworkId` string: Vendor Payment Network ID (PNI). Each vendor with a BILL account is assigned a unique PNI.
  - `relevanceScore` number, double: Relevance score from the fuzzy name search that matched this vendor. This field appears in the response only for vendors matched by an `fz` filter on `name`. Scores are comparable only among the results of a single search. Do not compare them across searches or against a fixed threshold.

## Other responses

- `4XX`: List of errors.
- `5XX`: List of errors.

## Changes

- **2026-11-03** `54edddceb0a5`: 2 breaking, 3 info
  - the `paymentInformation/allOf[#/components/schemas/PaymentInformationResponse]/allOf[subschema #2]/virtualCard/allOf[#/components/schemas/VirtualCard]/alternatePayByType` response's property type changed from `string` to no type for status `200`
  - the `paymentInformation/allOf[#/components/schemas/PaymentInformationResponse]/allOf[subschema #2]/virtualCard/allOf[#/components/schemas/VirtualCard]/status` response's property type changed from `string` to no type for status `200`
  - added the optional property `relevanceScore` to the response with the `200` status
  - added `#/components/schemas/DisbursementType, subschema #2` to the `paymentInformation/allOf[#/components/schemas/PaymentInformationResponse]/allOf[subschema #2]/virtualCard/allOf[#/components/schemas/VirtualCard]/alternatePayByType` response property `allOf` list for the response status `200`
  - …1 more

[Operation history](https://skmtc.dev/bill/apis/bill-v3-api/changes/v3/vendors/:vendorId/archive/post.md)

---

[API](https://skmtc.dev/bill/apis/bill-v3-api.md) - [All operations](https://skmtc.dev/bill/apis/bill-v3-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bill/apis/bill-v3-api/revisions/54edddceb0a5?raw)