Invoice Business Objects
The following Invoice business objects are commonly used in invoice-related queries. Review the descriptions to see how each can be joined with other business objects and what properties they include.
NoteWhen creating queries with invoice business objects, it is recommended to use InvoiceSummary. See Invoice Summary for more information.
CsInvoice
Contains specific invoice data.
WarningIt is recommended to use InvoiceSummary instead of CsInvoice when creating queries needing basic invoice data.
Common Joins
Some common joins include:
Table 42: Viewing common joins for CsInvoice
| Business Object | Relation |
|---|---|
| InvoiceLines | InvoiceLines.Reference Num = CsInvoice.Reference Num |
| NetContactData | NetContactData.Id = CsInvoice.Bt Id |
| TransactionSummary | TransactionSummary.Batch Num = CsInvoice.Batch Num |
| TransactionDetail | TransactionDetail.Bt Id = CsInvoice.Bt Id |
Properties
Table 43: Viewing properties for CsInvoice
| Properties | ||
|---|---|---|
| Adjustments | AR\_Account | Available\_Disc |
| Balance | Batch\_Num | Bill\_To\_CC |
| BT\_Id | Charges | Credit\_Status |
| Credits | Customer\_Name | Customer\_Reference |
| Description | Discount\_Date | Due\_Date |
| Effective\_Date | Has\_Been\_Billed | Install\_Bill\_Date |
| Invoice\_Date | InvoiceKey | Invoice\_Num |
| Invoice\_Type | Is\_Multi\_Org | Note |
| Num\_Lines | Org\_Code | Originating\_Trans\_Num |
| Reference\_Num | Source\_Code | Source\_System |
| St\_Id | Terms\_Code | Print\_Date |
| Accounting\_Method | Payment\_Amount | Original\_Invoice\_Reference\_Num |
| DiscountCode | DiscountTotal | UndiscountedTotal |
InvoiceSummary
Contains specific invoice data and invoices (such as cash dues) that are not included in the invoice tables.
Common Joins
Some common joins include:
Table 44: Viewing common joins for InvoiceSummary
| Business Object | Relation |
|---|---|
| CsInvoice | InvoiceSummary.InvoiceId = CsInvoice.Reference\_Num |
| OrderInvoice | InvoiceSummary.Invoice ID = OrderInvoice.Invoice Reference Number |
| InvoicePaymentSummary | InvoiceSummary.Invoice ID = InvoicePaymentSummary. Invoice Id |
| NetContactData | InvoiceSummary.Bill To Party Id = NetContactData.Id |
| TransactionSummary | InvoiceSummary.Bill To Party Id = TransactionSummary.Bt Id |
Properties
Table 45: Viewing properties for InvoiceSummary
| Properties | ||
|---|---|---|
| AccountingMethod | Balance | BillToPartyId |
| Description | FinancailEntityId | InvoiceAmount |
| InvoiceData | InvoiceNumber | SoldToPartyId |
| DueDate | SOURCE\_SYSTEM | TERMS\_CODE |
| GeneratedOn | BillingLogKey | AdjustmentAmount |
| BillingMemberType | HasMultipleShipToParty | LockedEffectiveDate |
| OriginalInvoiceAmount | PaymentAmount | PendingAdjustmentAmount |
| PendingPaymentAmount | PendingPaymentAdjustmentAr | InvoiceId |
| InvoiceType | InvoiceKey | CustomerReference |
| DiscountCode | DiscountTotal | UndiscountedTotal |
InvoicePurpose
Details all invoice types. Invoice types include the following:
- Regular
- Membership Join
- Membership Renewal
- Past Due Membership Renewal
- Pledge
- Gift
- AutoPay Pledge
- AutoPay Renewal Billing
- AutoPay Billing
- Subscription Fees
- Installment Pledge
- Membership Adjustment
- AutoPay Subscription Fees
Common Joins
Some common joins include:
Table 46: Viewing common joins for InvoicePurpose
| Business Object | Relation |
|---|---|
| InvoiceSummary | InvoiceSummary.Invoice Type = InvoicePurpose.Invoice Purpose Desc |
Properties
Table 47: Viewing properties for InvoicePurpose
| Properties | ||
|---|---|---|
| InvoicePurposeCode | InvoicePurposeDesc | InvoicePurposeName |
InvoiceLineData
Provides information for invoice lines, such as the item, quantity sold, total amount, payments applied, remaining balance, source and promotion codes used, and the ship-to contact's ID.
NoteIt is recommended to use InvoiceLineData as opposed to InvoiceLines.
Common Joins
Some common joins include:
Table 48: Viewing common joins InvoiceLineData
| Business Object | Relation |
|---|---|
| NetContactData | NetContactData.Id = InvoiceLineData.Ship to Party Id |
| CsAddress | CsAddress.Id = InvoiceLineData.Ship to Party Id |
| TransactionDetail | TransactionDetail.St Id = InvoiceLineData.Ship to Party Id |
| CsRegistration | CsRegistration.Ship To Id = InvoiceLineData.Ship to Party Id |
| CsOrders | CsOrders.Ship to Id = InvoiceLineData.Ship to Party Id |
Properties
Table 49: Viewing properties for InvoiceLineData
| Properties | ||
|---|---|---|
| AdjustmentAmount | Balance | BILL\_DATE |
| BillingMemberType | EffectiveDate | ExtendedAmount |
| InvoiceId | InvoiceLineId | IsTaxable |
| ItemId | LineNumber | MonthsPaid |
| Note | PaymentAdjustmentAmount | PaymentAmount |
| PendingAdjustmentAmount | PendingCancellation | PendingPaymentAdjustmentAr |
| PendingPaymentAmount | Quantity | ShipToPartyId |
| ThruDate | UnitPrice | DiscountCode |
| DiscountAmount | UndiscountedPrice | |
InvoiceLines
Contains specific invoice line data. Does not include rows for orders or cash dues invoices.
NoteIt is recommended to use InvoiceLineData as opposed to InvoiceLines.
Common Joins
Some common joins include:
Table 50: Viewing common joins for InvoiceLines
| Business Object | Relation |
|---|---|
| CsInvoice | CsInvoice.Reference Num = InvoiceLines.Reference Num |
| CsProduct | CsProduct.Product Code = InvoiceLines.Product Code |
Properties
Table 51: Viewing properties for InvoiceLines
| Properties | ||
|---|---|---|
| ADJUSTMENTS | APPEAL\_CODE | AR\_COUNT |
| BALANCE | BILL\_FROM | BILL\_QTY |
| BILL\_THRU | CAMPAIGN\_CODE | CHARGES |
| CREDITS | FAIR\_MARKET\_VALUE | IS\_FR\_ITEM |
| LINE\_NUM | ORG\_CODE | ORIGINAL\_CHARGES |
| PAID\_FROM | PAID\_QTY | PAID\_THRU |
| PAYMENT\_AMOUNT | PAYMENT\_CODE | REFERENCE\_NUM |
| ST\_ID | TAX\_1 | TAX\_AUTHORITY |
| TAX\_RATE | TIME\_STAMP | UNIT\_PRICE |
| DISCOUNT\_AMOUNT | DISCOUNT\_CODE | UNDISCOUNTED\_PRICE |
InvoiceNumber
Returns separate rows for each installment of an installment pledge. When joining this business object, it is recommended to join on either the InvoiceNumber or InvoiceReferenceNumber property.
Common Joins
Some common joins include:
Table 52: Viewing common joins for InvoiceNumber
| Business Object | Relation |
|---|---|
| InvoiceScheduledPayment | InvoiceScheduledPayment.Invoice Reference Number = InvoiceNumber.Invoice Reference Number |
| OrderInvoice | OrderInvoice.Invoice Reference Number = InvoiceNumber.Invoice Reference Number |
| CsPledges | CsPledges.Invoice Reference Number = InvoiceNumber.Invoice Reference Number |
| CsOrders | CsOrders.Invoice Reference Number = InvoiceNumber.Invoice Reference Number |
| EventInvoice | EventInvoice.Invoice Number = InvoiceNumber. Invoice Number |
Properties
Table 53: Viewing properties for InvoiceNumber
| Properties | |
|---|---|
| AccountingMethod | InvoiceNumber |
| InvoiceReferenceNumber | InvoiceId |
EventInvoice
Contains invoice data related to events.
Common Joins
Some common joins include:
Table 54: Viewing common joins for EventInvoice
| Business Object | Relation |
|---|---|
| CsEvents | CsEvents.BillToId = EventInvoice.Bill To ID = |
| NetContactData | NetContactData.Bill To ID = EventInvoice.Bill To ID |
In addition to these common joins, EventInvoice is the primary business object in the following queries:
- Event registration has invoice ($/Common/Tasks/Queries/Staff dashboard alerts/Event registration has invoice)
- Registration invoice ($/EventManagement/DefaultSystem/Queries/Registration details/Registration Invoices)
Properties
Table 55: Viewing properties for EventInvoice
| Properties | |||
|---|---|---|---|
| Balance | BillToCompany | BillToFullAddress | BillToFullName |
| BillToId | BillToTitle | CancellationFee | CustomerReference |
| DiscountCode | DiscountRate | EventCity | EventCode |
| EventCountry | EventEndDate | EventStateProv | EventTitle |
| GeneratedOn | InvoiceDate | InvoiceDesc | InvoiceNumber |
| InvoiceReferenceNum | LineTotal | OrderNumber | OriginalInvoiceNum |
| RegistrantCompany | RegistrantFullAddress | RegistrantFullName | RegistrantID |
| RegistrantSortName | RegistrantTitle | RegistrationDate | Tax |
| TermsCode | TermsDesc | TotalCharges | TotalPayments |
| VatCode1 | VatCode2 | VatCode3 | VatDesc1 |
| VatDesc2 | VatDesc3 | VatNet1 | VatNet2 |
| VatNet3 | VatRate1 | VatRate2 | VatRate3 |
| VatTot1 | VatTot2 | VatTot3 | VatVat1 |
| VatVat2 | VatVat3 | EventBeginDate | ProjectedInvoiceNumber |
InvoiceScheduledPayment
Lists individual scheduled payments for installment pledge invoices.
Common Joins
Some common joins include:
Table 56: Viewing common joins for InvoiceScheduledPayment
| Business Object | Relation |
|---|---|
| TransactionDetail | TransactionDetail.Invoice Reference Num = InvoiceScheduledPayment.Native Invoice Id |
| CsPledges | CsPledges.Invoice Reference Number = InvoiceScheduledPayment.Invoice Reference Number |
| InvoiceSummary | InvoiceSummary.Invoice Id = InvoiceScheduledPayment.Invoice ID |
| InvoiceNumber | InvoiceNumber.Invoice Reference Number = InvoiceScheduledPayment.Invoice Reference Number |
| PaymentApplicationSummary | PaymentApplicationSummary.Invoice ID = InvoiceScheduledPayment.Native Invoice Id |
Properties
Table 57: Viewing properties forInvoiceScheduledPayment
| Properties | ||
|---|---|---|
| Balance | Description | DueDate |
| InvoiceDescription | InvoiceId | NativeInvoiceId |
| PaymentNumber | PendingPaymentSchedulePayr | ScheduledPaymentId |
OrderInvoice
Lists all order numbers and their related invoice reference numbers.
Common Joins
Some common joins include:
Table 58: Viewing common joins for OrderInvoice
| Business Object | Relation |
|---|---|
| InvoiceSummary | OrderInvoice.Invoice Reference Number = InvoiceSummary.Invoice ID |
| CsOrders | CsOrders.Order Number = OrderInvoice.Order Number Or CsOrders.Invoice Reference Number = OrderInvoice.Invoice Reference Number |
| CsOrderLines | CsOrdersLines.Order Number = OrderInvoice.Order Number |
Properties
Table 59: Viewing properties for OrderInvoice
| Properties | |
|---|---|
| OrderNumber | InvoiceReferenceNumber |