Search the Aria Knowledgebase for
User Documentation, APIs, SDKs, and more!



 

Home > Aria Crescendo Documentation > Data Extract Documentation > Data Extract - Release 2.1 (Beta) - Logical Object Model

Data Extract - Release 2.1 (Beta) - Logical Object Model

 

 

This article applies to:Aria Crescendo

Overview

Release 2.1 (Beta) of Data Extract supports all financial transactions. The following provides detailed information regarding the Logical Object Model supporting Release 2.1 of this functionality. See Logical Object Model (Relations Only) for a graphical depiction of Release 2.1 objects included in this service.

Tips for Using This Document

This document is built using a series of links (in blue) that you can use to easily navigate to various sections of the document and return back to your original place. Single-click on a link to access that section of the document.  A smaller contextual help overlay window is opened in the middle of the screen as shown below:

Help Overlay Window.jpg

  1. Use the Back button, or the window's X to exit the window and return back to your previous place in the document.
  2. Single-click on any link within the window to go directly to that section of the document.

Aria Billing Logical Model

Table of Contents

General Datatypes

Primitives

Field Type Name Description
Text <max-size> Freeform text. <max-size> is an optional indicator. Default is no limit.
BigInt Range: +- 2^32 (+- 9223372036854775807)
Int Range: +- 2^16 (+- 2147483647)
SmallInt Range: +- 2^8 (+-32767)
Decimal Numerical representation with decimal part.
Boolean true or false
Date A date with no time element.
DateTime A timestamp.

Enumerated Types

Enumerated field types can be:

  • Text enumerated types - represented by defined Text values. Examples are values of Currency_Code, such as "usd", "cad", or "eur".
  • Numeric enumerated types are represented by defined Int values. Examples are values of Transaction_Type such as 2 or 15.
  • Configurable Enumerated Types are ones where the specific values may vary according to a client's Aria setup. These have a text or numeric identifier code combined with a corresponding display label. Values of this type are represented by an object with this structure:    
Field Name Field Type
code Int
text Text

Note:  Although both "code" and "text" fields are always included together, in some cases one or the other may have "null" as the               value.

Examples:

Enumerated Type Example JSON

Enumerated Type Example JSON Type Description
Country_Code "eur" text enumerable type.
Transaction_Type 13 numeric enumerable type.
Collection_Status { "code": 3, "text": "Approved" } configurable numeric enumerable type.
Pay_Method_Type { "code": 1, "text": "Credit Card" } configurable numeric enumerable type.
Credit_Reason { "code": 24, "text": "Employee Account" } configurable numeric enumerable type.
Invoice_Type { "code": "F", "text": "Full Invoice" } configurable text enumerable type.

Note:  Labels associated with Enumerated Datatypes are subject to change, and therefore should not be used                                              programmatically as static values.  


Entities

Entities are objects that may be identified as references. (See Ref.) Not all objects are entities, but all entities are objects.

General Enumerated Types

Datatype

A text enumerated type. The value is one of the datatypes defined in this document.

Examples:

"Account" "Transaction" "Plan_Instance"

Country_Code

A text enumerated type. Value is a text string. Defined by ISO 3166-1 ALPHA-2 (the 2 character code)

Examples:

Value Country
"US" United States of America
"GB" Great Britain
"DK" Denmark
Currency_Code

A text enumerated type. Value is text string. Defined by ISO 4217.

Value Currency
"usd" United States dollar
"eur" Euro
"jpy" Japanese yen

Objects

Ref

An object. Refs are references to entities. Refs combine an entity object type and the id values that identify that object.

The specific ids vary by entity type and are documented for each entity datatype. Some types have multiple ids each of which can uniquely identify the entity by itself. An example is Account, where the "acct_no", "client_acct_id" and "userid" fields can each uniquely identify the same account by themselves. Other types require a combination of ids to fully identify an object. An example of this is Payment_Method, where a combination of both "acct_no" and "payment_method_no" are necessary in order to identify a specific payment method object.

Field name Datatype

type Datatype
ids Object

Example in JSON

{ "type": "Account", "ids": { "acct_no": 543262, "client_acct_id": "john.doe", "userid": "991124" } }
{ "type": "Plan_Instance", "ids": { "plan_instance_no": 959239423, "client_plan_instance_id": "992.2221-z" } }
{ "type": "Transaction", "ids": { "transaction_no": 623496 } }
{ "type": "Payment_Method", "ids": { "acct_no": 543262, "payment_method_no": 3 } }

Supplemental Field

An object.

Supplemental fields are name/value pairs that are tagged onto various other objects, typically as an array of elements in a "supp_fields" field.

Field name Datatype

field_name Text
field_value Text

Example in JSON

{
        "transaction_no":  2398523,
        "transaction_supp_fields": [
                { "field_name": "priority",            "field_value": "4"  }
                { "field_name": "handled_by",    "field_value": "JR-2" }
        ]
}

 

Financial Datatypes

Entities

Financial Transaction Types 
Transaction Type (Value) Description (Label) Financial Transaction
General Transaction (incorporates the Financial Transactions listed below)
2 External Payment External Payment Transaction
3 Electronic Payment Electronic Payment Transaction
4 Balance Transfer To Balance Transfer Transaction
5 Balance Transfer From Balance Transfer Transaction
6 Write-Off Write-Off Transaction
8 Refund Related Reversal Invoice Reversal Line Transaction
9 Balance Forward Balance Forward Transaction
10 Cash Credit Cash Credit Transaction
12 Electronic Refund Disbursement Electronic Refund Transaction
13 Check Refund Disbursement Check Refund Transaction
15 Dunning Charge Dunning Charge Transaction
18 Negative Balance Forward Balance Forward Transaction
21 Invoice Line Charge Invoice Line Transaction
22 Invoice Line Credit Invoice Line Transaction
24 Credit Line Memo Credit Memo Line Transaction

Note: Voided transactions of the types shown above have their corresponding negative values. For example, a voided "External Payment" Payment Transaction has a Transaction Type value of -2. Two data elements (<voided_transaction> and <applied_transactions> are streamed for these voided transaction types in the General Transaction.

General Financial Transaction

Prefix is "TX". Key is transaction_no. Some fields only apply for certain Transaction_Type values.

Field Name  Field  Type / Datatype Trans
Type
Field  Description / Reference 
transaction_no BigInt All Aria-assigned transaction number.
transaction_type Transaction_Type All The type of this transaction. 
create_date DateTime All Timestamp when the transaction was recorded in the system.
source_no BigInt All Aria-assigned ID of the transaction detail record 
(e.g. invoice_no, write_off_no, etc.).
acct Ref<Account> All

Account to which this transaction applies.

currency_cd Currency_Code All

Currency of the amount indicated in the transaction.

amount Decimal All Total monetary value of the transaction.
applied_amount Decimal All Total monetary amount applied to any other transactions.
fully_applied_date DateTime All Timestamp when the transaction was fully offset by another transaction.
statement Ref<Statement> All

Reference to the Statement on which this transaction is represented. 

master_plan_instance Ref<Plan_Instance> All Master plan instance to which this transaction applies. May be null if none apply. 
api_receipt_id Text All Aria-assigned id if the transaction was created via an API call. 
transaction_supp_fields Array of <Supplemental_Field> All An array of optional client-specific transaction qualifiers (supplemental fields and field values) that can be inputted in certain APIs (i.e. when issuing refunds, creating orders, assigning cash credits, etc.) for the given transaction ID.
voided_transaction Ref<Transaction> All If this transaction is a voiding transaction, as indicted by a negative <transaction_type>, this element refers to the transaction that was voided.
voiding_transaction Ref<Transaction> All If this transaction was voided, this element refers to the transaction that represents the voiding.
applied_transactions Array of Ref<Transaction> All

References to all transactions to which this transaction was applied.

External Payment Transaction detail fields

Additional fields relevant only for external (i.e. check) payment transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
payment_date DateTime 2 Timestamp when the payment was recorded in the system.
left_to_apply Decimal 2 Amount of the payment left to apply to future charges.
reference_id Text<40> 2 Check number or credit card suffix associated with the payment. 
Electronic Payment Transaction detail fields

Additional fields relevant only for electronic (i.e. Credit Card, ACH, etc.) payment transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
payment_date DateTime 3 Timestamp when the payment was made.
left_to_apply Decimal 3 Amount of the payment left to apply to future charges.
collection_status Collection_Status 3

Unique identifier for the collection status of a payment.

payment_method Ref<Payment_Method> 3

Payment method used by the account to make this electronic payment.

processor_payment_
id

Text<1000>

3 Payment processor assigned ID of the payment.
payment_processor Payment_Processor 3

Payment processor that processed the payment. 

pay_method_type Pay_Method_Type 3 Payment method applied to the transaction. (i.e. Credit Card, ACH, Net Terms XX, etc.)
proc_status_cd Text<20> 3 Alphanumeric response code provided by the payment processor related to the payment.
proc_status_text Text 3 Description provided by the payment processor related to the payment. 
Balance Transfer detail fields

Additional fields relevant only for balance transfer transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
from_acct Ref<Account> 4, 5

Account from which the amount has been transferred to another account for payment.

from_master_plan_
instance
Ref<Plan_Instance> 4, 5 Plan instance identifier applied to the originating transaction from which the amount has been transferred to another account for payment. 
to_acct Ref<Account> 4, 5

Account to which the amount has been transferred from another account for payment.

to_master_plan_
instance

Ref<Plan_Instance> 4, 5 Plan instance identifier applied to the destination transaction to which the amount has been transferred from another account for payment.
invoice Ref<Invoice> 4, 5 Invoice to which the balance transfer is applied.
Write-Off Transaction detail fields 

Additional fields relevant only for write-off transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
writeoff_date DateTime 6 Timestamp when the write-off was created.
comments Text 6 Additional explanatory text relating to the write-off. 
writeoff_reason Writeoff_Reason 6 Reason for the writeoff.
secondary_writeoff_
reason
Writeoff_Reason 6 Secondary reason for the writeoff.
invoice Ref<Invoice> 6 Invoice to which the writeoff is applied.
Invoice Reversal Line Transaction detail fields

Additional fields relevant only for invoice reversal line transactions.

Field Name Field Type / Datatype Trans
Type(s)
Field Description / Reference
line_no SmallInt 8 Sequential line number for the reversal line item, Initial record value is always 1.
invoice_line Ref<Transaction> 8 Line number for the invoice sequence number to which a reversal line has been issued.
invoice Ref<Invoice> 8 Invoice to which the reversal is applied.
Balance Forward detail fields

Additional fields relevant only for balance forward transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
comments Text 9, 18 Additional explanatory text relating to the balance transfer.
Cash Credit Transaction detail fields

Additional fields relevant only for cash credit transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
comments Text 10 Additional explanatory text relating to the cash credit.
credit_reason Credit_Reason 10

Reason for the cash credit.

invoice Ref<Invoice> 10 Invoice to which the cash credit is applied.
Electronic Refund Transaction detail fields

Additional fields relevant only for electronic refund transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
refund_reason Refund_Reason 12 Reason for the refund.
reversal Ref<Invoice_Reversal> 12 Transaction_id for the refund.
payment_method Ref<Payment_Method> 12

Payment method used by the account to make this electronic payment.

pay_method_type Pay_Method_Type 12 Payment method applied to the transaction. (i.e. Credit Card, ACH, Net Terms XX, etc.)
Check Refund Transaction detail fields

Additional fields relevant only for check refund transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
process_date DateTime 13 Timestamp when the check refund was created.
comments Text 13 Client specific comment related to the refund.
refund_reason

Refund_Reason

13

Reason for the refund.

reference_id Text<40> 13 Check number associated to the refund.

Invoice Line Transaction detail fields

Additional fields relevant only for invoice line items. 

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
invoice Ref<Invoice> 21, 22 Reference to invoice in which this invoice line is included. Not included when the line is sent as an element of the same invoice.
line_no BigInt 21, 22 Sequential line number of the line item. Initial record value is always 1.
start_date Date 21, 22 Starting date for this line item.
end_date Date 21, 22 End date for this line item.
comments Text 21, 22

Text description of this line item.

usage_units Decimal 21, 22 Number of units of this service code billed on this line item.
usage_rate Decimal 21, 22 Rate per unit billed.
credit_reason Credit_Reason 21, 22 Reason associated to any applicable applied credits. 
plan Ref<Plan> 21, 22

Plan applied to this line item.

service Ref<Service> 21, 22 Service associated to the line item. 
usage_type Ref<Usage_Type> 21, 22 Usage Type associated to the line item.
order_line Ref<Order_Line> 21, 22 A non-subscription offering associated to the line item.
base_plan_units Decimal 21, 22 Base number of units for the line item.
proration_factor Decimal 21, 22 Specifies the percentage of the line_base_units billed.
proration_text Text 21, 22 Specifies the prorated days in total days.
proration_remaining_days SmallInt 21, 22 Number of days remaining in the period for proration calculation of the invoice line. 
advance_billing_
period_total_days
SmallInt 21, 22 Total days of period in the invoice.
plan_instance Ref<Plan_Instance> 21, 22 Plan instance associated with the invoice line item. Note that this may be a master plan instance or a supplemental plan instance. 
purchase_order_num Text(1000) 21, 22 Purchase order number applied to the plan instance.
rate_schedule Ref<Rate_Schedule> 21, 22

Rate schedule used to generate this invoice line item.

rate_schedule_
service_tier
SmallInt 21, 22 Sequential number of the rate tier applied with the rate schedule used to generate this invoice line item.
credit_coupon Ref<Coupon> 21, 22 Coupon applied to the line item transaction.
tax_related_ind Boolean 21, 22 Indicates whether the invoice line item is related to tax. Invoice lines that are a tax charge or a credit applied to a tax charge will be returned as "true".
service_credit_
source_transaction
Ref<Transaction> 21, 22

Transaction applied to the original invoice that was the source of the service credit.

service_credit_
applied_transaction
Ref<Transaction> 21, 22 Transaction from this invoice against which this service credit was applied.
Credit Memo Line Transaction detail fields

Additional fields relevant only for credit memo line transactions.

Field Name Field  Type / Datatype Trans
Type(s)
Field  Description / Reference
line_no SmallInt 24 Sequential number for the credit memo line item. Initial record value is always 1.
invoice_line Ref<Transaction> 24 Invoice line transaction to which this credit memo line has been applied.
Invoice

An entity. Ids: invoice_no.

Field Name Field Type / Datatype Field Description / Reference
invoice_no BigInt Aria-assigned unique identifier of a given invoice.
bill_date DateTime Timestamp when the invoice was approved.
paid_date DateTime Timestamp when the invoice is fully satisfied.
update_date DateTime Timestamp when the invoice was last modified.
recurring_bill_from Date Date for the start of the recurring period of the invoice. 
recurring_bill_thru Date Date for the end of the recurring period of the invoice.
usage_from_date Date Date for the start of the usage period of the invoice.
usage_thru_date Date Date for the end of the usage period of the invoice.
currency_cd Currency_Code

Currency of the amount indicated in the transaction.

amount Decimal Monetary value of the invoice.
invoice_balance_forward Decimal Previous balance on an account that was carried over to the next billing period.
total_due Decimal Monetary value outstanding on the invoice.
invoice_type Invoice_Type Invoice type and description.
custom_status_label Text Value allowed for client-specific custom invoice status that can be edited at the invoice or pending invoice level.
custom_status_desc Text Description of the client-specific custom invoice status.
acct Ref<Account> Account to which this invoice applies.
billing_group Ref<Billing_Group>

Billing group number associated to the invoice.

statement Ref<Statement> The statement related to this invoice.
invoice_comments Text Any client-defined comments entered on an invoice by a Customer Service Representative (CSR) of by the system. 
additional_comments Text Comments entered by a CSR when placing an order OR passed into the <order_comments> field in the create_order_m API.
client_notes Text Client specific custom invoice notes that can be edited at the invoice or pending invoice level.
pay_method_type Pay_Method_Type Payment method associated with the transaction. (i.e. Credit Card, ACH, Net Terms XX, etc.)
original_invoice Ref<Invoice> Original invoice number (for a rebilled invoice). The original invoice number is the predecessor invoice, which could be a rebill.
rebill_invoice Ref<Invoice> Invoice number that rebilled for this invoice.
taxation_address Contact Address of the taxed contact.
lines Array of Transaction Array of invoice line items.
tax_details Array of Tax_Detail Array of tax details for this invoice.
Credit_Memo

An entity. Ids: credit_memo_no.

Field Name Field Type / Datatype Field Description / Reference
credit_memo_no BigInt Unique identifier for the credit memo.
acct Ref<Account> Account to which the credit memo applies.
currency_cd Currency_Code Currency of the amount indicated in the transaction.
amount Decimal Monetary amount of the credit memo.
create_date DateTime Timestamp when the credit memo was created.
credit_reason Credit_Reason

Reason code associated to any applied credit memos.

lines Array of Ref<Transaction> Array of credit memo line items.
tax_details Array of Tax_Detail

Array of tax details for this credit memo.

invoice Ref<Invoice> Invoice to which the credit memo was applied. 
Invoice_Reversal

An entity. Ids: reversal_no.

Field Name Field Type / Datatype Field Description / Reference
reversal_no BigInt Aria-assigned unique identifier of the reversal transaction.
acct Ref<Account> Account to which this invoice reversal applies.
currency_cd Currency_Code Currency of the amount indicated in the transaction.
amount Decimal Monetary amount of the reversal.
create_date DateTime Timestamp when the reversal was created.
lines Array of Transactions Array of reversal line items.
tax_details Array of Tax_Detail Array of tax detail.
comments Text Additional explanatory comments relating to the invoice reversal.
Tax_Detail

An object.

Field Name Field Type / Datatype Field Description / Reference
tax_detail_line_no BigInt Line number associated with each tax detail record.
summary_line Ref<Transaction> Tax line on the invoice which includes the tax amount associated with this tax detail line. 
taxed_line Ref<Transaction> Invoice line item for which the tax for this tax detail line was calculated. 
amount Decimal Monetary value of the tax applied for the given tax type.
tax_rate Decimal Rate at which the tax was calculated for the tax type used by the tax engine.
taxed_line_was_tax_
inclusive
Boolean Indicates whether or not the invoice line amount was tax inclusive.
tax_authority_level Tax_Authority_Level

Tax jurisdiction code.

external_tax_type_id

Text Identifier of the tax type returned by the tax engine.
external_tax_type_
description
Text Description of the tax type returned by the tax engine.
external_category_text Text Category of the tax type returned by the tax engine.
external_jurisdiction_
name
Text Jurisdiction name returned by the tax engine.
external_tax_summary_
text
Text Summary text returned by the tax engine.
Statement

An entity. Ids: statement_no. 

Order

An entity. Ids: order_no.

Field Name Field Type Field Description / Reference
order_no BigInt Aria-assigned unique order number.
status Order_Status  Status label of the order.
create_date DateTime Timestamp when the order was created.
update_date DateTime Timestamp when the order was modified.
comments Text Client specific comment related to the order.
acct Ref<Account>

Account to which this order applies.

plan_instance Ref<Plan_Instance>

Plan instance associated to the order.

invoice Ref<Invoice> Invoice associated with the order.
currency_cd Currency_Code Currency of the amount indicated in the transaction. 
amount Decimal Monetary value of the order.
client_order_id Text Client-order ID for the order.
order_create_client_
receipt_id
Text<50> A client_receipt_id is an accepted input in the create_order_m API. If the order is created with this input, it is returned here.
order_status_client_
receipt_id
Text<50> The API receipt ID associated with the most recent status change on the order.
statement_message Text Alternate line description.
lines Array of Order_Line Array of order lines for the order.
Order_Line

An entity. Ids: order_no, line_no. "order_no" and "line_no" in combination uniquely identify an order line object.

Field Name Field Type Field Description / Reference
order Ref<Order> Aria-assigned ID of the order.
See<Order>.
line_no SmallInt Line number of the particular row of the order.
item Ref<Item>

Order item number.

units Decimal Number of units of the SKU purchased on the order.
unit_amount Decimal Monetary charge per unit of the order line item.
line_amount Decimal Total monetary charge for the order line item.
label Text Label or short description of the order line item.
long_desc Text Long description of the order line item.
alt_label Text Alternate label or description that was used during invoicing. 
line_comments Text Client-defined comments from a CSR or automated system for the order line item.
rate_schedule Ref<Rate_Schedule>

Rate schedule associated with the order line item.

item_dest_contact Ref<Contact> Contact associated with the order line item.
client_sku Text Client-defined SKU of the order line item.
service_location Ref<Service_Location> Service location associated with the order line item.
transaction Ref<Transaction> Invoice line that bills for this order line.

Enumerated Types

Collection_Status

A configurable numeric enumerated type. Value is a {code, text} object.

Code Label
-1 Timeout
0 Requested
1 Authorized
2 Submitted
3 Approved
4 Reversed
5 Failed
6 Queued
7 Assigned
Credit_Reason

A configurable numeric enumerated type. Value is a {code, text} object.

Some values are globally defined. Others may be added by client configuration.

Code Label
1 General Credit / Other
2 Inadequate Service Delivery
3 Billing / Pricing Issue
4 Service no longer desired
5 Customer Dissatisfaction
6 Installation Issue
8 Shipping Error
9 Customer Return
11 System Testing
98 Prepay Credit Reconciliation
200 Automatic credit creation due to purchase of item with "Automatic Service Credit Creation" flag set.
9999 Coupon Application

Invoice_Type

A configurable text enumerated type. Value is a {code, text} object.

Code Label
F Full Invoice
P Proration Invoice
O Order Based Invoice
C Combined Invoice
H Hybrid Invoice
R Rebill Invoice
Pay_Method_Type

A configurable numeric enumerated type. Value is a {code, text} object.

Code Label
-1 External Payment
0 Other / None
1 Credit Card
2 Electronic Check (ACH)
3 Pre-Paid
11 PayPal Express Checkout
13 Tokenized Credit Card
14 Purchase Power
20 NETS
21 FIK
26 Direct Debit
27 Direct Debit - IBAN
28 Direct Debit - BBAN
29 Reserve Account
30 Boleto Bancario
31 Net Terms 27
32 iDEAL
33 WebMoney
34 Yandex
35 PaySafeCard
36 SOFORT
37 Tokenized Direct Debit
38 ApplePay - Indirect
39 PayPal Express Checkout - Indirect
40 Merchant Specific Gift Card

Note: New Pay_Method_Type's codes / labels are added periodically to the system.

Payment_Processor

A configurable numeric enumerated type. Value is a {code, text} object.

Code Label
0 Other
1 Chase Paymentech
2 PayPal Payflow Pro
4 CyberSource
5 Authorize.Net
15 PayPal Express Checkout
16 GlobalCollect (To Be Deprecated)
19 PayJunction
20 DIBS Payment Services
21 Vantiv (Litle)
22 PB Purchase Power
24 NETS Collect
25 Generic
26 MercuryPay
27 ModusLink Global Payment System
28 Braintree
29 WorldPay
30 First Data PayPoint
31 Merchant e-Solutions
32 Paymetric
33 TNS
34 Adyen
35 First Data Payeezy
36 Ingenico (Formerly GlobalCollect)

Note: New Payment_Processor codes / labels are added periodically to the system.

Order_Status

A configurable numeric enumerated type. Value is a {code, text} object.

Code Label
-2 Order Cancelled
-1 Order Rejected
0 Order Entry in Progress
1 Order Entered
2 Order Placed
3 Order Filled
4 Order Billed
5 Order Held
Refund_Reason

A configurable numeric enumerated type. Value is a {code, text} object.

Some values are globally defined. Others may be added by client configuration. 

Code Label
1 Account Charged in Error
2 Goods/services not delivered
3 Customer dissatisfaction
4 Cancellation of pre-paid service
5 Good Will
6 Overpayment/Duplicate payment
7 Wrong/undesired payment source charged
99999999 Other
Tax_Authority_Level

A configurable numeric enumerated type. Value is a {code, text} object.

Code Label
0 country
1 state
2 county
3 city
4 unincorporated
5 district
Transaction_Type

A numeric enumerated type. Value is an Int.

Code Label
2 External Payment
3 Electronic Payment
4 Balance Transfer To
5 Balance Transfer From
6 Write Off
8 Refund Related Reversal
9 Balance Forward
10 Cash Credit
12 Electronic Refund Disbursement
13 Check Refund Disbursement
15 Dunning Charge
18 Negative Balance Forward
21 Invoice Line Charge
22 Invoice Line Credit
24 Credit Memo Line
Writeoff_Reason

A configurable numeric enumerated type. Value is a {code, text} object.

Code Label
0 Bad Debt
1 Good Will
2 Billing Error
3 Sales Return
4 Promotional Discount
5 Other
9001 Charge Dispute Hold
9999 System-enforced conversion of dispute to permanent write-off.

Account Datatypes

Entities

Account

An entity. Ids: acct_no, userid, client_acct_id. "acct_no", "userid", and "client_acct_id" each independently identify the same account object. 

Plan_Instance

An entity. Ids: plan_instance_no, client_plan_instance_id. "plan_instance_no" and "client_plan_instance_id" each independently identify the same plan instance object.

Billing_Group

An entity. Ids: billing_group_no.

Dunning_Group

An entity. Ids: dunning_group_no.

Payment_Method

An entity. Ids: acct_no, payment_method_no. "acct_no" and "payment_method_no"  in combination uniquely identify a payment method object.

Rate_Schedule

An entity. Ids: schedule_no, client_rate_schedule_id. "schedule_no" and "client_rate_schedule_id" each independently identify the same rate schedule object.

Contact

An entity. Ids: contact_no.

Field Name Field Type Field Description / Reference
contact_no BigInt Aria-assigned contact ID number.
acct Ref<Account> Account to which this contact applies.
first_name Text First name of contact.
middle_initial Text Middle initial of contact.
last_name Text Last name of contact.
company_name Text Company name of contact.
birth_date Date Birth date of contact.
email Text Email address of contact.
street Text Street address of contact.
city Text City of contact.
state_prov Text State or Province of contact.
locality Text Locality of the contact. Used instead of <state_prov> to identify the state, province, or other local jurisdiction as appropriate for addresses in all countries other than United States, Australia, and Canada.
postal_cd Text Postal code of contact.
country_cd Country_Code Country of contact.
phone Text Phone number of contact.
phone_ext Text Phone number extension of contact
cell_phone Text Cell phone of contact.
work_phone Text Work phone of contact.
work_phone_ext Text Work phone extension of contact.
fax Text Fax number of contact.

Product Catalog Datatypes

Entities

Service

An entity. Ids: service_no, client_service_id. "service_no" and "client_service_id" each independently identify the same service object.

Service_Location

An entity. Ids: service_location_no, client_service_location_id. "service_location_no" and "client_service_location_id" eaach independently identify the same service location object.

Plan

An entity. Ids: plan_no, client_plan_id. "plan_no" and "client_plan_id" each independently identify the same plan obkect.

Usage_Type

An entity. Ids: usage_type, usage_type_cd. "usage_type" and "usage_type_cd" each independently identify the same usage type object.

Item

An entity. Ids: item_no, client_sku. "item_no" and "client_sku" each independently identify the same item object.

Coupon

An entity. Ids: coupon_cd.

 

Last modified

Tags

This page has no custom tags.

Classifications

This page has no classifications.