BIbill
vendors

Archive a vendor

Changed on

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.

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

Path parameters

vendorIdstring required

BILL-generated ID of the vendor. The value begins with 009.

Example:{{vendor_id}}

Headers

sessionIdstring nullable

API session ID generated with /v3/login

Example:{{session_id}}
devKeystring nullable

Developer key generated with your BILL developer account

Example:{{developer_key}}

Response

Archive a vendor response

idstring

BILL-generated ID of the vendor. The value begins with 009.

archivedboolean required

Set as true if the vendor is archived

namestring

Vendor name

shortNamestring

Vendor short name

accountNumberstring

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

emailstring

Vendor email address

phonestring

Vendor phone number. This field is overridden when you connect with a vendor in the BILL network.

rppsIdstring

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.

recurringPaymentsboolean

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

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time

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.

paymentNetworkIdstring

Vendor Payment Network ID (PNI). Each vendor with a BILL account is assigned a unique PNI.

relevanceScorenumber 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.

Example response

{
  "paymentInformation": {
    "bankAccount": {
      "nameOnAccount": "Bill Vendorson",
      "accountNumber": "111222333",
      "routingNumber": "074000010",
      "type": "CHECKING",
      "ownerType": "BUSINESS",
      "paymentCurrency": "USD"
    }
  }
}

Changes

  • 54edddceb0a5Revision changes
    • breaking

      the /////////// response's property type changed from string to no type for status

    • breaking

      the /////////// response's property type changed from string to no type for status

    • info

      added the optional property to the response with the status

    • info

      added subschema #2 to the /////////// response property allOf list for the response status

    • info

      added subschema #2 to the /////////// response property allOf list for the response status