Properties of the customer object.
id
guid
required
|
id of object, set by Upodi |
parentid guid | object id if the customer has a parent customer |
billtoparent boolean | if true, the parent customer will be the billing entity |
collectivebilling boolean | if true, billing is conducted as collective billing. read more here |
businessunitid string | The customer belongs to a specific business unit. |
emailtemplatesetid string | If an id of an email template set is specified, it will overwrite the default email template set from the product plan. |
accountnumber string | Can be provided, otherwise will revert to a random of syntax "CU-xxxx". |
companyname string | Company name. |
companyvat string | VAT number of the customer. Syntax XX01234567, example DK39483902. |
fullname
string
required
|
Full name of the customer. |
refkey string | Custom key, example a remote id. |
primaryemail string | Primary email of customer. |
currencycode string | Default currency code of customer. Must be enabled in Settings. Syntax XXX, example USD. |
autobill boolean | When true, billing will be handled automatically. |
paymentmethod guid | Id of default payment method. If null, the customer is set to manual. |
homephone string | A provided phone number. |
businessphone string | A provided phone number. |
mobilephone string | A provided phone number. |
addressline1 string | Address line 1. |
addressline2 guid | Address line 1. |
city guid | Name of the account city. |
postalcode string | Postal- or zip code. |
country string | Country of account. |
county string | County of account. |
state string | Address state, for example WA. |
note string | Text field for custom notes. |
defaultpaymentmethod paymentmethod | Default payment method object if expanded. |
paymentterm int | Supported days of payment term. values:
|
createddate datetime | Date of when the object was created. |
modifieddate datetime | Date of when the object was last modified. |
createdby guid | Id of the creator. |
modifiedby guid | Id of the modified. |
subscriptions subscription array | Read-only array of subscriptions. May be included otherwise use query options. |
invoices invoice array | Read-only array of invoices. May be included otherwise use query options. |
paymentmethods paymentmethod array | Read-only array of payment methods. May be included otherwise use query options. |
subscriptioncharges subscriptioncharge array | Read-only array of charges. May be included otherwise use query options. |
transactions transaction array | Read-only array of transactions. May be included otherwise use query options. |
{
/* id of object, set by Upodi */
"id": "guid",
/* object id if the customer has a parent customer */
"parentid" : "guid",
/* if true, the parent customer will be the billing entity */
"billtoparent" : "boolean",
/* required, can be customized */
"accountnumber": "string",
"companyname": "string",
"companyvat": "string",
/* required */
"fullname": "string",
/* custom key, example a remote id */
"refkey": "string",
"primaryemail": "string",
/* required */
"currencycode": "string",
/* required */
"autobill": "boolean",
/* id of default payment method - can be extracted via $expand=DefaultPaymentMethod */
"paymentmethod": "guid",
"homephone": "string",
"businessphone": "string",
"mobilephone": "string",
"addressline1": "string",
"addressline2": "string",
/* text field */
"note": "string",
/* address city */
"city": "string",
"postalcode": "string",
/* address country */
"country": "string",
/* address county */
"county": "string",
/* address state */
"state": "string",
/* default payment method object if expanded */
"defaultpaymentmethod": "paymentmethod object",
"currency": "currency",
/* supported days of payment term. values:
-1=notset, 0=onreciept, 8=net8 days, 14=net14, 21=net21, 30=net30, 45=net45, 60=net60, 90=net90 */
"paymentterm" : "int",
/* array of subscription */
"businessunitid": "string",
/* Overwrite any default email template set coming from the product plan */
"emailtemplatesetid": "string",
"subscriptions": "subscription[]",
/* array of invoices */
"invoices": "invoice[] array",
"paymentmethods": "paymentmethod[] array",
"subscriptioncharges": "subscriptioncharge[] array",
"transactions": "transaction[] array",
"createdby": "guid",
"modifiedby": "guid",
"createdbyuser": "userprofile object",
"modifiedbyuser": "userprofile object",
"createddate": "datetime",
"modifieddate": "datetime"
}