QuickBooks.Types

Description

Synopsis

• type Logger = LoggerSet
• type CallbackURL = String
• newtype OAuthVerifier = OAuthVerifier {
  • unOAuthVerifier :: ByteString
  }
• data AppConfig = AppConfig {
  • consumerToken :: !ByteString
  • consumerSecret :: !ByteString
  }
• data APIConfig = APIConfig {
  • companyId :: !ByteString
  • oauthToken :: !ByteString
  • oauthSecret :: !ByteString
  • hostname :: !ByteString
  • loggingEnabled :: !ByteString
  }
• type APIEnv = (?apiConfig :: APIConfig, AppEnv, NetworkEnv)
• type AppEnv = (?appConfig :: AppConfig, NetworkEnv)
• type NetworkEnv = (?manager :: Manager, ?logger :: Logger)
• data OAuthToken = OAuthToken {
  • token :: ByteString
  • tokenSecret :: ByteString
  }
• data family QuickBooksResponse a
• type QuickBooksQuery a = QuickBooksRequest (QuickBooksResponse a)
• type QuickBooksOAuthQuery a = QuickBooksOAuthRequest (QuickBooksResponse a)
• data QuickBooksOAuthRequest a where
  • GetTempOAuthCredentials :: CallbackURL -> QuickBooksOAuthQuery OAuthToken
  • GetAccessTokens :: OAuthVerifier -> QuickBooksOAuthQuery OAuthToken
  • DisconnectQuickBooks :: QuickBooksOAuthQuery ()
• data QuickBooksRequest a where
  • CreateInvoice :: Invoice -> QuickBooksQuery Invoice
  • ReadInvoice :: InvoiceId -> QuickBooksQuery Invoice
  • UpdateInvoice :: Invoice -> QuickBooksQuery Invoice
  • DeleteInvoice :: InvoiceId -> SyncToken -> QuickBooksQuery DeletedInvoice
  • SendInvoice :: InvoiceId -> EmailAddress -> QuickBooksQuery Invoice
  • QueryCustomer :: Text -> QuickBooksQuery [Customer]
  • QueryItem :: Text -> QuickBooksQuery [Item]
• newtype InvoiceId = InvoiceId {
  • unInvoiceId :: Text
  }
• newtype LineId = LineId {
  • unLineId :: Text
  }
• newtype SyncToken = SyncToken {
  • unSyncToken :: Text
  }
• data DescriptionLineDetail = DescriptionLineDetail {
  • descriptionLineDetailServiceDate :: !(Maybe Text)
  • descriptionLineDetailTaxCodeRef :: !(Maybe TaxCodeRef)
  }
• data DiscountLineDetail = DiscountLineDetail {
  • discountLineDetailDiscountRef :: !(Maybe DiscountRef)
  • discountLineDetailPercentBased :: !(Maybe Bool)
  • discountLineDetailDiscountPercent :: !(Maybe Double)
  • discountLineDetailDiscountAccountRef :: !(Maybe DiscountAccountRef)
  }
• data SalesItemLineDetail = SalesItemLineDetail {
  • salesItemLineDetailItemRef :: !(Maybe ItemRef)
  • salesItemLineDetailClassRef :: !(Maybe ClassRef)
  • salesItemLineDetailUnitPrice :: !(Maybe Double)
  • salesItemLineDetailRatePercent :: !(Maybe Double)
  • salesItemLineDetailPriceLevelRef :: !(Maybe PriceLevelRef)
  • salesItemLineDetailMarkupInfo :: !(Maybe Text)
  • salesItemLineDetailQty :: !(Maybe Double)
  • salesItemLineDetailTaxCodeRef :: !(Maybe TaxCodeRef)
  • salesItemLineDetailServiceData :: !(Maybe Text)
  • salesItemLineDetailTaxInclusiveAmt :: !(Maybe Double)
  }
• salesItemLineDetail :: ItemRef -> SalesItemLineDetail
• data SubTotalLineDetail = SubTotalLineDetail {
  • subtotalLineDetailItemRef :: !(Maybe ItemRef)
  }
• data Line = Line {
  • lineId :: !(Maybe LineId)
  • lineLineNum :: !(Maybe Double)
  • lineDescription :: !(Maybe Text)
  • lineAmount :: !(Maybe Double)
  • lineLinkedTxn :: !(Maybe [LinkedTxn])
  • lineDetailType :: !Text
  • lineDescriptionLineDetail :: !(Maybe DescriptionLineDetail)
  • lineDiscountLineDetail :: !(Maybe DiscountLineDetail)
  • lineSalesItemLineDetail :: !(Maybe SalesItemLineDetail)
  • lineSubTotalLineDetail :: !(Maybe SubTotalLineDetail)
  • lineCustomField :: !(Maybe [CustomField])
  }
• salesItemLine :: Double -> SalesItemLineDetail -> Line
• emptySalesItemLine :: Line
• newtype DeletedInvoiceId = DeletedInvoiceId {
  • unDeletedInvoiceId :: Text
  }
• data DeletedInvoice = DeletedInvoice {
  • deletedInvoiceId :: !DeletedInvoiceId
  • deletedInvoicedomain :: !Text
  • deletedInvoicestatus :: !Text
  }
• data Reference = Reference {
  • referenceName :: !(Maybe Text)
  • referenceType :: !(Maybe Text)
  • referenceValue :: !Text
  }
• reference :: Text -> Reference
• type ClassRef = Reference
• type CurrencyRef = Reference
• type CustomerRef = Reference
• type DepartmentRef = Reference
• type DepositToAccountRef = Reference
• type DiscountAccountRef = Reference
• type DiscountRef = Reference
• type ItemRef = Reference
• type PriceLevelRef = Reference
• type SalesTermRef = Reference
• type ShipMethodRef = Reference
• type TaxCodeRef = Reference
• type TxnTaxCodeRef = Reference
• data ModificationMetaData = ModificationMetaData {
  • modificationMetaDataCreateTime :: !Text
  • modificationMetaDataLastUpdatedTime :: !Text
  }
• data TelephoneNumber = TelephoneNumber {
  • telephoneNumberFreeFormNumber :: !Text
  }
• data WebSiteAddress = WebAddress {
  • webSiteAddressURI :: !Text
  }
• data PhysicalAddress = PhysicalAddress {
  • physicalAddressId :: !Text
  • physicalAddressLine1 :: !Text
  • physicalAddressLine2 :: !(Maybe Text)
  • physicalAddressLine3 :: !(Maybe Text)
  • physicalAddressLine4 :: !(Maybe Text)
  • physicalAddressLine5 :: !(Maybe Text)
  • physicalAddressCity :: !Text
  • physicalAddressCountry :: !(Maybe Text)
  • physicalAddressCountrySubDivisionCode :: !Text
  • physicalAddressPostalCode :: !Text
  • physicalAddressNote :: !(Maybe Text)
  • physicalAddressLat :: !(Maybe Text)
  • physicalAddressLong :: !(Maybe Text)
  }
• type BillAddr = PhysicalAddress
• type ShipAddr = PhysicalAddress
• data EmailAddress = EmailAddress {
  • emailAddress :: !Text
  }
• data TxnTaxDetail = TxnTaxDetail {
  • txnTaxDetailTxnTaxCodeRef :: !(Maybe TxnTaxCodeRef)
  • txnTaxDetailTotalTax :: !Double
  • txnTaxDetailTaxLine :: !(Maybe Line)
  }
• data DeliveryInfo = DeliveryInfo {
  • deliveryInfoDeliveryType :: !(Maybe Text)
  • deliveryInfoDeliveryTime :: !(Maybe Text)
  }
• data LinkedTxn = LinkedTxn {
  • linkedTxnId :: !(Maybe Text)
  • linkedTxnType :: !(Maybe Text)
  • linkedTxnLineId :: !(Maybe Text)
  }
• data CustomField = CustomField {
  • customFieldDefinitionId :: !Text
  • customFieldName :: !Text
  • customFieldType :: !CustomFieldType
  • customFieldStringValue :: !(Maybe Text)
  • customFieldBooleanValue :: !(Maybe Bool)
  • customFieldDateValue :: !(Maybe Text)
  • customFieldNumberValue :: !(Maybe Double)
  }
• data CustomFieldType
  • = BooleanType
  • | DateType
  • | NumberType
  • | StringType
• data GlobalTaxModel
  • = NotApplicable
  • | TaxExcluded
  • | TaxInclusive
• data Invoice = Invoice {
  • invoiceId :: !(Maybe InvoiceId)
  • invoiceSyncToken :: !(Maybe SyncToken)
  • invoiceMetaData :: !(Maybe ModificationMetaData)
  • invoiceCustomField :: !(Maybe [CustomField])
  • invoiceDocNumber :: !(Maybe Text)
  • invoiceTxnDate :: !(Maybe Text)
  • invoiceDepartmentRef :: !(Maybe DepartmentRef)
  • invoiceCurrencyRef :: !(Maybe CurrencyRef)
  • invoiceExchangeRate :: !(Maybe Double)
  • invoicePrivateNote :: !(Maybe Text)
  • invoiceLinkedTxn :: !(Maybe [LinkedTxn])
  • invoiceLine :: ![Line]
  • invoiceTxnTaxDetail :: !(Maybe TxnTaxDetail)
  • invoiceCustomerRef :: !CustomerRef
  • invoiceCustomerMemo :: !(Maybe Text)
  • invoiceBillAddr :: !(Maybe BillAddr)
  • invoiceShipAddr :: !(Maybe ShipAddr)
  • invoiceClassRef :: !(Maybe ClassRef)
  • invoiceSalesTermRef :: !(Maybe SalesTermRef)
  • invoiceDueDate :: !(Maybe Text)
  • invoiceGlobalTaxCalculation :: !(Maybe GlobalTaxModel)
  • invoiceShipMethodRef :: !(Maybe ShipMethodRef)
  • invoiceShipDate :: !(Maybe Text)
  • invoiceTrackingNum :: !(Maybe Text)
  • invoiceTotalAmt :: !(Maybe Double)
  • invoiceHomeTotalAmt :: !(Maybe Double)
  • invoiceApplyTaxAfterDiscount :: !(Maybe Bool)
  • invoicePrintStatus :: !(Maybe Text)
  • invoiceEmailStatus :: !(Maybe Text)
  • invoiceBillEmail :: !(Maybe EmailAddress)
  • invoiceDeliveryInfo :: !(Maybe DeliveryInfo)
  • invoiceBalance :: !(Maybe Double)
  • invoiceDepositToAccountRef :: !(Maybe DepositToAccountRef)
  • invoiceDeposit :: !(Maybe Double)
  • invoiceAllowIPNPayment :: !(Maybe Bool)
  • invoiceDomain :: !(Maybe Text)
  • invoiceSparse :: !(Maybe Bool)
  }
• defaultInvoice :: [Line] -> CustomerRef -> Invoice
• data InvoiceResponse = InvoiceResponse {
  • invoiceResponseInvoice :: Invoice
  }
• data CustomerResponse = CustomerResponse {
  • customerResponseCustomer :: !Customer
  }
• data Customer = Customer {
  • customerId :: !(Maybe Text)
  • customerSyncToken :: !(Maybe SyncToken)
  • customerMetaData :: !(Maybe ModificationMetaData)
  • customerTitle :: !(Maybe Text)
  • customerGivenName :: !(Maybe Text)
  • customerMiddleName :: !(Maybe Text)
  • customerFamilyName :: !(Maybe Text)
  • customerSuffix :: !(Maybe Text)
  • customerFullyQualifiedName :: !(Maybe Text)
  • customerCompanyName :: !(Maybe Text)
  • customerDisplayName :: !Text
  • customerPrintOnCheckName :: !(Maybe Text)
  • customerActive :: !(Maybe Bool)
  • customerPrimaryPhone :: !(Maybe TelephoneNumber)
  • customerAlternatePhone :: !(Maybe TelephoneNumber)
  • customerMobile :: !(Maybe TelephoneNumber)
  • customerFax :: !(Maybe TelephoneNumber)
  • customerPrimaryEmailAddress :: !(Maybe EmailAddress)
  • customerWebAddr :: !(Maybe WebSiteAddress)
  • customerDefaultTaxCodeRef :: !(Maybe TaxCodeRef)
  • customerTaxable :: !(Maybe Bool)
  • customerBillAddr :: !(Maybe BillAddr)
  • customerShipAddr :: !(Maybe ShipAddr)
  • customerNotes :: !(Maybe Text)
  • customerJob :: !(Maybe Bool)
  • customerBillWithParent :: !(Maybe Bool)
  • customerParentRef :: !(Maybe CustomerRef)
  • customerLevel :: !(Maybe Int)
  • customerSalesTermRef :: !(Maybe SalesTermRef)
  • customerPaymentMethodRef :: !(Maybe Reference)
  • customerBalance :: !(Maybe Double)
  • customerOpenBalanceDate :: !(Maybe Text)
  • customerBalanceWithJobs :: !(Maybe Double)
  • customerCurrencyRef :: !(Maybe CurrencyRef)
  • customerPreferredDeliveryMethod :: !(Maybe Text)
  • customerResaleNum :: !(Maybe Text)
  }
• data ItemResponse = ItemResponse {
  • itemResponseItem :: !Item
  }
• data Item = Item {
  • itemId :: !(Maybe Text)
  • itemSyncToken :: !(Maybe SyncToken)
  • itemMetaData :: !(Maybe ModificationMetaData)
  • itemName :: !Text
  • itemDescription :: !(Maybe Text)
  • itemActive :: !(Maybe Bool)
  • itemSubItem :: !(Maybe Bool)
  • itemParentRef :: !(Maybe ItemRef)
  • itemLevel :: !(Maybe Int)
  • itemFullyQualifiedName :: !(Maybe String)
  • itemTaxable :: !(Maybe Bool)
  • itemSalesTaxInclusive :: !(Maybe Bool)
  • itemUnitPrice :: !(Maybe Double)
  • itemType :: !(Maybe Text)
  • itemIncomeAccountRef :: !(Maybe Reference)
  • itemPurchaseDesc :: !(Maybe String)
  • itemPurchaseTaxInclusive :: !(Maybe Bool)
  • itemPurchaseCost :: !(Maybe Double)
  • itemExpenseAccountRef :: !(Maybe Reference)
  • itemAssetAccountRef :: !(Maybe Reference)
  • itemTrackQtyOnHand :: !(Maybe Bool)
  • itemQtyOnHand :: !(Maybe Double)
  • itemSalesTaxCodeRef :: !(Maybe Reference)
  • itemPurchaseTaxCodeRef :: !(Maybe Reference)
  • itemInvStartDate :: !(Maybe Text)
  }

Documentation

>>> let aSalesItemLineDetail = salesItemLineDetail ((reference "1") {referenceName = Just "Services"})
>>> salesItemLineDetailItemRef aSalesItemLineDetail
Just (Reference {referenceName = Just "Services", referenceType = Nothing, referenceValue = "1"})

>>> let aSalesItemLineDetail = salesItemLineDetail ((reference "1") {referenceName = Just "Services"})
>>> let aSalesItemLine = salesItemLine 100.0 aSalesItemLineDetail

>>> reference "21"
Reference {referenceName = Nothing, referenceType = Nothing, referenceValue = "21"}

>>> (reference "21") {referenceName = Just "John Doe"} :: CustomerRef
Reference {referenceName = Just "John Doe", referenceType = Nothing, referenceValue = "21"}

>>> let customer21 = reference "21" :: CustomerRef
>>> let aSalesItemLineDetail = salesItemLineDetail ((reference "1") {referenceName = Just "Services"})
>>> let aSalesItemLine = salesItemLine 100.0 aSalesItemLineDetail

>>> let anInvoice = defaultInvoice [aSalesItemLine] customer21