Documentation
Documentation

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.

📘

Note

When creating queries with invoice business objects, it is recommended to use InvoiceSummary. See Invoice Summary for more information.

CsInvoice

Contains specific invoice data.

🚧

Warning

It is recommended to use InvoiceSummary instead of CsInvoice when creating queries needing basic invoice data.

Common Joins

  • InvoiceLines.Reference Num = CsInvoice.Reference Num
  • NetContactData.Id = CsInvoice.Bt Id
  • TransactionSummary.Batch Num = CsInvoice.Batch Num
  • TransactionDetail.Bt Id = CsInvoice.Bt Id

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
  • BillingMemberType

InvoiceSummary

Contains specific invoice data and invoices (such as cash dues) that are not included in the invoice tables.

Common Joins

  • InvoiceSummary.InvoiceId = CsInvoice.Reference_Num
  • InvoiceSummary.Invoice ID = OrderInvoice.Invoice Reference Number
  • InvoiceSummary.Invoice ID = InvoicePaymentSummary. Invoice Id
  • InvoiceSummary.Bill To Party Id = NetContactData.Id
  • InvoiceSummary.Bill To Party Id = TransactionSummary.Bt Id

Properties

  • AccountingMethod
  • Balance
  • BillToPartyId
  • Description
  • FinancialEntityId
  • 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

  • InvoiceSummary.Invoice Type = InvoicePurpose.Invoice Purpose Desc

Properties

  • InvoicePurposeCode
  • 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.

📘

Note

It is recommended to use InvoiceLineData as opposed to InvoiceLines.

Common Joins

  • NetContactData.Id = InvoiceLineData.Ship to Party Id
  • CsAddress.Id = InvoiceLineData.Ship to Party Id
  • TransactionDetail.St Id = InvoiceLineData.Ship to Party Id
  • CsRegistration.Ship To Id = InvoiceLineData.Ship to Party Id
  • CsOrders.Ship to Id = InvoiceLineData.Ship to Party Id

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.

📘

Note

It is recommended to use InvoiceLineData as opposed to InvoiceLines.

Common Joins

  • CsInvoice.Reference Num = InvoiceLines.Reference Num
  • CsProduct.Product Code = InvoiceLines.Product Code

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

  • InvoiceScheduledPayment.Invoice Reference Number = InvoiceNumber.Invoice Reference Number
  • OrderInvoice.Invoice Reference Number = InvoiceNumber.Invoice Reference Number
  • CsPledges.Invoice Reference Number = InvoiceNumber.Invoice Reference Number
  • CsOrders.Invoice Reference Number = InvoiceNumber.Invoice Reference Number
  • EventInvoice.Invoice Number = InvoiceNumber. Invoice Number

Properties

  • AccountingMethod
  • InvoiceNumber
  • InvoiceReferenceNumber
  • InvoiceId

EventInvoice

Contains invoice data related to events.

Common Joins

  • CsEvents.BillToId = EventInvoice.Bill To ID
  • 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

  • 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
  • TotalPayment
  • 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

  • TransactionDetail.Invoice Reference Num = InvoiceScheduledPayment.Native Invoice Id
  • CsPledges.Invoice Reference Number = InvoiceScheduledPayment.Invoice Reference Number
  • InvoiceSummary.Invoice Id = InvoiceScheduledPayment.Invoice ID
  • InvoiceNumber.Invoice Reference Number = InvoiceScheduledPayment.Invoice Reference Number
  • PaymentApplicationSummary.Invoice ID = InvoiceScheduledPayment.Native Invoice Id

Properties

  • Balance
  • Description
  • DueDate
  • InvoiceDescription
  • InvoiceId
  • NativeInvoiceId
  • PaymentNumber
  • PendingPaymentSchedulePayr
  • SheduledPaymentId

OrderInvoice

Lists all order numbers and their related invoice reference numbers.

Common Joins

  • OrderInvoice.Invoice Reference Number = InvoiceSummary.Invoice ID
  • CsOrders.Order Number = OrderInvoice.Order Number
  • CsOrders.Invoice Reference Number = OrderInvoice.Invoice Reference Number
  • CsOrdersLines.Order Number = OrderInvoice.Order Number

Properties

  • OrderNumber
  • InvoiceReferenceNumber

Updated about 1 month ago

Did this page help you?