@cityssm/dynamics-gp/gp/getInvoiceByInvoiceNumber.ts

Read only inquiries into Microsoft Dynamics GP using a SQL Server connection.

import { connect, type mssql } from '@cityssm/mssql-multi-pool'

import type { GPInvoice } from './types.js'

/**
 * Inquiry > Sales > Invoice
 * @param mssqlConfig
 * @param invoiceNumber
 * @param invoiceDocumentTypeOrAbbreviationOrName
 * @returns
 */
export default async function _getInvoiceByInvoiceNumber(
  mssqlConfig: mssql.config,
  invoiceNumber: string,
  invoiceDocumentTypeOrAbbreviationOrName?: number | string
): Promise<GPInvoice | undefined> {
  const pool = await connect(mssqlConfig)

  const invoiceRequest = pool.request().input('invoiceNumber', invoiceNumber)

  let sql = `select top 1
    rtrim(t.DOCTYABR) as documentTypeAbbreviation,
    rtrim(t.DOCTYNAM) as documentTypeName,
    i.* from (
      SELECT top 1
      0 as isHistorical,
      i.DOCTYPE as invoiceDocumentType,
      rtrim(i.INVCNMBR) as invoiceNumber,
      rtrim(i.BACHNUMB) as batchNumber,
      rtrim(i.BCHSOURC) as batchSource,
      rtrim(i.CUSTNMBR) as customerNumber,
      rtrim(i.CUSTNAME) as customerName,
      i.DOCDATE as documentDate,
      i.POSTDATE as datePosted,
      i.GLPOSTDT as datePostedGl,
      i.QUOTEDAT as dateQuoted,
      i.ORDRDATE as dateOrdered,
      i.DISCDATE as termDiscountDate,
      i.DUEDATE as dateDue,
      i.DOCAMNT as documentAmount,
      i.SUBTOTAL as subtotal,
      i.FRTAMNT as freightAmount,
      i.MISCAMNT as miscellaneousAmount,
      i.TRDISAMT as tradeDiscountAmount,
      i.TAXAMNT as taxAmount,
      i.ACCTAMNT as accountAmount,
      i.PYMTRCVD as paymentReceived,
      i.CODAMNT as codAmount,
      rtrim(i.CNTCPRSN) as contactPerson,
      rtrim(i.ADDRESS1) as address1,
      rtrim(i.ADDRESS2) as address2,
      rtrim(i.ADDRESS3) as address3,
      rtrim(i.CITY) as city,
      rtrim(i.STATE) as state,
      rtrim(i.COUNTRY) as country,
      rtrim(i.ZIPCODE) as zipCode,
      rtrim(i.PHNUMBR1) as phoneNumber1,
      rtrim(i.PHNUMBR2) as phoneNumber2,
      rtrim(i.PHONE3) as phoneNumber3,
      rtrim(i.FAXNUMBR) as faxNumber,
      rtrim(i.COMMENT_1) as comment1,
      rtrim(i.COMMENT_2) as comment2,
      rtrim(i.COMMENT_3) as comment3,
      rtrim(i.COMMENT_4) as comment4,
      i.CREATDDT as dateCreated,
      i.MODIFDT as dateModified
      FROM IVC10100 i
      where i.INVCNMBR = @invoiceNumber
  
      union
  
      SELECT TOP 1
      1 as isHistorical,
      i.DOCTYPE as invoiceDocumentType,
      rtrim(i.INVCNMBR) as invoiceNumber,
      rtrim(i.BACHNUMB) as batchNumber,
      rtrim(i.BCHSOURC) as batchSource,
      rtrim(i.CUSTNMBR) as customerNumber,
      rtrim(i.CUSTNAME) as customerName,
      i.DOCDATE as documentDate,
      i.POSTDATE as datePosted,
      i.GLPOSTDT as datePostedGl,
      i.QUOTEDAT as dateQuoted,
      i.ORDRDATE as dateOrdered,
      i.DISCDATE as termDiscountDate,
      i.DUEDATE as dateDue,
      i.DOCAMNT as documentAmount,
      i.SUBTOTAL as subtotal,
      i.FRTAMNT as freightAmount,
      i.MISCAMNT as miscellaneousAmount,
      i.TRDISAMT as tradeDiscountAmount,
      i.TAXAMNT as taxAmount,
      i.ACCTAMNT as accountAmount,
      i.PYMTRCVD as paymentReceived,
      i.CODAMNT as codAmount,
      rtrim(i.CNTCPRSN) as contactPerson,
      rtrim(i.ADDRESS1) as address1,
      rtrim(i.ADDRESS2) as address2,
      rtrim(i.ADDRESS3) as address3,
      rtrim(i.CITY) as city,
      rtrim(i.STATE) as state,
      rtrim(i.COUNTRY) as country,
      rtrim(i.ZIPCODE) as zipCode,
      rtrim(i.PHNUMBR1) as phoneNumber1,
      rtrim(i.PHNUMBR2) as phoneNumber2,
      rtrim(i.PHONE3) as phoneNumber3,
      rtrim(i.FAXNUMBR) as faxNumber,
      rtrim(i.COMMENT_1) as comment1,
      rtrim(i.COMMENT_2) as comment2,
      rtrim(i.COMMENT_3) as comment3,
      rtrim(i.COMMENT_4) as comment4,
      i.CREATDDT as dateCreated,
      i.MODIFDT as dateModified
      FROM IVC30101 i
      where i.INVCNMBR = @invoiceNumber
    ) i

    left join IVC40101 t on i.invoiceDocumentType = t.DOCTYPE`

  if (invoiceDocumentTypeOrAbbreviationOrName !== undefined) {
    invoiceRequest.input(
      'invoiceDocumentType',
      invoiceDocumentTypeOrAbbreviationOrName.toString()
    )

    sql += ` where (
      t.DOCTYABR = @invoiceDocumentType
      or t.DOCTYNAM = @invoiceDocumentType
      ${
        typeof invoiceDocumentTypeOrAbbreviationOrName === 'string' &&
        Number.isNaN(
          Number.parseInt(invoiceDocumentTypeOrAbbreviationOrName, 10)
        )
          ? ''
          : ' or t.DOCTYPE = @invoiceDocumentType'
      })`
  }
  sql += ' order by t.DEX_ROW_ID'

  const invoiceResult = (await invoiceRequest.query(
    sql
  )) as mssql.IResult<GPInvoice>

  const invoice: GPInvoice | undefined =
    invoiceResult.recordset.length > 0 ? invoiceResult.recordset[0] : undefined

  if (invoice !== undefined) {
    const itemResults = await pool
      .request()
      .input('invoiceDocumentType', invoice.invoiceDocumentType)
      .input('invoiceNumber', invoice.invoiceNumber).query(`SELECT
        [LNITMSEQ] as lineItemNumber,
        rtrim([ITEMNMBR]) as itemNumber,
        [QUANTITY] as quantity,
        [QTYINSVC] as quantityInService,
        [QTYINUSE] as quantityInUse,
        [QTYDMGED] as quantityDamaged,
        [QTYRTRND] as quantityReturned,
        [QTYONHND] as quantityOnHand,
        [EXTQTYSEL] as existingQuantitySelected,
        rtrim([UOFM]) as unitOfMeasurement,
        [UNITCOST] as unitCost,
        [EXTDCOST] as extendedCost,
        [ATYALLOC] as quantityAllocated,
        rtrim([LOCNCODE]) as locationCode,
        [XTNDPRCE] as extendedPrice,
        [UNITPRCE] as unitPrice,
        [TAXAMNT] as taxAmount,
        rtrim([ITEMDESC]) as itemDescription,
        [EXPTSHIP] as shipDateExpected,
        [ACTLSHIP] as shipDateActual,
        [ReqShipDate] as shipDateRequested
        FROM ${invoice.isHistorical === 1 ? '[IVC30102]' : '[IVC10101]'}
        where INVCNMBR = @invoiceNumber
        and DOCTYPE = @invoiceDocumentType
        order by LNITMSEQ`)

    invoice.lineItems = itemResults.recordset
  }

  return invoice
}