The customer object

AttributeDescription
idUnique identifier for the object.
nameThe customer’s full name or company name used throughout Katana for identifying the customer.
first_nameThe customer's first name.
last_nameThe customer's last name.
companyThe customer's company name.
emailThe customer’s email address.
phoneThe customer’s phone number.
commentA string attached to the object to add any internal comments.
currencyThe currency that the customer does their business in. This currency will be used by default when creating sales orders for the customer.
reference_idIdentifier for external systems to associate the customer record with third-party integrations
discount_rateCustomer discount rate that applies to sales order line items
created_atThe timestamp when the customer was created.
updated_atThe timestamp when the customer was last updated.
default_billing_idThe ID of the billing address that is used as default when adding new sales orders for the customer.
default_shipping_idThe ID of the shipping address that is used as default when adding new sales orders for the customer.
addressesAn array of shipping and billing addresses.

The customer address object

AttributeDescription
idUnique identifier for the customer address object.
customer_idThe ID of the customer to who this address belongs.
entity_typeEither "billing" or "shipping" depending on the address type.
defaultIndicating whether the address is used as default when adding new sales orders for the customer.
first_nameThe first name of the person related to the address.
last_nameThe last name of the person related to the address.
companyThe company name related to the address.
phoneThe phone number related to the address.
line_1The first line of the address (street name and house number).
line_2The second line of the address (apartment, suite, unit, or building).
cityThe city of the address.
stateThe state of the address.
zipThe zip code of the address.
countryThe country of the address.
created_atThe timestamp when the address was created.
updated_atThe timestamp when the address was updated.