From f8bb0d02510a30c7c0c14900c4ffb61431209ac0 Mon Sep 17 00:00:00 2001
From: Ivan Kohler <ivan@freeside.biz>
Date: Wed, 12 Aug 2020 10:45:14 -0700
Subject: [PATCH 1/1] doc: return fields for customer_info, RT#84796

---
 FS/FS/API.pm | 98 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 98 insertions(+)

diff --git a/FS/FS/API.pm b/FS/FS/API.pm
index e504ec5fa..8c5d10666 100644
--- a/FS/FS/API.pm
+++ b/FS/FS/API.pm
@@ -574,6 +574,104 @@ Example:
 
   print Dumper($result);
 
+Returns the following fields:
+
+=over 4
+
+=item error
+
+Empty, or error message (in which case, none of the other fields will be populated)
+
+=item display_custnum
+
+Optional customer number display override - if present, use this for all UI instead of the real database custnum
+
+=item name
+
+Simple string for customer identification (from first, last, company)
+
+=item balance
+
+=item status
+
+=item statuscolor
+
+=item first
+
+=item last
+
+=item company
+
+=item daytime
+
+=item night
+
+=item mobile
+
+=item fax
+
+=item agentnum
+
+Agent (Company)
+
+=item salesnum
+
+Sales person
+
+=item refnum
+
+Advertising channel
+
+=item classnum
+
+Customer class
+
+=item usernum
+
+Employee (initial customer insert)
+
+=item referral_custnum
+
+Referring customer
+
+=item address1
+
+=item address2
+
+=item city
+
+=item county
+
+=item state
+
+=item zip
+
+=item country
+
+=item ship_address1
+
+=item ship_address2
+
+=item ship_city
+
+=item ship_county
+
+=item ship_state
+
+=item ship_zip
+
+=item ship_country
+
+=item invoicing_list
+
+Comma-separated list of email addresses
+
+=item postal_invoicing
+
+0 or 1
+
+=back
+
 =cut
 
 sub customer_info {
-- 
2.11.0