Skip to content
Client Resources 717.442.3247
Technical Documentation > Entities

ARINV

Sales document

Inherits from EbmsEntity

Properties

    ADDRESS1 (EbmsAddress, String)
    Address line 1
    Billing address line 1
    ADDRESS2 (EbmsAddress, String)
    Address line 2
    Billing address line 2
    AllowWeightedBarcodes (Boolean, Boolean, virtual)
    Allow weighted barcodes
    AppName (Text, String, virtual)
    App name
    ARINVDETs (ARINVDET, reference, collection)
    Invoice detail
    ARINVPMTDETs (ARINVPMTDET, reference, collection)
    Payment links
    ARINVTAXes (ARINVTAX, reference, collection)
    Sales taxes
    ARQTs (ARQT, reference, collection)
    Proposals
    ARSMSHIPINFOs (ARSMSHIPINFO, reference, collection)
    AUTHORIZED (Currency, Decimal)
    Authorized
    AUTOID (EbmsAutoID, String, read-only)
    Auto ID
    The id that identifies the record in EBMS
    BAL_CUST_C (Currency, Decimal, read-only)
    Remaining balance
    BAL_CUST_P (Currency, Decimal, read-only)
    BAL_CUST_P
    BAL_CUST_X (ReadOnlyDecimal, Decimal, read-only)
    Balance total
    BALANCE (TotalCurrency, Decimal)
    Balance
    Invoice balance
    Barcode (Barcode, String, virtual)
    Barcode
    BarcodeType (Text, String, virtual)
    Barcode type
    BillingAddress (MultilineText, String, virtual)
    Billing address
    C_ADDRESS1 (EbmsAddress, String)
    Shipping address line 1
    C_ADDRESS2 (EbmsAddress, String)
    Shipping address line 2
    C_CITY (EbmsCity, String)
    Shipping city
    C_COUNTRY (EbmsCountry, String)
    Shipping country
    C_EMAIL (EbmsEmail, String)
    Shipping email
    C_ID (EbmsIDSearch, String)
    Ship to
    C_ID_Reference (ARCUST, reference)
    Shipping customer
    C_NAME (EbmsText, String)
    Shipping name
    C_PHONE (EbmsPhone, String)
    Shipping phone number
    C_STATE (EbmsState, String)
    Shipping state
    C_ZIP (EbmsPostalCode, String)
    Shipping postal code
    CCNTCT_AID (EbmsAutoID, String)
    Ship to contact Auto ID
    CCNTCT_AID_Reference (ARCONTACTS, reference)
    Ship to contact
    CHARGE (EbmsFormulaText, String)
    Sales due term
    Terms for this invoice. Cash if payment is paid immediately. Charge if sold with terms, and C.O.D. if terms are Collect on Delivery.
    CHECK_DATE (Date, Nullable`1)
    Check date
    The date that a check was written
    CHECK_NO (ReadOnlyEbmsName, String)
    Check number
    CITY (EbmsCity, String)
    City
    Billing city
    cmdCalculateFreight (ISalesDocCmdCalculateFreight, CalculateFreight)
    Estimate shipping
    cmdChangeCustomer (ARINVCmdChangeCustomer, ChangeCustomer)
    Change customer...
    cmdCreateNewDetail (IOrderCmdCreateNewDetail, CreateNewDetail)
    Create new detail
    cmdGetHiddenColumns (ISalesDocCmdGetHiddenColumns, GetHiddenColumns)
    Get hidden columns
    cmdGetPdfReport (ARINVCmdGetPdfReport, GetPdfReport)
    Get pdf report
    This is needed for Web
    cmdMarkAllAsShipped (ARINVCmdMarkAllAsShipped, MarkAllAsShipped)
    Ship all items
    cmdPrintScanner (IOrderScannerViewCmdPrintScanner, PrintScanner)
    Print
    cmdPrintScannerOrders (IOrderScannerViewCmdPrintScannerOrders, PrintScannerOrders)
    Print
    cmdProcessAndPrintScanner (ARINVCmdProcessAndPrintScanner, ProcessAndPrintScanner)
    Process and print
    cmdProcessAndPrintScannerOrders (IOrderScannerViewCmdProcessAndPrintScannerOrders, ProcessAndPrintScannerOrders)
    Process and print
    cmdProcessScanner (IOrderScannerViewCmdProcessScanner, ProcessScanner)
    Process / No print
    cmdRecalculateAllPrices (ISalesDocCmdRecalculateAllPrices, RecalculateAllPrices)
    Recalculate all prices
    cmdRecordPayment (ARINVCmdRecordPayment, RecordPayment)
    Record payment...
    cmdSend (ISendableCmdSend, Send)
    Send now
    cmdSign (ISignableCmdSign, Sign)
    Sign
    Add signature
    cmdUpdateLocked (ILockableCmdUpdateLocked, UpdateLocked)
    Update locked
    read the DBDOCLOCK and check if this entity is locked
    cmdUseBarcode (IBarcodeScannerCmdUseBarcode, UseBarcode)
    Use barcode
    CNTCT_AID (EbmsAutoID, String)
    Contact Auto ID
    CNTCT_AID_Reference (ARCONTACTS, reference)
    Bill to contact
    COUNTRY (EbmsCountry, String)
    Country
    Billing country
    CustomerIdDefaulted (Boolean, Boolean, virtual)
    DEF_DEPT (EbmsDepartment, String)
    Department id
    DEF_DEPT_Reference (GLDEPT, reference)
    Department
    DEL_ORDER (Boolean, Boolean)
    Confirmed for delivery
    DESCR (EbmsDescription, String)
    Description
    Details (ARINVDET, reference, collection, virtual)
    Details
    Top-level details
    DIS_DATE (Date, Nullable`1)
    Discount date
    Due date for discount amount
    DISC_PERC (PercentageRate, Decimal)
    Discount %
    DISCOUN (EbmsFormulaText, String)
    Discount
    Select Terms with discounts if paid by a certain time
    DISCOUNT (Currency, Decimal)
    Discount amount
    Discount for net terms on this invoice
    DocumentsBrowser (ServerFileBrowser, reference, virtual, read-only)
    Documents browser
    DocumentsPath (String, String, virtual, read-only)
    Documents path
    DocumentsStatus (String, String, virtual, read-only)
    Documents status
    DocumentSummaryText (BasicHtmlCompact, String, virtual)
    DOWN_PAY (ReadOnlyEbmsPayment, String)
    Down payment cash amount
    DUE_DATE (Date, Nullable`1)
    Due date
    E_DATE (DateDefaultedToday, Nullable`1, required)
    Entry Date
    Date the invoice was firs entered.
    EC_RPT_ERR (EbmsMemo, String)
    EC_RPT_ERR
    EC_RPT_PDF (BlobInfo, BlobInfo)
    EC_RPT_PDF
    EC_RPT_RUN (Boolean, Boolean)
    EC_RPT_RUN
    EMAIL (EbmsEmail, String)
    Email
    Billing email
    EXTERNALID (EbmsText, String)
    External ID
    FREIGHT (Currency, Decimal)
    Freight
    Amount of freight
    GRACE (ReadOnlyEbmsFormula, String, read-only)
    Grace period
    Billing customer grace period
    HANDLING (Currency, Decimal)
    Handling
    Handling fee
    HiddenColumns (Text, String, collection, virtual)
    Hidden columns
    IADDRESS (MultilineText, String)
    Address
    ID (EbmsIDSearch, String)
    Billing customer
    ID_Reference (ARCUST, reference)
    Billing customer
    IDCHARGE (EbmsID, String)
    IDCHARGE
    IDCHARGE_Reference (ChargeFormula, reference)
    Charge formula
    IDDISCOUNT (EbmsID, String)
    Discount formula id
    IDDISCOUNT_Reference (DiscountFormula, reference)
    Discount formula
    IN_LEVEL (EbmsIDSearch, String)
    Price level ID
    IN_LEVEL_Reference (INPRICE, reference)
    Price level
    INTERNALNT (MultilineText, String)
    Internal notes
    INTRANs (INTRAN, reference, collection)
    INTRANs
    INV_DATE (DateDefaultedToday, Nullable`1, required)
    Invoice date
    Processing date of the invoice
    INVOICE (EbmsInvoiceNaturalKey, String, required)
    Invoice number
    Invoice No. for the sales invoice
    IsApplicable (Boolean, Boolean, virtual, read-only)
    Is applicable
    Is this home view applicable to the user
    IsDeleted (Boolean, Boolean, virtual, read-only)
    Is deleted
    IsEntitySaved (Boolean, Boolean, virtual)
    Is entity saved
    IsFromMyInventory (Boolean, Boolean, virtual, read-only)
    Is from my inventory
    Helper flag to show message about scanner default warehouse, when it is not set
    IsInventoryScanned (Boolean, Boolean, virtual)
    Is inventory scanned
    This is flag to recompute Details property when any inventory is scanned
    IsLocked (Boolean, Boolean, virtual)
    Locked
    IsNewEntity (Boolean, Boolean, virtual)
    Is new entity
    A virtual property that we can base computes off of to show if an entity is virtual
    IsOutstanding (Boolean, Boolean, virtual)
    Outstanding
    IsUnprocessed (Boolean, Boolean, virtual)
    Unprocessed
    JOB_ID (EbmsIDSearch, String)
    Job id
    JOB_ID_Reference (JCJB, reference)
    Job
    MAN_TAX (ReadOnlyBoolean, Boolean)
    Manual tax
    Select sales tax table manually
    MEMO (MultilineText, String)
    Memo
    NAME (EbmsText, String)
    Billing name
    Order (RowOrder, Decimal, virtual, read-only)
    Order
    Order to place this home view in relative to other home views
    OVERDUE (Currency, Decimal)
    Overdue
    Amount overdue
    Payments (ARINVPMT, reference, collection, virtual)
    Payments
    PERC_MARG (ReadOnlyDecimal, Decimal, read-only)
    Percent {$INOPTION.MARG_MARK}
    PHONE (EbmsPhone, String)
    Billing phone number
    Billing phone number
    PO_NO (EbmsType, String)
    PO number/Job
    Customer PO number
    PROCESS (DocumentProcess, DocumentProcess)
    Process
    Assign this property to process/unprocess an invoice
    ReadOnlyShipToName (EbmsText, String, virtual)
    Ship to
    RecurringBills (INREBILL, reference, collection)
    Recurring billing
    ReturnMode (Boolean, Boolean, virtual)
    Return mode
    SALESMAN (EbmsIDSearch, String)
    Sales man
    SALESMAN_Field (EbmsPerson, String)
    Sales person
    Salesperson entering this invoice
    SALESMAN_Reference (ARSALESP, reference)
    Sales person reference
    Scan (Integer, Int32, virtual)
    {ScanLabel} quantity
    ScanLabel (EbmsText, String, virtual, read-only)
    ScannerDetails (SalesOrderDetailView, reference, collection, virtual)
    Details
    SelectedDetail (ARINVDET, reference, virtual)
    Selected detail
    Settings (SalesUserSettings, reference, virtual)
    Settings
    SHIP_DATE (Date, Nullable`1)
    Ship date
    SHIP_VIA (EbmsID, String)
    Ship via id
    SHIP_VIA_Reference (ARSHVIA, reference)
    Ship via
    Means of shipment
    SHIPPING (PositiveDecimal, Decimal)
    Shipping
    ShippingAmount (Currency, Decimal, virtual)
    Amount
    ShippingColumnsOrderBy (ShippingColumnsOrderBy, ShippingColumnsOrderBy, virtual)
    Order by
    ShowAdvancedScannerOptions (Option, Boolean, virtual)
    Show advanced options
    ShowCost (Boolean, Boolean, virtual)
    Show cost
    SIGNATURE (Signature, BlobInfo)
    Signature
    SO_BALCUST (ReadOnlyDecimal, Decimal, read-only)
    S.O.
    SO_TAX (ReadOnlyDecimal, Decimal, read-only)
    Sales tax
    Sales Order Tax
    STATE (EbmsState, String)
    State
    STATUS (ReadOnlyInvoiceStatus, InvoiceStatus, read-only)
    Status
    Subtitle (BasicHtmlCompact, String, virtual, read-only)
    Subtitle
    SUBTOTAL (ReadOnlyCurrency, Decimal)
    Subtotal
    Sum of goods sold
    Task (TASK, reference, virtual)
    Task
    TASK_Collection (TASK, reference, collection)
    Tasks (TaskForARINV, reference, collection, virtual)
    Tasks
    TASKs (TASK, reference, collection)
    TasksAvailableToAdd (TASK, reference, collection, virtual)
    Tasks available to add
    TAX (Currency, Decimal, read-only)
    Tax
    TAX_TABLE (EbmsDescription, String, read-only)
    Table
    TERMS (InvoiceTerms, InvoiceTerms)
    Terms
    TermsDetails (MultilineText, String, virtual, read-only)
    Title (Title, String, virtual, read-only)
    Title
    TO_B_SENT (Boolean, Boolean)
    To be sent
    TOTAL (Currency, Decimal, read-only)
    Invoice total
    Total amount due
    TOTAL_COST (Currency, Decimal, read-only)
    Costs
    TOTAL_ITEM (ReadOnlyDecimal, Decimal, read-only)
    Shipped products
    TOTAL_MARG (Currency, Decimal, read-only)
    Total {$INOPTION.MARG_MARK}
    TOTAL_PAID (Currency, Decimal, read-only)
    Total paid
    TOTAL_S_SO (ReadOnlyDecimal, Decimal, read-only)
    S.O. Subtotal
    TOTAL_SO (ReadOnlyCurrency, Decimal, read-only)
    S.O. Total
    TOTAL_W (ReadOnlyDecimal, Decimal, read-only)
    Weight
    TotalOrdered (ReadOnlyDecimal, Decimal, virtual, read-only)
    Ordered Total
    TRACK_NUMS (MultilineText, String)
    Tracking numbers
    TTLPROCPMT (Currency, Decimal, read-only)
    Paid
    USER_NAME (EbmsText, String, read-only)
    User name
    User name
    UserSettings (IUserSettings, reference, virtual)
    User settings
    WAREHOUSE (EbmsIDSearch, String)
    Warehouse id
    WAREHOUSE_Reference (INWH, reference)
    Warehouse
    multiple sales locations
    ZIP (EbmsPostalCode, String)
    Postal code
    Billing postal code
Version 1.6.436, Updated on Monday, April 29, 2024

Creating a new sales order

POSThttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/ARINV
{
 "ID": "DOEJOH",
 "INV_DATE": "01/15/2020",
 "SHIP_DATE": "01/21/2020",
 "DESCR": "Misc groceries",
 "MEMO": "multi – line memo \r\nSo much can be written here and can be printed at the bottom of the invoice",
 "Details":
  [
   [
    "M_QUAN_VIS": "2",
    "M_SHIP_VIS": "1",
    "INVEN": "STRAWBER",
    "DESCR": "[Overwrite the EBMS description if you wish with this multi-line memo]",
    "UNIT":"14.99",
    "UNIT_MEAS":"Box"

   },
   {
    "INVEN": "SUGARWH",
    "M_QUAN_VIS": "1",
    "M_SHIP_VIS": "1"
   },
  ],
 "Payments":
  [
   {
    "AMOUNT":"7.32",
    "DATE":"01/15/2020",
    "CHECK_NO":"CASH",
    "TYPE":"Cash",
    "CASH_ACNT":"01000-000"
   }
  ],
 "PROCESS":"Process"
}

Creating a new sales order with credit card payment

POSThttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/ARINV
{
 "ID": "DOEJOH",
 "INV_DATE": "01/15/2020",
 "SHIP_DATE": "01/21/2020",
 "DESCR": "Misc groceries",
 "MEMO": "multi – line memo \r\nSo much can be written here and can be printed at the bottom of the invoice",
 "Details":
  [
   {
    "M_QUAN_VIS": "2",
    "M_SHIP_VIS": "1",
    "INVEN": "STRAWBER",
    "UNIT":"14.99",
    "UNIT_MEAS":"Box"
   },
   {
    "M_QUAN_VIS": "1",
    "M_SHIP_VIS": "1",
    "INVEN": "SUGARWH"
   },
  ],
 "ShippingAmount": 23.54,
 "Payments":
  [
   {
    "TYPE": "Credit",
    "CC_TYPE": "MC",
    "CC_4DIGIT": "1234",
    "ACTION": "XX7",
    "AMOUNT":"7.32",
    "CASH_ACNT":"01000-000",
    "DATE":"01/15/2020"
   }
  ],
 "PROCESS":"Process"
}

Editing sales order details

In this example, we modify one item, remove one item, and add one new item.

PATCHhttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/ARINV('2SQIJ0T7679LEIG0')
{
 "Details@delta": [
  {
   "@id":"39D80NN66P729HA1",
   "M_QUAN_VIS":10
  },
  {
   "@id":"V9D80NN66P729HA1",
   "@removed":true
  },
  {
   "INVEN":"LHAM",
   "M_QUAN_VIS":10
  }
 ]
}

Voiding a payment

Payments can be voided by setting ACTION to XX4, note that you cannot remove payments, only void them.

PATCHhttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/ARINV('2SQIJ0T7679LEIG0')
{
 "Payments@delta": [
  {
   "@id":"K908NQRVPDNCQ000",
   "ACTION":"XX4"
  }
 ]
}

Creating a new sales order with manual taxes

POSThttps://ecc123456789012345.servicebus.windows.net/MyEbms/ABC/OData/ARINV
{
 "ID": "DOEJOH",
 "MAN_TAX": true,
 "Details":
  [
   {
    "M_QUAN_VIS": "1",
    "M_SHIP_VIS": "1",
    "INVEN": "SUGARWH"
   },
  ],
 "ARINVTAXes":
  [
   {
    "TAX_ID": "PA",
    "SO_TAX_AMT": -4.23,
    "SO_TAXABLE": -70.50,
    "SO_TXBLQTY": 0.00,
    "TAX_AMT": -4.23,
    "TAXABLEAMT": -70.50,
    "TAXBLEQTY": 0.00
   }
  ]
}