Fields in the Provisioned orders Data Set

Important: This is applicable only for reports for the Provisioned orders (default) data set.

This report provides detailed information about rated transactions, including information such as all types of applied charges to a specific account within a specified period and costs for both participants of the transaction.

Report Record Structure

There are three main sections in this report: RESELLER, CUSTOMER, and END CUSTOMER. One report record represents transaction data at several levels of a distribution chain: Reseller, Customer, and End-customer. The SUBSCRIPTION section represents customer subscription data.

Note: The END_CUSTOMER section is only available for the Provider report type.

For a reseller, the following information, which is defined by names, is included when generating reports:

In the following example, consider several scenarios of report creation for an L1 reseller:

This table represents data that is included in different sections for several scenarios.

Scenario RESELLER* CUSTOMER END CUSTOMER
L4 Customer buys from L3 Reseller Charges from L1 Reseller to Provider Charges from L2 Reseller to L1 Reseller Charges from L4 Customer to L3 Reseller
L3 Customer buys from L2 Reseller Charges from L1 Reseller to Provider Charges from L2 Reseller to L1 Reseller Charges from L3 Customer to L2 Reseller
L2 Customer buys from L1 Reseller Charges from L1 Reseller to Provider Charges from L2 Customer to L1 Reseller Charges from L2 Customer to L1 Reseller
L2 Reseller buys from L1 Reseller Charges from L1 Reseller to Provider Charges from L2 Reseller to L1 Reseller Charges from L2 Reseller to L1 Reseller
L1 Reseller buys from Provider Charges from L1 Reseller to Provider - Charges from L1 Reseller to Provider

Note: * The RESELLER section is filled if a service plan is delegated.

Field Description

The table below describes fields available in this report data set.

Note:
1. This report includes order details for a specified period.
2. This report includes details of customer orders of the reseller for whom this report is generated (or this reseller's orders).
3. This report does not include PO or ZB order types.
4. This report includes only fully provisioned SOs: if a SO was created on March 1st, while the last order detail was provisioned on March 2nd, the order will be included in the report starting from March 2nd.
5. If an order has one or more items, the items must be in the Completed status for the details of this order to be included in the report. Orders without order items will also be included in the report.
6. The report contains details for some types of documents (for example, Payments) that are absent in the PCP or RCP UI (filtered out). However, they are present in the BSS database and are exported to the data set as well. Filter out such technical document details during document processing if you do not need to count them.

Field Group Field Name Field Type Description Example
Reseller account data: attributes of a reseller account acting as a seller. RESELLER_ACCOUNT_ID integer The ID of a reseller account (acting as a seller). Equals 1 for first-level customer accounts. 1000008041
RESELLER_ACCOUNT_BSS_APS_ID character varying (38) The APS ID of the related bssAccountInfo APS resource (BSS attributes of an account on the APS bus). 0e1f8a15-c6fd-4069-a958-009b01211b60
RESELLER_NAME character varying (80) A reseller's Company Name for Business accounts or First Name, Middle Name, and Last Name for Personal accounts. Reseller#1
RESELLER_ACCOUNT_CURRENCY character varying (5) The currency of a reseller account in which all monetary values are denominated. USD
RESELLER_ACCOUNT_STATEMENT_DAY integer The day of the month when a statement and a consolidated invoice (if applicable) are issued. 01
RESELLER_BILLING_CONTACT_NAME text The contact information of a reseller. Richard Douglas
RESELLER_BILLING_CONTACT_EMAIL character varying (100) richard@example.com
RESELLER_BILLING_CONTACT_PHONE text +1 (888) 2297777
RESELLER_BILLING_CONTACT_FAX text +1 (888) 2297778
RESELLER_ADMIN_CONTACT_NAME text Richard Douglas
RESELLER_ADMIN_CONTACT_EMAIL character varying (100) richard@example.com
RESELLER_ADMIN_CONTACT_PHONE text +1 (888) 2297777
RESELLER_ADMIN_CONTACT_FAX text +1 (888) 2297778
RESELLER_TECH_CONTACT_NAME text Richard Douglas
RESELLER_TECH_CONTACT_EMAIL character varying (100) richard@example.com
RESELLER_TECH_CONTACT_PHONE text +1 (888) 2297777
RESELLER_TECH_CONTACT_FAX text +1 (888) 2297778
RESELLER_PERS_CONTACT_NAME text Richard Douglas
RESELLER_PERS_CONTACT_EMAIL character varying (100) richard@example.com
RESELLER_PERS_CONTACT_PHONE text +1 (888) 2297777
RESELLER_PERS_CONTACT_FAX text +1 (888) 2297778
RESELLER_ADDRESS1 character varying (80) The postal address of a reseller. 99 Woodland Avenue
RESELLER_ADDRESS2 character varying (80)  
RESELLER_COUNTRY character varying (2) US
RESELLER_STATE character varying (80) LA
RESELLER_CITY character varying (40) Larose
RESELLER_ZIP character varying (10) 70373
RESELLER_TAX_REGISTRATION_ID character varying (20) The tax registration ID of a reseller account specified in the account information. XXXX01001
RESELLER_NOTES text All notes for a reseller account are exported to one field. The following format is used: Short_Description :: Description. Notes are separated by the vertical bar ( | ) symbol.  
RESELLER_CLASS character varying (60) The customer class of an account specified in the account information. Default
RESELLER_ACCOUNT_ATTRIBUTES text An account's custom attributes.  
Reseller subscription's service plan data: properties of a service plan associated with a reseller's charge. RESELLER_PLAN_ID integer

The internal ID of a service plan to which a reseller is subscribed (the one which is related to a reseller charge).

If this is a transaction between the provider and a reseller without resale, this is the ID of the provider's plan. If this is a transaction between a reseller and customer which is based on a delegated service plan, this is the ID of the provider-level master plan which was delegated to the reseller and then sold to the customer.

12316
RESELLER_PLAN_APS_ID character varying (38) The APS ID of a reseller plan. 0e1f8a15-c6fd-4069-a958-009b01211b60
RESELLER_PLAN_NAME character varying (480) The multilingual name of a service plan (for example, "en Cloud Storage es Almacenamiento en la nube ru Облачное Хранилище"). "en DummyPlan "
RESELLER_PLAN_PERIOD_ID integer The internal ID of a subscription's subscription period. 89316
RESELLER_PLAN_CATEGORY_ID integer The internal ID of a reseller plan category. 2
Reseller subscription resource data: properties of a resource associated with a reseller's charge. RESELLER_RESOURCE_ID integer The internal ID of the resource. 102331
RESELLER_RESOURCE_APS_ID character varying (38) The APS ID of the resource. 59e34036-be92-4d5c-b0ea-278bcdccff33
RESELLER_RESOURCE_NAME character varying (2000) The multilingual name of a resource. Storage Capacity
RESELLER_RESOURCE_VENDOR_ID character varying (250) The code or name of a service vendor.  
RESELLER_RESOURCE_MPN character varying (250) The manufacturer part number (a number of a vendor SKU).  
Reseller charge data: properties of a charge applied to a reseller as an order detail, if a reseller is buying for self use, or a reseller transaction, if reselling. The whole section is empty if a charge is related to a service which a reseller renders by themself, that is, non-delegated plans. RESELLER_DETAIL_ID text The internal ID of an Order Detail that represents a charge in the Order, or the internal ID of a Reseller Transaction that represents a charge. R44
RESELLER_CORRECTED_DETAIL_ID text The internal ID of the Order Detail that represents the charge in a corrected Order or the internal ID of the corrected Reseller Transaction that represents the charge.  
RESELLER_DETAIL_SKU character varying (80)

The SKU tag assigned by the upper-level provider or reseller to the fee the detail is based on.

Example:

The provider assigned the "MSFT000E112" SKU to a Setup Fee of a 1-Year Subscription Period of an O365 E1 Service Plan.

Then a reseller assigned the "BKI00000123ZU" SKU to the same Setup Fee of a 1-Year Subscription Period of the O365 E1 Service Plan.

A customer buys a 1-Year subscription to the O365 E1 Service Plan. The customer's Sales Order will include an Order Detail of the "Plan Setup" type and the "BKI00000123ZU" SKU. A corresponding reseller's transaction will have the SKU of "MSFT000E112".

MSFT000E112
RESELLER_DETAIL_TYPE text

The type of a detail or charge. The list of possible detail types is hard-coded.

Examples of detail types are Plan Setup, Plan Renew, Plan Recurring, Resource Recurring, Resource Overuse, and Deposit.

Resource Recurring
RESELLER_DETAIL_DESCRIPTION character varying (4096) Auto-generated textual description of a charge. It is configurable by the seller per fee type with placeholder support, for example: @@Subscription_Plan_Name@ Recurring. Subscription #1036066: Exchange Online Archiving for Exchange Online Recurring
RESELLER_DETAIL_START_DATE timestamp with time zone Represents a charge start date. 2018-11-28
RESELLER_DETAIL_END_DATE timestamp with time zone

Represents a charge end date.

2018-12-28
RESELLER_DETAIL_UNIT_PRICE numeric (20,8) The Unit Price in the RESELLER_ACCOUNT_CURRENCY currency. 4.99
RESELLER_DETAIL_UNIT_PRICE_PERIOD_TYPE text Defines a period assumed in Detail Unit Price (can be either MONTH or BILLING). BILLING
RESELLER_DETAIL_QTY numeric (16,2)

Defines resource upsize or downsize quantity. Always equals 1 for Plan Renew, Plan Recurring and similar non-resource Detail Types.

For reselling transactions, RESELLER_DETAIL_QTY always equals CUSTOMER_DETAIL_QTY.

For some subscriptions, such as O365, a quantity of seats is displayed.

5.00
RESELLER_DETAIL_QTY_UOM character varying (20)

The UoM in which usage is reported by an APS application.

Always equals CUSTOMER_DETAIL_QTY_UOM or is empty.

MB
RESELLER_DETAIL_DURATION numeric (16,8) Duration of an Order Detail (or reseller transaction). 1.00
RESELLER_DETAIL_DISCOUNT_ID integer The internal ID of a Discount applied to a transaction. 123231
RESELLER_DETAIL_DISCOUNT_AMOUNT numeric (20,8) The absolute value of a discount applied (in the RESELLER_ACCOUNT_CURRENCY currency). 5.00
RESELLER_DETAIL_DISCOUNT_RATE numeric (16,4) The discount rate (percentage) applied to a transaction. 10.00
RESELLER_DETAIL_DISCOUNT_PROMO_CODE character varying (2048) The Promo Code string provided with an Order (for discounts of the "by Promo Code" type). SALE2019
RESELLER_DETAIL_PROMOTION_ID integer The internal ID of a Promotion applied to a transaction. 12345676
RESELLER_DETAIL_PROMOTION_PROMO_CODE character varying (2048) The Promo Code string provided with an Order (for promotions of the "by Promo Code" type). SALE2019
RESELLER_DETAIL_PROMOTION_VALUE numeric (20,8) The absolute value of a discount applied (in the RESELLER_ACCOUNT_CURRENCY currency). 15.00
RESELLER_DETAIL_TAX_CATEGORY character varying (20)

The human-readable ID of a Tax Category object (on the upper provider or reseller level) associated with a Service Plan or Resource Rate the Detail is related to.

For more information on taxation configuration in CloudBlue Commerce, refer to Configuring Taxation Settings.

SaaS
RESELLER_DETAIL_INCL_TAX_TOTAL numeric (20,8) The absolute total amount (in the RESELLER_ACCOUNT_CURRENCY currency) of Inclusive Taxes collected with a transaction from a customer. Inclusive Taxes are taxes that are assumed to be included in the price of a Service Plan or Resource. 0.00
RESELLER_DETAIL_EXCL_TAX_TOTAL numeric The absolute total amount (in the RESELLER_ACCOUNT_CURRENCY currency) of Exclusive Taxes collected with a transaction from a customer. Exclusive Taxes are taxes assumed not to be included in the price of a Service Plan or Resource and are added on top of a Unit Price. 2.50
RESELLER_DETAIL_TAX_TOTAL numeric (20,8) The sum of inclusive and exclusive detail tax amounts. 2.50
RESELLER_DETAIL_TAX_RATE numeric (16,4) Effective detail tax rate (calculated backwards from Detail Tax Total and Detail Total). It does not take Order- or Document-level taxes into account. It does not work for non-linear taxes (for example, progressive scale). 10
RESELLER_DETAIL_TOTAL numeric The total detail amount after discount and taxes are applied (in the RESELLER_ACCOUNT_CURRENCY currency). 22.5
RESELLER_DETAIL_NET_TOTAL numeric The pretax total of an order detail. 20.5
RESELLER_DETAIL_PROVISIONED_DATE timestamp with time zone The provisioning date of the last item in a reseller's order. 2019-08-30
RESELLER_DETAIL_CURRENCY character varying (5) The transaction currency (may differ from the account currency if it is reported by a vendor). EUR
RESELLER_ACTUAL_DETAIL_START_DATE timestamp with time zone Represents the first date that a service can be used. 2021-06-28
RESELLER_ACTUAL_DETAIL_END_DATE timestamp with time zone Represents the last date that a service can be used. 2021-07-27
RESELLER_DISCOUNT_BREAKDOWN JSON

The discount breakdown when several discounts are applied to an order detail.

Note: This field is available only if Rating Engine version 1.5 or later is installed.

"DiscountId" : "1", "DiscountName" : "Discount", "DiscountRate" : 33.0000, "DiscountAmount" : 0.33000000, "DiscountSystem" : "BSS", "DiscountAnnotation" : "USD 1.0000 x 1 item33% = USD 0.33"
Reseller order data RESELLER_ORDER_ID text The ID of an Order that hosts an Order Detail representing a Charge (for end-customer orders and self-use orders of resellers) or the ID of a Reseller Transaction Group (not visible in the UI) for reseller charges associated with end-customer charges. 1000012
RESELLER_CORRECTED_ORDER_ID integer The ID of the corrected Order created for the RESELLER_ORDER_NUMBER order. R11
RESELLER_ORDER_APS_ID character varying (38) The APS ID of the RESELLER_ORDER_NUMBER order. 0e1f8a15-c6fd-4069-a958-009b01211b60
RESELLER_ORDER_NUMBER character varying (20) The Order number assigned using an enumerator or sequence prefix configured by a reseller. RN000521
RESELLER_ORDER_TYPE character varying (2) An order type, for example, Sales Order, Renewal Order, Change Order, Billing Order, or Cancellation Order. RN
RESELLER_ORDER_DATE timestamp with time zone The date of the creation of an order. 2018-11-28
RESELLER_ORDER_CREATED_BY integer A user ID (-1 means the system). 1000009
RESELLER_ORDER_SALES_PERSON_ID character varying (80) The ID of a salesperson.  
RESELLER_ORDER_SALES_PERSON_NAME character varying (60) The name of a salesperson.  
RESELLER_ORDER_SALES_COMMISSION_PCT numeric (16,4) A salesperson's sales commission (%).  
RESELLER_ORDER_SALES_COMMISSION_RECURRING_PCT numeric (16,4) A salesperson's recurring payment commission (%).  
RESELLER_ORDER_SALES_BRANCH_ID character varying (80) The ID of a sales branch.  
RESELLER_ORDER_SALES_BRANCH_NAME character varying (60) The name of a sales branch.  
RESELLER_ORDER_NET_TOTAL numeric A pretax order total amount. 1.00
RESELLER_ORDER_TAX_TOTAL numeric (20,8) The sum of Inclusive and Exclusive Tax amounts on both the detail level and the order level. 0.10
RESELLER_ORDER_TOTAL numeric (20,8) The total order amount after discounts and taxes are applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 1.10
RESELLER_ORDER_ATTRIBUTES text An order's custom attributes.  
Reseller invoice data RESELLER_INVOICE_ID integer

The ID of an auto-generated invoice in which the charge is billed for a customer.

Because an API may be accessed (or a report generated) when a particular charge has not been invoiced yet (for example, for consolidated invoicing where a single invoice is issued to an account on its statement day), the invoice fields may be empty.

1000012
RESELLER_INVOICE_NUMBER character varying (20) The invoice number assigned using an enumerator or sequence prefix configured by a reseller. 000021
RESELLER_INVOICE_DATE timestamp with time zone The date of the creation of an invoice. 2018-11-28
RESELLER_INVOICE_DUE_DATE timestamp with time zone The date when an invoice must be paid. 2018-12-28
RESELLER_INVOICE_NET_TOTAL numeric The pretax total of an invoice. 1.00
RESELLER_INVOICE_TAX_TOTAL numeric (20,8) The sum of Inclusive and Exclusive Tax amounts on both the detail level and the invoice level. 0.00
RESELLER_INVOICE_TOTAL numeric (20,8) The total invoice amount after discounts and taxes are applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 1.00
RESELLER_INVOICE_WEEK_NUMBER double precision The number of a week for a reseller invoice date. 35
RESELLER_ORIGINAL_INVOICE_ID integer The ID of an original invoice to which a correction was applied. 1000015
RESELLER_PAYMENTS JSON A list of payment document numbers per reseller invoice. ["000010","000011"]

Reseller prices and currencies

Note:
- These fields are available with CloudBlue Commerce 21.5 and later.
- If multi-currency is not active in CloudBlue Commerce or is not set for service plans with active subscriptions, these fields will display billing values.

 

RESELLER_DETAIL_SALES_UNIT_PRICE numeric The unit price in the sales currency. 4.99
RESELLER_DETAIL_SALES_DISCOUNT_AMOUNT numeric The absolute value of a discount applied in the sales currency. 5.00
RESELLER_DETAIL_SALES_PROMOTION_VALUE numeric The absolute value of a discount applied. 15.00
RESELLER_DETAIL_SALES_INCL_TAX_TOTAL numeric The absolute total amount of inclusive taxes collected with a transaction. Inclusive taxes are taxes that are assumed to be included in the price of a service plan or resource. 0.00
RESELLER_DETAIL_SALES_EXCL_TAX_TOTAL numeric The absolute total amount of exclusive taxes collected with a transaction. Exclusive taxes are taxes assumed not to be included in the price of a service plan or resource and are added on top of a unit price. 2.50
RESELLER_DETAIL_SALES_TAX_TOTAL numeric The sum of inclusive and exclusive tax amounts. 2.50
RESELLER_DETAIL_SALES_TOTAL numeric The total detail amount after a discount and taxes are applied. 22.5
RESELLER_DETAIL_SALES_NET_TOTAL numeric The pretax total of an order detail. 20.5
RESELLER_DETAIL_SALES_CURRENCY character varying (5) The sales currency. EUR
RESELLER_DETAIL_SALES_EXCHANGE_RATE numeric The exchange rate between billing and sales currencies. 1.5
RESELLER_DETAIL_SALES_EXCHANGE_TIME timestamp The exchange date. 2022-02-24
Customer account data: attributes of a customer account or a subreseller account acting as a buyer. CUSTOMER_ACCOUNT_ID integer The ID of a customer account or a subreseller account acting as a buyer. 1000008012
CUSTOMER_ACCOUNT_BSS_APS_ID character varying (38) The APS ID of a related bssAccountInfo APS resource (BSS attributes of an account on the APS bus). 0e1f8a15-c6fd-4069-a958-009b01211b60
CUSTOMER_NAME character varying (80)

A customer's Company Name for Business accounts, or First Name, Middle Name, and Last Name for Personal accounts.

Barney Rubble Bubble, Inc.
CUSTOMER_ACCOUNT_CURRENCY character varying (5)

The currency of a customer account in which all monetary values are denominated.

May not be equal to RESELLER_ACCOUNT_CURRENCY if the currency a reseller transacts with their parent provider or reseller is not the same as the sales currency they use to charge customers and subresellers.

USD
CUSTOMER_ACCOUNT_STATEMENT_DAY integer The statement day of a customer account. Used as a date of consolidated invoicing and billing orders alignment, if configured. 01
CUSTOMER_BILLING_CONTACT_NAME text The contact information of a customer.  
CUSTOMER_BILLING_CONTACT_EMAIL character varying (100)  
CUSTOMER_BILLING_CONTACT_PHONE text  
CUSTOMER_BILLING_CONTACT_FAX text  
CUSTOMER_ADMIN_CONTACT_NAME text  
CUSTOMER_ADMIN_CONTACT_EMAIL character varying (100)  
CUSTOMER_ADMIN_CONTACT_PHONE text  
CUSTOMER_ADMIN_CONTACT_FAX text  
CUSTOMER_TECH_CONTACT_NAME text  
CUSTOMER_TECH_CONTACT_EMAIL character varying (100)  
CUSTOMER_TECH_CONTACT_PHONE text  
CUSTOMER_TECH_CONTACT_FAX text  
CUSTOMER_PERS_CONTACT_NAME text  
CUSTOMER_PERS_CONTACT_EMAIL character varying (100)  
CUSTOMER_PERS_CONTACT_PHONE text  
CUSTOMER_PERS_CONTACT_FAX text  
CUSTOMER_ADDRESS1 character varying (80) The postal address of a customer. 26 Watson Lane
CUSTOMER_ADDRESS2 character varying (80)  
CUSTOMER_COUNTRY character varying (2) US
CUSTOMER_STATE character varying (80) NC
CUSTOMER_CITY character varying (40) Hickory
CUSTOMER_ZIP character varying (10) 28601
CUSTOMER_TAX_REGISTRATION_ID character varying (20) The tax registration ID of a customer specified in the account information. XXXX01001
CUSTOMER_NOTES text All notes for a customer account are exported to one field. The following format is used: Short_Description :: Description. All notes are separated by the vertical bar ( | ) symbol.  
CUSTOMER_CLASS character varying (60) The customer class of an account specified in the account information. Default
CUSTOMER_ACCOUNT_ATTRIBUTES text An account's custom attributes.  
Customer subscription's service plan data: properties of a service plan associated with a customer's charge. CUSTOMER_PLAN_ID integer

The internal ID of a service plan to which a customer is subscribed (the one related to the customer charge).

In the Provider>L1>L2>Customer setting, this is the plan owned by the L2 reseller.

12316
CUSTOMER_PLAN_APS_ID character varying (38) The APS ID of the service plan the customer is subscribed to. 0e1f8a15-c6fd-4069-a958-009b01211b60
CUSTOMER_PLAN_NAME character varying (480) The multilingual name of a service plan (for example, "en Cloud Storage es Almacenamiento en la nube ru Облачное Хранилище"). Exchange Online Archiving for Exchange Online
CUSTOMER_PLAN_PERIOD_ID integer The internal ID of a subscription's subscription period. 89316
CUSTOMER_PLAN_CATEGORY_ID integer The internal ID of a service plan category. 7
Customer subscription's resource data: properties of a resource associated with either or both a customer's and a reseller's charges through a Resource Rate. CUSTOMER_RESOURCE_ID integer The ID of a resource for which a customer is charged. 102331
CUSTOMER_RESOURCE_APS_ID character varying (38) The APS ID of a resource for which a customer is charged. 59e34036-be92-4d5c-b0ea-278bcdccff33
CUSTOMER_RESOURCE_NAME character varying (2000) The multilingual name of a resource. Storage Capacity
CUSTOMER_RESOURCE_VENDOR_ID character varying (250) The code or name of a service vendor.  
CUSTOMER_RESOURCE_MPN character varying (250) The manufacturer part number (a number of a vendor SKU).  
Customer charge data: properties of a charge from the reseller to its buyer (either a child end-customer account or a subreseller account). The whole section is empty if a self-use charge is applied, that is, a charge for the service the reseller consumes, not resells. CUSTOMER_DETAIL_ID text The internal ID of an Order Detail that represents a charge in an Order. 567331
CUSTOMER_CORRECTED_DETAIL_ID text The internal ID of the Order Detail that represents the charge in a corrected Order.  
CUSTOMER_DETAIL_SKU character varying (80)

The SKU tag assigned by a reseller to a fee the detail is based on.

Example:

A reseller assigned the "BKI00000123ZU" SKU to a Setup Fee of a 1-Year Subscription Period of an O365 E1 Service Plan.

A customer buys a 1-Year subscription to the O365 E1 Service Plan. The Sales Order will include an Order Detail of the "Plan Setup" type and the "BKI00000123ZU" SKU.

BKI00000123ZU
CUSTOMER_DETAIL_TYPE text

The type of a detail or charge. The list of possible detail types is hard-coded.

Examples of detail types are Plan Setup, Plan Renew, Plan Recurring, Resource Recurring, Resource Overuse, and Deposit.

Resource Recurring
CUSTOMER_DETAIL_DESCRIPTION character varying (4096)

Auto-generated text description of a charge. It is configurable by the seller per fee type with placeholder support, for example: @@Subscription_Plan_Name@ Recurring.

Subscription #1036066: Exchange Online Archiving for Exchange Online Recurring
CUSTOMER_DETAIL_START_DATE timestamp with time zone Represents a charge start date. 2018-11-28
CUSTOMER_DETAIL_END_DATE timestamp with time zone

Represents a charge end date.

2018-12-28
CUSTOMER_DETAIL_UNIT_PRICE numeric (20,8) The Unit Price in the CUSTOMER_ACCOUNT_CURRENCY currency. 4.49
CUSTOMER_DETAIL_UNIT_PRICE_PERIOD_TYPE text Defines a period assumed in Detail Unit Price (can be MONTH or BILLING). BILLING
CUSTOMER_DETAIL_QTY numeric (16,2) Defines resource upsize or downsize quantity. Always equal 1 for Plan Renew, Plan Recurring and similar non-resource Detail Types. 1.00
CUSTOMER_DETAIL_QTY_UOM character varying (20) The UoM in which usage is reported by an APS application. item
CUSTOMER_DETAIL_DURATION numeric (16,8) Duration of an Order Detail. 1
CUSTOMER_DETAIL_DISCOUNT_ID integer The internal ID of a Discount applied to a transaction. 123231
CUSTOMER_DETAIL_DISCOUNT_AMOUNT numeric (20,8) The absolute value of a Discount applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 5
CUSTOMER_DETAIL_DISCOUNT_RATE numeric (16,4) The discount rate (percentage) applied to a transaction. 10
CUSTOMER_DETAIL_DISCOUNT_PROMO_CODE character varying (2048) The Promo Code string provided with an Order (for discounts of the "by Promo Code" type). SALE2019
CUSTOMER_DETAIL_PROMOTION_ID integer The internal ID of a Promotion applied to a transaction. 12345676
CUSTOMER_DETAIL_PROMOTION_PROMO_CODE character varying (2048) The Promo Code string provided with an Order (for promotions of the "by Promo Code" type). SALE2019
CUSTOMER_DETAIL_PROMOTION_VALUE numeric (20,8) The absolute value of a discount applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 15
CUSTOMER_DETAIL_TAX_CATEGORY character varying (20)

The human-readable ID of a Tax Category object (on the upper provider or reseller level) associated with a Service Plan or Resource Rate the Detail is related to.

For more information on taxation configuration in CloudBlue Commerce, refer to Configuring Taxation Settings.

SaaS
CUSTOMER_DETAIL_INCL_TAX_TOTAL numeric (20,8) The absolute total amount (in the CUSTOMER_ACCOUNT_CURRENCY currency) of Inclusive Taxes collected with a transaction from a customer. Inclusive Taxes are taxes that are assumed to be included into a price of a Service Plan or Resource. 0.0
CUSTOMER_DETAIL_EXCL_TAX_TOTAL numeric The absolute total amount (in the CUSTOMER_ACCOUNT_CURRENCY currency) of Exclusive Taxes collected with a transaction from a customer. Exclusive Taxes are taxes assumed not to be included into a price of a Service Plan or Resource and are added on top of a Unit Price. 2.5
CUSTOMER_DETAIL_TAX_TOTAL numeric (20,8) The sum of Inclusive and Exclusive detail tax amounts. 2.5
CUSTOMER_DETAIL_TAX_RATE numeric (16,4) The effective detail tax rate (calculated backwards from Detail Tax Total and Detail Total). It does not take Order- or Document-level taxes into account. It does not work for non-linear taxes (for example, progressive scale). 10
CUSTOMER_DETAIL_TOTAL numeric The total detail amount after discounts and taxes are applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 22.5
CUSTOMER_DETAIL_NET_TOTAL numeric The pretax total of an order detail. 20.5
CUSTOMER_DETAIL_PROVISIONED_DATE timestamp with time zone The provisioning date of the last item in a customer's order. 2019-08-30
CUSTOMER_DETAIL_CURRENCY character varying (5) The transaction currency (may differ from the account currency if it is reported by a vendor). EUR
CUSTOMER_ACTUAL_DETAIL_START_DATE timestamp with time zone Represents the first date that a service can be used. 2021-06-28
CUSTOMER_ACTUAL_DETAIL_END_DATE timestamp with time zone Represents the last date that a service can be used. 2021-07-27
CUSTOMER_DISCOUNT_BREAKDOWN JSON

The discount breakdown when several discounts are applied to an order detail.

Note: This field is available only if Rating Engine version 1.5 or later is installed.

"DiscountId" : "1", "DiscountName" : "Discount", "DiscountRate" : 33.0000, "DiscountAmount" : 0.33000000, "DiscountSystem" : "BSS", "DiscountAnnotation" : "USD 1.0000 x 1 item33% = USD 0.33"
Customer order data CUSTOMER_ORDER_ID text The ID of an Order that hosts an Order Detail representing a Charge (for end-customer orders and self-use orders of resellers) or the ID of a Reseller Transaction Group (not visible in the UI) for reseller charges associated with end-customer charges. 1000012
CUSTOMER_CORRECTED_ORDER_ID integer The ID of the corrected Order created for the CUSTOMER_ORDER_NUMBER order.  
CUSTOMER_ORDER_APS_ID character varying (38) The APS ID of the CUSTOMER_ORDER_NUMBER order. 0e1f8a15-c6fd-4069-a958-009b01211b60
CUSTOMER_ORDER_NUMBER character varying (20) The Order number assigned using an enumerator or sequence prefix configured by a reseller. SO000521
CUSTOMER_ORDER_TYPE character varying (2) An order type, for example, Sales Order, Renewal Order, Change Order, Billing Order, or Cancellation Order. SO
CUSTOMER_ORDER_DATE timestamp with time zone The creation date of an order. 2018-11-28
CUSTOMER_ORDER_CREATED_BY integer A user ID (-1 means the system). 1000014
CUSTOMER_ORDER_SALES_PERSON_ID character varying (80) The ID of a salesperson.  
CUSTOMER_ORDER_SALES_PERSON_NAME character varying (60) The name of a salesperson.  
CUSTOMER_ORDER_SALES_COMMISSION_PCT numeric (16,4) A salesperson's sales commission (%).  
CUSTOMER_ORDER_SALES_COMMISSION_RECURRING_PCT numeric (16,4) A salesperson's recurring payment commission (%).  
CUSTOMER_ORDER_SALES_BRANCH_ID character varying (80) The ID of a sales branch.  
CUSTOMER_ORDER_SALES_BRANCH_NAME character varying (60) The name of a sales branch.  
CUSTOMER_ORDER_NET_TOTAL numeric A pretax order total amount. 22.5
CUSTOMER_ORDER_TAX_TOTAL numeric (20,8) The sum of Inclusive and Exclusive Tax amounts on both the detail level and the invoice level. 0.0
CUSTOMER_ORDER_TOTAL numeric (20,8) The total order amount after discount and taxes are applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 22.5
CUSTOMER_ORDER_ATTRIBUTES text An order's custom attributes.  
Customer invoice data CUSTOMER_INVOICE_ID integer

The ID of an auto-generated invoice in which the charge is billed for a customer.

Because an API may be accessed (or a report generated) when a particular charge has not been invoiced yet (for example, for consolidated invoicing where a single invoice is issued to an account on its statement day), the invoice fields may be empty.

1000012
CUSTOMER_INVOICE_NUMBER character varying (20) The invoice number assigned using an enumerator or sequence prefix configured by a reseller. 0000021
CUSTOMER_INVOICE_DATE timestamp with time zone The date of the creation of an invoice. 2018-11-28
CUSTOMER_INVOICE_DUE_DATE timestamp with time zone The date when an invoice must be paid. 2018-12-28
CUSTOMER_INVOICE_NET_TOTAL numeric The pretax total of an invoice. 22.00
CUSTOMER_INVOICE_TAX_TOTAL numeric (20,8) The sum of Inclusive and Exclusive Tax amounts on both the detail level and the invoice level. 0.50
CUSTOMER_INVOICE_TOTAL numeric (20,8) The total invoice amount after discount and taxes are applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 22.50
CUSTOMER_INVOICE_WEEK_NUMBER double precision The number of a week for a customer invoice date. 35
CUSTOMER_ORIGINAL_INVOICE_ID integer The ID of an original invoice to which a correction was applied. 1000015
CUSTOMER_PAYMENTS JSON A list of payment document numbers per customer invoice. ["000010","000011"]

Customer prices and currencies

Note:
- These fields are available with CloudBlue Commerce 21.5 and later.
- If multi-currency is not active in CloudBlue Commerce or is not set for service plans with active subscriptions, these fields will display billing values.

CUSTOMER_DETAIL_SALES_UNIT_PRICE numeric The unit price in the sales currency. 4.99
CUSTOMER_DETAIL_SALES_DISCOUNT_AMOUNT numeric The absolute value of a discount applied in the sales currency. 5.00
CUSTOMER_DETAIL_SALES_PROMOTION_VALUE numeric The absolute value of a discount applied. 15.00
CUSTOMER_DETAIL_SALES_INCL_TAX_TOTAL numeric The absolute total amount of inclusive taxes collected with a transaction. Inclusive taxes are taxes that are assumed to be included in the price of a service plan or resource. 0.00
CUSTOMER_DETAIL_SALES_EXCL_TAX_TOTAL numeric The absolute total amount of exclusive taxes collected with a transaction. Exclusive taxes are taxes assumed not to be included in the price of a service plan or resource and are added on top of a unit price. 2.50
CUSTOMER_DETAIL_SALES_TAX_TOTAL numeric The sum of inclusive and exclusive tax amounts. 2.50
CUSTOMER_DETAIL_SALES_TOTAL numeric The total detail amount after a discount and taxes are applied. 22.5
CUSTOMER_DETAIL_SALES_NET_TOTAL numeric The pretax total of an order detail. 20.5
CUSTOMER_DETAIL_SALES_CURRENCY character varying (5) The sales currency. EUR
CUSTOMER_DETAIL_SALES_EXCHANGE_RATE numeric Exchange rate between billing and sales currencies. 1.5
CUSTOMER_DETAIL_SALES_EXCHANGE_TIME timestamp Exchange date. 2022-02-24
Customer subscription data (properties of a customer subscription the customer charge is related to). SUBSCRIPTION_ID integer The customer subscription's internal ID (visible in the UI). 1036066
SUBSCRIPTION_NAME character varying (80) The auto-generated name based on the name of a service plan. Exchange Online Archiving for Exchange Online
SUBSCRIPTION_START_DATE timestamp with time zone The date a subscription was provisioned. If the subscription includes multiple services (provisioning items), the date may be updated when the last provisioning item is completed. The "provisioning" may not include service activation activities on the ISV side (which may be executed asynchronously and not synced back to CloudBlue Commerce). 2018-11-28
SUBSCRIPTION_EXPIRATION_DATE timestamp with time zone

The date a subscription expires and becomes graced, on hold, or terminated as configured in service terms.

If the subscription is canceled before the expiration date, this field must contain the cancellation date.

2019-11-28
SUBSCRIPTION_BILLING_PERIOD integer

The duration of a subscription's billing period (that is, how frequently a Billing Order is generated for a subscription to aggregate recurring and usage charges).

1
SUBSCRIPTION_BILLING_PERIOD_TYPE text The unit of length of a subscription's billing period. MONTHS
SUBSCRIPTION_PERIOD integer

The duration of a subscription period in Subscription Period type units.

1
SUBSCRIPTION_PERIOD_TYPE text The unit of a Subscription Period duration (days [for trials only], months, and years). YEARS
SUBSCRIPTION_PERIOD_TRIAL boolean Indicates whether a subscription is a trial. f
SUBSCRIPTION_LAST_BILLING_DATE timestamp with time zone The last subscription billing date. 2018-11-28
SUBSCRIPTION_NEXT_BILLING_DATE timestamp with time zone

The next subscription billing date.

In some cases, the Next Billing Date may shift, and the duration of a period between the Last Billing Date and the Next Billing Date may not be equal to the Subscription Billing Period.

2018-12-28
SUBSCRIPTION_STATUS text   Active
SUBSCRIPTION_NOTES text All notes for a subscription are exported to one field. The following format is used: Short_Description :: Description. Notes are separated by the | symbol.  
SUBSCRIPTION_ATTRIBUTES text All attributes of a subscription.  
VENDOR_SUBSCRIPTION_NUMBER character varying (80) The ID of a vendor subscription.  

Note: The following fields are only available for the Provider report type.

End-customer account data: attributes of a customer account or a subreseller account acting as a buyer. END_CUSTOMER_ACCOUNT_ID integer The ID of a customer account or a subreseller account acting as a buyer. 1000008012
END_CUSTOMER_ACCOUNT_BSS_APS_ID character varying (38) The APS ID of a related bssAccountInfo APS resource (BSS attributes of an account on the APS bus). 0e1f8a15-c6fd-4069-a958-009b01211b60
END_CUSTOMER_NAME character varying (80)

A customer's Company Name for Business accounts, or First Name, Middle Name, and Last Name for Personal accounts.

Barney Rubble Bubble, Inc.
END_CUSTOMER_ACCOUNT_CURRENCY character varying (5)

The currency of a customer account in which all monetary values are denominated.

May not be equal to RESELLER_ACCOUNT_CURRENCY if the currency a reseller transacts with their parent provider or reseller is not the same as the sales currency they use to charge customers and subresellers.

USD
END_CUSTOMER_ACCOUNT_STATEMENT_DAY integer The statement day of a customer account. Used as a date of consolidated invoicing and billing orders alignment, if configured. 01
END_CUSTOMER_BILLING_CONTACT_NAME text The contact information of a customer.  
END_CUSTOMER_BILLING_CONTACT_EMAIL character varying (100)  
END_CUSTOMER_BILLING_CONTACT_PHONE text  
END_CUSTOMER_BILLING_CONTACT_FAX text  
END_CUSTOMER_ADMIN_CONTACT_NAME text  
END_CUSTOMER_ADMIN_CONTACT_EMAIL character varying (100)  
END_CUSTOMER_ADMIN_CONTACT_PHONE text  
END_CUSTOMER_ADMIN_CONTACT_FAX text  
END_CUSTOMER_TECH_CONTACT_NAME text  
END_CUSTOMER_TECH_CONTACT_EMAIL character varying (100)  
END_CUSTOMER_TECH_CONTACT_PHONE text  
END_CUSTOMER_TECH_CONTACT_FAX text  
END_CUSTOMER_PERS_CONTACT_NAME text  
END_CUSTOMER_PERS_CONTACT_EMAIL character varying (100)  
END_CUSTOMER_PERS_CONTACT_PHONE text  
END_CUSTOMER_PERS_CONTACT_FAX text  
END_CUSTOMER_ADDRESS1 character varying (80) The postal address of a customer. 26 Watson Lane
END_CUSTOMER_ADDRESS2 character varying (80)  
END_CUSTOMER_COUNTRY character varying (2) US
END_CUSTOMER_STATE character varying (80) NC
END_CUSTOMER_CITY character varying (40) Hickory
END_CUSTOMER_ZIP character varying (10) 28601
END_CUSTOMER_TAX_REGISTRATION_ID character varying (20) The tax registration ID of a customer specified in the account information. XXXX01001
END_CUSTOMER_NOTES text All notes for a customer account are exported to one field. The following format is used: Short_Description :: Description. All notes are separated by the vertical bar ( | ) symbol.  
END_CUSTOMER_CLASS character varying (60) The customer class of an account specified in the account information. Default
END_CUSTOMER_ACCOUNT_ATTRIBUTES text An account's custom attributes.  
End-customer subscription's resource data: properties of a resource associated with either or both a customer's and a reseller's charges through a Resource Rate. END_CUSTOMER_RESOURCE_VENDOR_ID  character varying (250) The code or name of a service vendor.  
END_CUSTOMER_RESOURCE_MPN character varying (250) The manufacturer part number (the number of a vendor SKU).  
End-customer charge data: properties of a charge from the reseller to its buyer (either a child end-customer account or a subreseller account). The whole section is empty if a self-use charge is applied, that is, a charge for the service the reseller consumes, not resells. END_CUSTOMER_DETAIL_ID text The internal ID of an Order Detail that represents a charge in an Order. 567331
END_CUSTOMER_CORRECTED_DETAIL_ID text The internal ID of the Order Detail that represents the charge in a corrected Order.  
END_CUSTOMER_DETAIL_SKU character varying (80)

The SKU tag assigned by a reseller to a fee the detail is based on.

Example:

A reseller assigned the "BKI00000123ZU" SKU to a Setup Fee of a 1-Year Subscription Period of an O365 E1 Service Plan.

A customer buys a 1-Year subscription to the O365 E1 Service Plan. The Sales Order will include an Order Detail of the "Plan Setup" type and the "BKI00000123ZU" SKU.

BKI00000123ZU
END_CUSTOMER_DETAIL_TYPE text

The type of a detail or charge. The list of possible detail types is hard-coded.

Examples of detail types are Plan Setup, Plan Renew, Plan Recurring, Resource Recurring, Resource Overuse, and Deposit.

Resource Recurring
END_CUSTOMER_DETAIL_DESCRIPTION character varying (4096)

Auto-generated text description of a charge. It is configurable by the seller per fee type with placeholder support, for example: @@Subscription_Plan_Name@ Recurring.

Subscription #1036066: Exchange Online Archiving for Exchange Online Recurring
END_CUSTOMER_DETAIL_START_DATE timestamp with time zone Represents a charge start date. 2018-11-28
END_CUSTOMER_DETAIL_END_DATE timestamp with time zone

Represents a charge end date.

2018-12-28
END_CUSTOMER_DETAIL_UNIT_PRICE numeric (20,8) The Unit Price in the CUSTOMER_ACCOUNT_CURRENCY currency. 4.49
END_CUSTOMER_DETAIL_UNIT_PRICE_PERIOD_TYPE text Defines a period assumed in Detail Unit Price (can be MONTH or BILLING). BILLING
END_CUSTOMER_DETAIL_QTY numeric (16,2) Defines resource upsize or downsize quantity. Always equals 1 for Plan Renew, Plan Recurring and similar non-resource Detail Types. 1.00
END_CUSTOMER_DETAIL_QTY_UOM character varying (20) The UoM in which usage is reported by an APS application. item
END_CUSTOMER_DETAIL_DURATION numeric (16,8) Duration of an Order Detail. 1
END_CUSTOMER_DETAIL_DISCOUNT_ID integer The internal ID of a Discount applied to a transaction. 123231
END_CUSTOMER_DETAIL_DISCOUNT_AMOUNT numeric (20,8) The absolute value of a Discount applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 5
CUSTOMER_DETAIL_DISCOUNT_RATE numeric (16,4) The discount rate (percentage) applied to a transaction. 10
END_CUSTOMER_DETAIL_DISCOUNT_PROMO_CODE character varying (2048) The Promo Code string provided with an Order (for discounts of the "by Promo Code" type). SALE2019
END_CUSTOMER_DETAIL_PROMOTION_ID integer The internal ID of a Promotion applied to a transaction. 12345676
END_CUSTOMER_DETAIL_PROMOTION_PROMO_CODE character varying (2048) The Promo Code string provided with an Order (for promotions of the "by Promo Code" type). SALE2019
END_CUSTOMER_DETAIL_PROMOTION_VALUE numeric (20,8) The absolute value of a discount applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 15
END_CUSTOMER_DETAIL_TAX_CATEGORY character varying (20)

The human-readable ID of a Tax Category object (on the upper provider or reseller level) associated with a Service Plan or Resource Rate the Detail is related to.

For more information on taxation configuration in CloudBlue Commerce, refer to Configuring Taxation Settings.

SaaS
END_CUSTOMER_DETAIL_INCL_TAX_TOTAL numeric (20,8) The absolute total amount (in the CUSTOMER_ACCOUNT_CURRENCY currency) of Inclusive Taxes collected with a transaction from a customer. Inclusive Taxes are taxes that are assumed to be included in a price of a Service Plan or Resource. 0.0
END_CUSTOMER_DETAIL_EXCL_TAX_TOTAL numeric The absolute total amount (in the CUSTOMER_ACCOUNT_CURRENCY currency) of Exclusive Taxes collected with a transaction from a customer. Exclusive Taxes are taxes assumed not to be included into a price of a Service Plan or Resource and are added on top of a Unit Price. 2.5
END_CUSTOMER_DETAIL_TAX_TOTAL numeric (20,8) The sum of Inclusive and Exclusive detail tax amounts. 2.5
END_CUSTOMER_DETAIL_TAX_RATE numeric (16,4) The effective detail tax rate (calculated backwards from Detail Tax Total and Detail Total). It does not take Order- or Document-level taxes into account. It does not work for non-linear taxes (for example, progressive scale). 10
END_CUSTOMER_DETAIL_TOTAL numeric The total detail amount after discounts and taxes are applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 22.5
END_CUSTOMER_DETAIL_NET_TOTAL numeric The pretax total of an order detail. 20.5
END_CUSTOMER_DETAIL_PROVISIONED_DATE timestamp with time zone The provisioning date of the last item in a customer's order. 2019-08-30
END_CUSTOMER_DETAIL_CURRENCY character varying (5) The transaction currency (may differ from the account currency if is reported by a vendor). EUR
END_CUSTOMER_ACTUAL_DETAIL_START_DATE timestamp with time zone Represents the first date that a service can be used. 2021-06-28
END_CUSTOMER_ACTUAL_DETAIL_END_DATE timestamp with time zone Represents the last date that a service can be used. 2021-07-27
END_CUSTOMER_DISCOUNT_BREAKDOWN JSON

The discount breakdown when several discounts are applied to an order detail.

Note: This field is available only if Rating Engine of version 1.5 or higher is installed.

"DiscountId" : "1", "DiscountName" : "Discount", "DiscountRate" : 33.0000, "DiscountAmount" : 0.33000000, "DiscountSystem" : "BSS", "DiscountAnnotation" : "USD 1.0000 x 1 item33% = USD 0.33"
End-customer order data END_CUSTOMER_ORDER_ID text The ID of an Order that hosts an Order Detail representing a Charge (for end-customer orders and self-use orders of resellers) or the ID of a Reseller Transaction Group (not visible in the UI) for reseller charges associated with end-customer charges. 1000012
END_CUSTOMER_CORRECTED_ORDER_ID integer The ID of the corrected Order created for the CUSTOMER_ORDER_NUMBER order.  
END_CUSTOMER_ORDER_APS_ID character varying (38) The APS ID of the CUSTOMER_ORDER_NUMBER order. 0e1f8a15-c6fd-4069-a958-009b01211b60
END_CUSTOMER_ORDER_NUMBER character varying (20) The Order number assigned using an enumerator or sequence prefix configured by a reseller. SO000521
END_CUSTOMER_ORDER_TYPE character varying (2) An order type, for example, Sales Order, Renewal Order, Change Order, Billing Order, or Cancellation Order. SO
END_CUSTOMER_ORDER_DATE timestamp with time zone The date of the creation of an order. 2018-11-28
END_CUSTOMER_ORDER_CREATED_BY integer A user ID (-1 means the system). 1000014
END_CUSTOMER_ORDER_SALES_PERSON_ID character varying (80) The ID of a salesperson.  
END_CUSTOMER_ORDER_SALES_PERSON_NAME character varying (60) The name of a salesperson.  
END_CUSTOMER_ORDER_SALES_COMMISSION_PCT numeric (16,4) A sales person's sales commission (%).  
END_CUSTOMER_ORDER_SALES_COMMISSION_RECURRING_PCT numeric (16,4) A sales person's recurring payment commission (%).  
END_CUSTOMER_ORDER_SALES_BRANCH_ID character varying (80) The ID of a sales branch.  
END_CUSTOMER_ORDER_SALES_BRANCH_NAME character varying (60) The name of a sales branch.  
END_CUSTOMER_ORDER_NET_TOTAL numeric A pretax order total amount. 22.5
END_CUSTOMER_ORDER_TAX_TOTAL numeric (20,8) The sum of Inclusive and Exclusive Tax amounts on both the detail level and the invoice level. 0.0
END_CUSTOMER_ORDER_TOTAL numeric (20,8) The total order amount after discount and taxes are applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 22.5
END_CUSTOMER_ORDER_ATTRIBUTES text An order's custom attributes.  
End-customer invoice data END_CUSTOMER_INVOICE_ID integer

The ID of an auto-generated invoice in which the charge is billed for a customer.

Because an API may be accessed (or report generated) when a particular charge has not been invoiced yet (for example, for consolidated invoicing where a single invoice is issued to an account on its statement day), the invoice fields may be empty.

1000012
END_CUSTOMER_INVOICE_NUMBER character varying (20) The invoice number assigned using an enumerator or sequence prefix configured by a reseller. 0000021
CUSTOMER_INVOICE_DATE timestamp with time zone The date of the creation of an invoice. 2018-11-28
END_CUSTOMER_INVOICE_DUE_DATE timestamp with time zone The date when an invoice must be paid. 2018-12-28
END_CUSTOMER_INVOICE_NET_TOTAL numeric The pretax total of an invoice. 22.00
END_CUSTOMER_INVOICE_TAX_TOTAL numeric (20,8) The sum of Inclusive and Exclusive Tax amounts on both the detail level and the invoice level. 0.50
END_CUSTOMER_INVOICE_TOTAL numeric (20,8) The total invoice amount after discount and taxes are applied (in the CUSTOMER_ACCOUNT_CURRENCY currency). 22.50
END_CUSTOMER_INVOICE_WEEK_NUMBER double precision The number of a week for a customer invoice date. 35
END_CUSTOMER_ORIGINAL_INVOICE_ID integer The ID of an original invoice to which a correction was applied. 1000015
END_CUSTOMER_PAYMENTS JSON A list of payment document numbers per end customer invoice. ["000010","000011"]

End-customer prices and currencies

Note:
- These fields are available with CloudBlue Commerce 21.5 and later.
- If multi-currency is not active in CloudBlue Commerce or is not set for service plans with active subscriptions, these fields will display billing values.

END_CUSTOMER_DETAIL_SALES_UNIT_PRICE numeric The unit price in the sales currency. 4.99
END_CUSTOMER_DETAIL_SALES_DISCOUNT_AMOUNT numeric The absolute value of a discount applied in the sales currency. 5.00
END_CUSTOMER_DETAIL_SALES_PROMOTION_VALUE numeric The absolute value of a discount applied. 15.00
END_CUSTOMER_DETAIL_SALES_INCL_TAX_TOTAL numeric The absolute total amount of inclusive taxes collected with a transaction. Inclusive taxes are taxes that are assumed to be included in the price of a service plan or resource. 0.00
END_CUSTOMER_DETAIL_SALES_EXCL_TAX_TOTAL numeric The absolute total amount of exclusive taxes collected with a transaction. Exclusive taxes are taxes assumed not to be included in the price of a service plan or resource and are added on top of a unit price. 2.50
END_CUSTOMER_DETAIL_SALES_TAX_TOTAL numeric The sum of inclusive and exclusive tax amounts. 2.50
END_CUSTOMER_DETAIL_SALES_TOTAL numeric The total detail amount after a discount and taxes are applied. 22.5
END_CUSTOMER_DETAIL_SALES_NET_TOTAL numeric The pretax total of an order detail. 20.5
END_CUSTOMER_DETAIL_SALES_CURRENCY character varying (5) The sales currency. EUR
END_CUSTOMER_DETAIL_SALES_EXCHANGE_RATE numeric Exchange rate between billing and sales currencies. 1.5
END_CUSTOMER_DETAIL_SALES_EXCHANGE_TIME timestamp Exchange date. 2022-02-24
CloudBlue, an Ingram Micro business, uses cookies to improve the usability of our site. By continuing to use this site and/or logging in you are accepting the use of these cookies. For more information, visit our Privacy Policy.