BIbill
customers

Get customer details

Changed on

Get details about an existing customer.

get/v3/customers/{customerId}

Request

  • Base URL
    https://gateway.stage.bill.com/connect
  • URL
    https://gateway.stage.bill.com/connect/v3/customers/{customerId}
  • Auth
    none declared

Path parameters

customerIdstring required

BILL-generated ID of the customer. The value begins with 0cu.

Example:{{customer_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

Get customer details response

idstring

BILL-generated ID of the customer. The value begins with 0cu.

archivedboolean

Set as true if the customer is archived.

namestring required

Customer name

companyNamestring

Customer company name. This field is overridden when you connect with a customer in the BILL network.

emailstring required

Customer email address

phonestring

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

faxstring

Customer fax number

descriptionstring

Customer description

invoiceCurrency'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'

Invoice currency. Three-letter abbreviation.

accountType'NONE' | 'BUSINESS' | 'PERSON' | 'UNDEFINED'

Customer account type

paymentTermIdstring

BILL-generated ID of the payment term. Use payment terms to set the number of days the customer has to clear an invoice.

accountNumberstring

Customer account number. The number appears in customer invoices.

hasBankAccountboolean

Set as true if the customer bank account is added

authorizedToChargeboolean

Set as true if your organization is authorized to charge the customer for invoices

createdTimestring date-time

Created date and time

updatedTimestring date-time

Updated date and time

relevanceScorenumber double

Relevance score from the fuzzy name search that matched this customer. This field appears in the response only for customers 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.

Changes