@tamu-dor/famis-db 1.3.0

package/docs.md

@@ -0,0 +1,591 @@
+<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
+
+### Table of Contents
+
+-   [addInvoice][1]
+-   [allowableExpenseCode][2]
+-   [formatAccountNumber][3]
+-   [getAccountNumber][4]
+-   [getAccountsByResponsibleUin][5]
+-   [getAccountsByUin][6]
+-   [getAllCores][7]
+-   [getAllInvoices][8]
+-   [getAllowableExpenseCodes][9]
+-   [getAllSystemParts][10]
+-   [getByAccountNumber][11]
+-   [getCoreByAccount][12]
+-   [getCoreById][13]
+-   [getCoreCurrentAccount][14]
+-   [getCoreUsers][15]
+-   [getCurrentFiscalYear][16]
+-   [getCustomerNumber][17]
+-   [getEnabledCores][18]
+-   [getExpenseCode][19]
+-   [getHeldInvoices][20]
+-   [getInvoiceByFingerPrint][21]
+-   [getInvoiceByNumber][22]
+-   [getInvoiceByUid][23]
+-   [getInvoiceFingerPrint][24]
+-   [getInvoicesAwaitingEmail][25]
+-   [getInvoicesByAccount][26]
+-   [getLatestInvoices][27]
+-   [getNextFAMISInvoiceNumber][28]
+-   [getRevenueCode][29]
+-   [getSystemById][30]
+-   [getSystemByPartNumber][31]
+-   [getSystemUsers][32]
+-   [getUser][33]
+-   [getUserCores][34]
+-   [getUserSystemParts][35]
+-   [markEmailed][36]
+-   [markInvoiced][37]
+-   [processInvoice][38]
+-   [searchByAccountNumber][39]
+-   [searchInvoicesByFamis][40]
+-   [searchInvoicesByNumber][41]
+-   [setDeleted][42]
+-   [setInvoiceFingerPrint][43]
+-   [setInvoicePostedDate][44]
+-   [updateInvoice][45]
+
+## addInvoice
+
+Adds an invoice
+
+### Parameters
+
+-   `invoice` **[object][46]** 
+-   `type` **[string][47]** 
+-   `famisInvoiceNumber` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice
+
+## allowableExpenseCode
+
+Check if expense code is within the allowable range for specified account and the specified fiscal year (defaults to current)
+
+### Parameters
+
+-   `accountNumber`  
+-   `code` **[string][47]** 
+-   `fiscal` **integer** 
+-   `account` **[string][47]** 
+
+Returns **[Promise][48]&lt;[boolean][49]>** truthy value
+
+## formatAccountNumber
+
+Return formatted account number
+
+### Parameters
+
+-   `accountNumber` **[string][47]** unformatted 13 digit famis account number
+
+## getAccountNumber
+
+Extract customer account and po number
+
+### Parameters
+
+-   `famis` **[object][46]** 
+-   `replace_data` **[object][46]** 
+
+Returns **[object][46]** account number object
+
+## getAccountsByResponsibleUin
+
+Get PI accounts by responsible UIN
+
+### Parameters
+
+-   `uin` **[string][47]** 
+
+Returns **[Promise][48]&lt;[array][50]>** account object array
+
+## getAccountsByUin
+
+Get PI Accounts by UIN
+
+### Parameters
+
+-   `uin` **[string][47]** 
+
+Returns **[Promise][48]&lt;[array][50]>** account object array
+
+## getAllCores
+
+Get all cores
+
+Returns **[Promise][48]&lt;[array][50]>** core objects
+
+## getAllInvoices
+
+Get all invoice ordered by and sorted by paramaters passed
+
+### Parameters
+
+-   `orderBy` **[string][47]**  (optional, default `'date'`)
+-   `dir` **[string][47]**  (optional, default `'desc'`)
+-   `deleted` **[boolean][49]**  (optional, default `false`)
+
+Returns **[Promise][48]&lt;[array][50]>** invoice objects
+
+## getAllowableExpenseCodes
+
+Get allowable expense code ranges for specified account
+
+### Parameters
+
+-   `accountNumber`  
+-   `fiscal`  
+-   `account` **[string][47]** 
+
+Returns **[Promise][48]&lt;[boolean][49]>** expense code range object(s)
+
+## getAllSystemParts
+
+Get all system parts
+
+Returns **[Promise][48]&lt;[object][46]>** system objects
+
+## getByAccountNumber
+
+Get PI accounts by account number
+
+### Parameters
+
+-   `number` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** account object
+
+## getCoreByAccount
+
+Get core by account number
+
+### Parameters
+
+-   `account` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** core object
+
+## getCoreById
+
+Get core by id
+
+### Parameters
+
+-   `id` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** core object
+
+## getCoreCurrentAccount
+
+Get core current revenue account number
+
+### Parameters
+
+-   `coreId` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** core object
+
+## getCoreUsers
+
+Get a core's users by core ID
+
+### Parameters
+
+-   `coreId` **[number][51]** 
+
+Returns **[Promise][48]&lt;[array][50]>** user objects
+
+## getCurrentFiscalYear
+
+Get current fiscal year
+
+## getCustomerNumber
+
+Get customer by customer account number
+
+### Parameters
+
+-   `accountNumber` **[string][47]** 
+-   `campusCode` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** customer account object
+
+## getEnabledCores
+
+Get all enabled cores
+
+### Parameters
+
+-   `date` **[string][47]** 
+
+Returns **[Promise][48]&lt;[array][50]>** core objects
+
+## getExpenseCode
+
+Get matching expense code for specified revenue code
+
+### Parameters
+
+-   `revenue` **[string][47]** 
+
+Returns **[Promise][48]&lt;[string][47]>** expense code
+
+## getHeldInvoices
+
+Returns all held invoices
+
+Returns **[Promise][48]&lt;[array][50]>** held invoice objects
+
+## getInvoiceByFingerPrint
+
+Get invoice by fingerprint
+
+### Parameters
+
+-   `fingerPrint` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## getInvoiceByNumber
+
+Get invoice by originating system assigned number
+
+### Parameters
+
+-   `number` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## getInvoiceByUid
+
+Get invoice by uid
+
+### Parameters
+
+-   `uid` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## getInvoiceFingerPrint
+
+Return fingerprint of invoice
+
+### Parameters
+
+-   `invoice` **[object][46]** json object
+
+## getInvoicesAwaitingEmail
+
+Returns all awaiting email invoices
+
+Returns **[Promise][48]&lt;[array][50]>** awaiting email invoice objects
+
+## getInvoicesByAccount
+
+Get all invoices associated with a specified account number
+
+### Parameters
+
+-   `accountNumber` **[string][47]** 
+
+Returns **[Promise][48]&lt;[array][50]>** invoice objects
+
+## getLatestInvoices
+
+Retreives invoices from the latest date
+
+Returns **[Promise][48]&lt;[array][50]>** invoice objects
+
+## getNextFAMISInvoiceNumber
+
+Get next FAMIS invoice number in sequence for specified invoice type
+
+### Parameters
+
+-   `type`  
+-   `invoice` **[string][47]** 
+
+Returns **[Promise][48]&lt;[string][47]>** next invoice number in sequence
+
+## getRevenueCode
+
+Get revenue code object
+
+### Parameters
+
+-   `revenue` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** revenue code object
+
+## getSystemById
+
+Get system part by ID
+
+### Parameters
+
+-   `id` **[number][51]** 
+
+Returns **[Promise][48]&lt;[object][46]>** system part object
+
+## getSystemByPartNumber
+
+Get system part by two digit part number
+
+### Parameters
+
+-   `number` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** system part object
+
+## getSystemUsers
+
+Get a system part's users by system ID
+
+### Parameters
+
+-   `systemId` **[number][51]** 
+
+Returns **[Promise][48]&lt;[array][50]>** user objects
+
+## getUser
+
+Get user
+
+### Parameters
+
+-   `userId` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** user object
+
+## getUserCores
+
+Get a user's cores they manage
+
+### Parameters
+
+-   `userId` **[string][47]** 
+
+Returns **[Promise][48]&lt;[array][50]>** core objects
+
+## getUserSystemParts
+
+Get a user's system parts they manage
+
+### Parameters
+
+-   `userId` **any** 
+
+Returns **[Promise][48]&lt;[object][46]>** system objects
+
+## markEmailed
+
+Toggles an invoice as emailed
+
+### Parameters
+
+-   `uid` **[string][47]** 
+-   `emailed` **[boolean][49]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## markInvoiced
+
+Toggles an invoice as paid
+
+### Parameters
+
+-   `uid` **[string][47]** 
+-   `invoiced` **[boolean][49]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## processInvoice
+
+Process an invoice to have all necessary relationships
+
+### Parameters
+
+-   `invoice` **[object][46]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## searchByAccountNumber
+
+Search PI accounts by partial account number
+
+### Parameters
+
+-   `number` **[string][47]** 
+
+Returns **[Promise][48]&lt;[array][50]>** account object(s)
+
+## searchInvoicesByFamis
+
+Search invoices by FAMIS invoice number
+
+### Parameters
+
+-   `famis` **[string][47]** 
+
+Returns **[Promise][48]&lt;[array][50]>** invoice objects
+
+## searchInvoicesByNumber
+
+Search invoices by originating system generated invoice number
+
+### Parameters
+
+-   `number` **[string][47]** 
+
+Returns **[Promise][48]&lt;[array][50]>** invoice objects
+
+## setDeleted
+
+Sets an invoice's deletion date
+
+### Parameters
+
+-   `uid` **[string][47]** 
+-   `deleted` **[date][52]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## setInvoiceFingerPrint
+
+Sets an invoice's fingerprint
+
+### Parameters
+
+-   `uid` **[string][47]** 
+-   `fingerprint` **[string][47]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## setInvoicePostedDate
+
+Sets an invoice's posted date
+
+### Parameters
+
+-   `uid` **[string][47]** 
+-   `postedDate` **[date][52]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+## updateInvoice
+
+Updates an invoice
+
+### Parameters
+
+-   `uid` **[string][47]** 
+-   `invoice` **[object][46]** 
+
+Returns **[Promise][48]&lt;[object][46]>** invoice object
+
+[1]: #addinvoice
+
+[2]: #allowableexpensecode
+
+[3]: #formataccountnumber
+
+[4]: #getaccountnumber
+
+[5]: #getaccountsbyresponsibleuin
+
+[6]: #getaccountsbyuin
+
+[7]: #getallcores
+
+[8]: #getallinvoices
+
+[9]: #getallowableexpensecodes
+
+[10]: #getallsystemparts
+
+[11]: #getbyaccountnumber
+
+[12]: #getcorebyaccount
+
+[13]: #getcorebyid
+
+[14]: #getcorecurrentaccount
+
+[15]: #getcoreusers
+
+[16]: #getcurrentfiscalyear
+
+[17]: #getcustomernumber
+
+[18]: #getenabledcores
+
+[19]: #getexpensecode
+
+[20]: #getheldinvoices
+
+[21]: #getinvoicebyfingerprint
+
+[22]: #getinvoicebynumber
+
+[23]: #getinvoicebyuid
+
+[24]: #getinvoicefingerprint
+
+[25]: #getinvoicesawaitingemail
+
+[26]: #getinvoicesbyaccount
+
+[27]: #getlatestinvoices
+
+[28]: #getnextfamisinvoicenumber
+
+[29]: #getrevenuecode
+
+[30]: #getsystembyid
+
+[31]: #getsystembypartnumber
+
+[32]: #getsystemusers
+
+[33]: #getuser
+
+[34]: #getusercores
+
+[35]: #getusersystemparts
+
+[36]: #markemailed
+
+[37]: #markinvoiced
+
+[38]: #processinvoice
+
+[39]: #searchbyaccountnumber
+
+[40]: #searchinvoicesbyfamis
+
+[41]: #searchinvoicesbynumber
+
+[42]: #setdeleted
+
+[43]: #setinvoicefingerprint
+
+[44]: #setinvoiceposteddate
+
+[45]: #updateinvoice
+
+[46]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object
+
+[47]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String
+
+[48]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise
+
+[49]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean
+
+[50]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array
+
+[51]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number
+
+[52]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Date