Hide response attributes Show response attributes object
-
items array[object] | null
The items for this page.
Hide items attributes Show items attributes object
-
id string(uuid)
The GUID identifier for the customer.
-
The name of the company. This may be up to 255 characters.
-
taxId string | null
The company tax Id. This may be up to 255 characters.
-
The company country code in the ISO 3166-1 alpha-2 standard.
-
The company address line 1. This may be up to 255 characters.
-
addressLine2 string | null
The company address line 2. This may be up to 255 characters.
-
The company city. This may be up to 255 characters.
-
The company State. This may be up to 255 characters.
-
The company ZIP. This may be up to 30 characters.
-
The company primary contact first name. This may be up to 255 characters.
-
middleName string | null
The company primary contact middle name. This may be up to 255 characters.
-
The company primary contact last name. This may be up to 255 characters.
-
The company primary contact email. This may be up to 255 characters.
-
The company primary contact phone. This may be up to 30 characters.
-
internalIdentifier string | null
The customer internal identifier. This may be up to 255 characters.
-
resellerId string(uuid) | null
The reseller identifier. If this value is set a relation between this customer and the reseller will be created, if null a direct relation between the CSP and the customer will be created instead.
-
The provider customers. A list containing the info about this customer in one or more provider instances.
Hide providerCustomers attribute Show providerCustomers attribute object | null
-
The provider customers. A list containing the info about this customer in one or more provider instances.
Hide * attributes Show * attributes object | null
-
The GUID identifier for the provider instance.
-
providerCustomerId string | null
The identifier for customer on the provider. This property will only be populated after a customer is successfully created on the provider.
-
The provider specific data for this customer.
-
This value object contains the price margin for this entity.
Hide margin attributes Show margin attributes object
-
The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
Hide marginRule attributes Show marginRule attributes object
-
name string | null
The name of the enumeration.
-
-
The value applied to this price margin. Should not be below 0 or above 999.
-
-
offerTypeMargins object | null
Contains as key the name of the offer type and as value the price margin applied to each offer type for this specific provider instance. Price margins applied at the offer type level will override the price margin applied at the provider instance level. If no price margin is applied to a specific offer type of this provider instance then it will not be in the dictionary. This dictionary is optional.
Hide offerTypeMargins attribute Show offerTypeMargins attribute object | null
-
This value object contains the price margin for this entity.
Hide * attributes Show * attributes object | null
-
The margin rule applied. Possible values: Markup, Margin, SplitMargin or ErpMinusDiscount
Hide marginRule attributes Show marginRule attributes object
-
name string | null
The name of the enumeration.
-
-
The value applied to this price margin. Should not be below 0 or above 999.
-
-
-
status object
The status for this entity. Possible values: Processing, Success, Failed
Hide status attributes Show status attributes object
-
name string | null
The name of the enumeration.
-
-
customerCreationError object
The creation error for this provider customer. This property will only have a diferent value than None if the Status is equal to Failed. Possible values: DomainExists, InvalidCompanyInfo, None or Unknown
Hide customerCreationError attributes Show customerCreationError attributes object
-
name string | null
The name of the enumeration.
-
-
-
-
customerAssociations array[object] | null
The list of partners associated to a customer
Hide customerAssociations attributes Show customerAssociations attributes object
-
resellerId string(uuid) | null
The reseller id.
-
name string | null
The name of the partner.
-
-
-
paginationParameters object
A model that is used to encapsulate the parameters needed to perform pagination queries.
Hide paginationParameters attributes Show paginationParameters attributes object
-
pageNumber integer(int32)
Indicates the number of the current page.
-
pageSize integer(int32)
The number of items that should be returned at most per page.
-
-
totalPages integer(int32)
The total number of pages available for the specified parameters and page size.
-
totalCount integer(int32)
The total number of results available for the specified parameters. Note this is typically not equal to the Count of items in the Items property, will only be equal if all the items fit in the first page.
-
hasPreviousPage boolean
Indicates if there is a previous page.
-
hasNextPage boolean
Indicates if there is a next page.
-
continuationToken string | null
The token to continue to retrieve the paginated items.