{"basePath":"/v1","consumes":["application/json"],"definitions":{"Address":{"properties":{"City":{"description":"City","type":"string"},"Country":{"description":"Country full name","type":"string"},"CountryCode":{"description":"Country Code","type":"string"},"PostalCode":{"description":"Postal Code","type":"string"},"State":{"description":"State full name","type":"string"},"StateCode":{"description":"State Code","type":"string"},"Street":{"description":"Street number and name","type":"string"}},"type":"object"},"CashReceipt":{"properties":{"AccountID":{"description":"Account Name","type":"string"},"Amount":{"description":"Amount","type":"number"},"AppliedAmount":{"description":"Applied Amount","type":"number"},"AttemptNumber":{"description":"Attempt Number","type":"number"},"AuditMessage":{"description":"Audit Trail Message","type":"string"},"AutoPay":{"description":"Autopay?","type":"boolean"},"BillingContactID":{"description":"Billing Contact","type":"string"},"CashReceiptDate":{"description":"Journal Date","type":"string"},"CashReceiptNumber":{"description":"Journal Date","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"Description":{"description":"Memo","type":"string"},"Gateway":{"description":"Gateway","type":"string"},"GatewayKey":{"description":"Gateway Key","type":"string"},"GatewayMessage":{"description":"Gateway Message","type":"string"},"GatewayTransaction":{"description":"GatewayTxn?","type":"boolean"},"ID":{"description":"Salesforce Record Id","type":"string"},"IsValid":{"description":"Is Valid?","type":"boolean"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"PartnerAccountID":{"description":"Partner Account","type":"string"},"PaymentMethodID":{"description":"Payment Method","type":"string"},"PaymentNumber":{"description":"Payment Number","type":"string"},"Pending":{"description":"Pending?","type":"boolean"},"PeriodID":{"description":"Period","type":"string"},"Posted":{"description":"Posted to external system?","type":"boolean"},"Processed":{"description":"Processed","type":"boolean"},"Processing":{"description":"Processing","type":"boolean"},"RecordTypeID":{"description":"Record Type","type":"string"},"Ref":{"description":"Reference","type":"string"},"ReferenceNumber":{"description":"Reference Number","type":"string"},"Rejected":{"description":"Rejected?","type":"boolean"},"Source":{"description":"Source Payment Method","type":"string"},"Status":{"description":"Payment Status","type":"string"},"Type":{"description":"Type","type":"string"},"UnappliedAmount":{"description":"Unapplied Amount","type":"number"},"ValidPayment":{"description":"Valid Payment?","type":"boolean"},"XeroID":{"description":"Xero Credit Note Id","type":"string"}},"type":"object"},"CashReceiptRequest":{"properties":{"Data":{"items":{"$ref":"#/definitions/CashReceipt"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"required":["Meta","Data"],"type":"object"},"CashReceiptResponse":{"description":"An array of Account objects with Contacts","properties":{"Data":{"items":{"$ref":"#/definitions/CashReceipt"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Charge":{"properties":{"AccountID":{"description":"Account","type":"string"},"Amount":{"description":"Amount","type":"number"},"BillingContactID":{"description":"Billing Contact ID","type":"string"},"ContractID":{"description":"Contract","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"Description":{"description":"Description","type":"string"},"EmailMessage":{"description":"Email Message","type":"string"},"ExternalMessage":{"description":"External Message","type":"string"},"ID":{"description":"Salesforce Record Id","type":"string"},"JournalDate":{"description":"Journal Date","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"PartnerAccountID":{"description":"Partner Account","type":"string"},"PaymentTerms":{"description":"Payment Terms","type":"string"},"PeriodID":{"description":"Period","type":"string"},"Posted":{"description":"Posted to external system?","type":"boolean"},"ProductID":{"description":"Product","type":"string"},"Quantity":{"description":"Quantity","type":"number"},"UnitPrice":{"description":"Unit Price","type":"number"}},"type":"object"},"ChargeRequest":{"properties":{"Data":{"items":{"$ref":"#/definitions/Charge"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"required":["Meta","Data"],"type":"object"},"ChargeResponse":{"description":"An array of ChargeObject objects","properties":{"Data":{"items":{"$ref":"#/definitions/Charge"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Contract":{"properties":{"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"Description":{"description":"Description","type":"string"},"EndDate":{"description":"Contract End Date","type":"string"},"HourlyRate":{"description":"Hourly Rate","type":"number"},"ID":{"description":"Taxnexus Record Id","type":"string"},"IsActive":{"description":"Is Active?","type":"boolean"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"Name":{"description":"Contract Name","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PaymentTerms":{"description":"Payment Terms","type":"string"},"PriceBookID":{"description":"Price Book","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"StartDate":{"description":"Contract Start Date","type":"string"},"Status":{"description":"Status","type":"string"},"Type":{"description":"Contract Type","type":"string"}},"type":"object"},"CreditCard":{"properties":{"Active":{"description":"Active","type":"boolean"},"BillingCity":{"description":"Billing City","type":"string"},"BillingPostalcode":{"description":"Billing Postal Code","type":"string"},"BillingState":{"description":"Billing State","type":"string"},"BillingStreet":{"description":"Billing Street","type":"string"},"CCType":{"description":"CC Type","type":"string"},"CcNumber":{"description":"CC Number","type":"string"},"CompanyID":{"description":"Company","type":"string"},"ExpMonth":{"description":"Exp Month","type":"string"},"ExpYear":{"description":"Exp Year","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"Name":{"description":"CC Name","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"}},"type":"object"},"DeleteResponse":{"properties":{"Data":{"items":{"$ref":"#/definitions/Message"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Error":{"properties":{"code":{"format":"int64","type":"integer"},"fields":{"type":"string"},"message":{"type":"string"}},"type":"object"},"InvalidError":{"allOf":[{"$ref":"#/definitions/Error"},{"properties":{"details":{"items":{"type":"string"},"type":"array"}},"type":"object"}]},"Invoice":{"properties":{"AccountID":{"description":"Account ID","type":"string"},"Advance":{"description":"Advance?","type":"boolean"},"Amount":{"description":"Invoice Amount","format":"double","type":"number"},"AmountAdjustment":{"description":"Amount Adjustment","format":"double","type":"number"},"AmountDue":{"description":"Amount Due","format":"double","type":"number"},"AmountPaid":{"description":"Amount Paid","format":"double","type":"number"},"AuditMessage":{"description":"Audit Trail Message","type":"string"},"BillingAddress":{"$ref":"#/definitions/Address"},"BillingContactID":{"description":"Billing Contact ID","type":"string"},"BillingRunID":{"description":"Billing Run","type":"string"},"BusinessAddress":{"$ref":"#/definitions/Address"},"BusinessTax":{"description":"The amount of Deferred Tax incurred with this invoice","format":"double","type":"number"},"CannabisTax":{"description":"Cannabis Tax","format":"double","type":"number"},"ContractID":{"description":"Contract","type":"string"},"CoordinateID":{"description":"The ID of the Coordinate used to rate this item","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"CustomerID":{"description":"Customer ID","type":"string"},"DateIssued":{"description":"Date Issued","type":"string"},"DaysDue":{"description":"Days Due","format":"int64","type":"number"},"DepositAmount":{"description":"Deposit Amount","format":"double","type":"number"},"Description":{"description":"Description","type":"string"},"Discount":{"description":"Discount","format":"double","type":"number"},"EstimatedAmount":{"description":"Invoice Total from source system","format":"double","type":"number"},"EstimatedBusinessTax":{"description":"Invoice Total from source system","format":"double","type":"number"},"EstimatedCOGS":{"description":"Invoice Total from source system","format":"double","type":"number"},"EstimatedCannabisTax":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedDiscount":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedSalesTax":{"description":"Sales Tax from source system","format":"double","type":"number"},"EstimatedSubtotal":{"description":"Invoice Subtotal from source system","format":"double","type":"number"},"ID":{"description":"Taxnexus Record Id","type":"string"},"IngestID":{"description":"ID of the Ingest which created this Invoice","type":"string"},"InvoiceDate":{"description":"Invoice Date","type":"string"},"InvoiceNumber":{"description":"Invoice Number","type":"string"},"IsInternational":{"description":"Is International?","type":"boolean"},"IsValid":{"description":"Is Valid?","type":"boolean"},"IssuedAccountBalance":{"description":"Issued Account Balance","format":"double","type":"number"},"IssuedAmountDue":{"description":"Issued Amount Due","format":"double","type":"number"},"IssuedByID":{"description":"Issued By","type":"string"},"Items":{"description":"The items associated with this Invoice","items":{"$ref":"#/definitions/InvoiceItem"},"type":"array"},"JobID":{"description":"ID of the Job which created this Invoice","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LineItemCount":{"description":"Line Item Count","format":"int64","type":"number"},"MinimumPaymentDue":{"description":"Minimum Payment Due","format":"double","type":"number"},"MonthlyAmount":{"description":"Monthly Amount","format":"double","type":"number"},"OpportunityID":{"description":"Opportunity","type":"string"},"OrderID":{"description":"Order","type":"string"},"OverDue0":{"description":"Overdue0","format":"double","type":"number"},"OverDue120":{"description":"Overdue 120 Days Amount","format":"double","type":"number"},"OverDue30":{"description":"Overdue 30 Days Amount","format":"double","type":"number"},"OverDue45":{"description":"Overdue 45 Days Amount","format":"double","type":"number"},"OverDue60":{"description":"Overdue 60 Days Amount","format":"double","type":"number"},"OverDue90":{"description":"Overdue 90 Days Amount","format":"double","type":"number"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PartnerAccountID":{"description":"Partner Account","type":"string"},"PaymentDue":{"description":"Payment Due","type":"string"},"PaymentMethod":{"description":"Payment Method","type":"string"},"PaymentMethodID":{"description":"Payment Method","type":"string"},"PaymentTerms":{"description":"Payment Terms","type":"string"},"PeriodID":{"description":"Period","type":"string"},"PlaceGeocode":{"description":"The Taxnexus Geocode of the Place used for Situs","type":"string"},"Posted":{"description":"Posted to external system?","type":"boolean"},"PriorAccountBalance":{"description":"Prior Account Balance","format":"double","type":"number"},"PriorAdjustments":{"description":"Prior Adjustments","format":"double","type":"number"},"PriorInvoiceAmount":{"description":"Prior Invoice Amount","format":"double","type":"number"},"PriorInvoiceDate":{"description":"Prior Invoice Date","type":"string"},"PriorInvoiceID":{"description":"Prior Invoice","format":"double","type":"string"},"PriorPaymentAmount":{"description":"Prior Payment Amount","format":"double","type":"number"},"PriorPaymentDate":{"description":"Prior Payment Date","type":"string"},"PriorPaymentID":{"description":"Prior Payment","type":"string"},"PriorPaymentMemo":{"description":"Prior Payment Memo","type":"string"},"Prorated":{"description":"Prorated?","type":"boolean"},"ProtratedDays":{"description":"Prorated Days","format":"double","type":"number"},"PurchaseAmount":{"description":"Purchase Amount","format":"double","type":"number"},"QuoteID":{"description":"Quote","type":"string"},"RatingEnginbgID":{"description":"The ID of the Rating Engine that rated this invoice","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"Reference":{"description":"Reference","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type (Medicinal or Recreational)","type":"string"},"SalesTax":{"description":"Sales Tax","format":"double","type":"number"},"ScheduledPaymentDate":{"description":"Scheduled Payment Date","type":"string"},"ServiceTerm":{"description":"Service Term","type":"string"},"ShippingAddress":{"$ref":"#/definitions/Address"},"ShippingHandling":{"description":"Shipping \u0026 Handling","format":"double","type":"number"},"Status":{"description":"Status","type":"string"},"Subtotal":{"description":"Subtotal","type":"number"},"TaxTransactions":{"description":"The taxes associated with this Invoice","items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"TelecomTax":{"description":"Telecom Tax","format":"double","type":"number"},"TemplateID":{"description":"Template","type":"string"},"Total":{"$ref":"#/definitions/Total"},"Type":{"description":"Type","type":"string"}},"type":"object"},"InvoiceBasic":{"properties":{"AccountID":{"description":"Account Identifier from Source System; ignored in tax calculations","type":"string"},"Amount":{"description":"Invoice Amount; ignored in tax calculation","type":"number"},"AmountDue":{"description":"Amount Due; ignored in tax calculations","type":"number"},"BusinessAddress":{"$ref":"#/definitions/Address"},"CustomerID":{"description":"OEM Customer Identifier","type":"string"},"EstimatedAmount":{"description":"Invoice Total from source system","format":"double","type":"number"},"EstimatedBusinessTax":{"description":"Business tax from source system","format":"double","type":"number"},"EstimatedCOGS":{"description":"Cost of Goods Sold from source system","format":"double","type":"number"},"EstimatedCannabisTax":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedDiscount":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedSalesTax":{"description":"Sales Tax from source system","format":"double","type":"number"},"EstimatedSubtotal":{"description":"Invoice Subtotal from source system","format":"double","type":"number"},"ID":{"description":"Taxnexus ID","type":"string"},"IngestID":{"description":"ID of the Ingest which created this Invoice","type":"string"},"InvoiceDate":{"description":"Invoice Date; should be date only or correct time zone if in time notation","type":"string"},"InvoiceNumber":{"description":"Source System Customer-Facing Invoice Number; ignored in tax calculation","type":"string"},"Items":{"description":"The items associated with this Invoice","items":{"$ref":"#/definitions/ItemBasic"},"type":"array"},"JobID":{"description":"ID of the Job which created this Invoice","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PeriodID":{"description":"Taxnexus Period ID","type":"string"},"PlaceGeocode":{"description":"The Taxnexus Geocode of the Place used for Situs","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","type":"string"},"ShippingHandling":{"description":"Shipping and Handling fees for this document","type":"number"},"Status":{"description":"Status used by for Billing Balances; ignored in tax calculation","type":"string"},"Subtotal":{"description":"Subtotal of items","type":"number"},"TaxTransactions":{"description":"The Tax Transactions \"Source System identifier for this record, if any; copied to invoiceitemid in Tax Transaction result records\"","items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"Total":{"$ref":"#/definitions/Total"},"Type":{"description":"Invoice Type","type":"string"}},"required":["AccountID","Items","InvoiceNumber","InvoiceDate","SalesRegulation"]},"InvoiceItem":{"properties":{"AccountID":{"description":"Account ID","type":"string"},"COGS":{"description":"Cost of Goods Sold","format":"double","type":"number"},"CensusTract":{"description":"Census Tract","type":"string"},"ContractID":{"description":"Contract Number","type":"string"},"CoordinateID":{"description":"The ID of the Coordinate used to rate this item","type":"string"},"CountyID":{"description":"County","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"CustomerID":{"description":"Reseller or OEM customer identifier","type":"string"},"Date":{"description":"Invoice Date","type":"string"},"Description":{"description":"Line Item Description","type":"string"},"ExportDescription":{"description":"Export Description","type":"string"},"Family":{"description":"Family","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"InvoiceID":{"description":"Invoice","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LineNumber":{"description":"Line","format":"int64","type":"number"},"ListPrice":{"description":"List Price","type":"number"},"LocationID":{"description":"Location","type":"string"},"MRCInterval":{"description":"Quantity","format":"int64","type":"number"},"OrderItemID":{"description":"Order Item","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PeriodID":{"description":"Period","type":"string"},"PlaceGeocode":{"description":"Taxnexus Geocode of where this invoice item was rated","type":"string"},"ProductCode":{"description":"Product Code","type":"string"},"ProductID":{"description":"Product","type":"string"},"Quantity":{"description":"Quantity","format":"double","type":"number"},"QuoteItemID":{"description":"Quote Line Item","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"RejectedQuantity":{"description":"Rejected Quantity","format":"double","type":"number"},"SKU":{"description":"SKU","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","type":"string"},"ShippedQuantity":{"description":"Shipped Quantity","format":"double","type":"number"},"ShippingHandling":{"description":"Shipping \u0026 Handling","format":"double","type":"number"},"SubscriptionID":{"description":"Subscription","type":"string"},"Subtotal":{"description":"Subtotal","format":"double","type":"number"},"TaxnexusCode":{"description":"Taxnexus Code","type":"string"},"TotalPrice":{"description":"Total Price","type":"number"},"UnitPrice":{"description":"Unit Price","type":"number"},"Units":{"description":"The Unit of Measure for this item","type":"string"}},"type":"object"},"InvoiceRequest":{"properties":{"Data":{"items":{"$ref":"#/definitions/InvoiceBasic"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"required":["Meta","Data"],"type":"object"},"InvoiceResponse":{"properties":{"Data":{"items":{"$ref":"#/definitions/Invoice"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"ItemBasic":{"properties":{"AccountID":{"description":"Taxnexus Account that generated this item","type":"string"},"COGS":{"description":"Cost of Goods Sold","format":"double","type":"number"},"CustomerID":{"description":"OEM Customer Identifier","type":"string"},"Date":{"description":"Transaction date","type":"string"},"Description":{"description":"Line Item Description","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"MRCInterval":{"description":"Quantity","format":"int64","type":"number"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PeriodID":{"description":"The Accounting Period in which this item was booked","type":"string"},"PlaceGeocode":{"description":"The geocode of the tax situs for this item","type":"string"},"ProductCode":{"description":"Product Code","type":"string"},"Quantity":{"description":"Quantity","format":"double","type":"number"},"Ref":{"description":"Source System identifier for this record, if any; copied to invoiceitemid in Tax Transaction result records","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","type":"string"},"ShippingHandling":{"description":"Shipping \u0026 Handling and Delivery Fees for this Item","format":"double","type":"number"},"Subtotal":{"description":"Subtotal","format":"double","type":"number"},"TaxnexusCode":{"description":"Taxnexus Code","type":"string"},"UnitPrice":{"description":"Unit Price","format":"double","type":"number"},"Units":{"description":"The Unit of Measure for this item","type":"string"}},"required":["Quantity","UnitPrice","TaxnexusCode"],"type":"object"},"Message":{"properties":{"message":{"type":"string"},"ref":{"type":"string"}},"type":"object"},"Order":{"properties":{"AccountID":{"description":"Account ID","type":"string"},"ActivatedByID":{"description":"Activated By ID","type":"string"},"ActivatedDate":{"description":"Activated Date","type":"string"},"Amount":{"description":"Order Amount","type":"number"},"BillingAddress":{"$ref":"#/definitions/Address"},"BillingContactID":{"description":"Billing Contact ID","type":"string"},"BillintType":{"description":"Billing Type","type":"string"},"BusinessAddress":{"$ref":"#/definitions/Address"},"CannabisTax":{"description":"Cannabis Tax","type":"number"},"CompanyAuthorizedByID":{"description":"Company Authorized By","type":"string"},"CompanyAuthorizedDate":{"description":"Company Authorized Date","type":"string"},"Completion":{"description":"Completion Status","type":"string"},"ContactEndDate":{"description":"Contract End Date","type":"string"},"ContactID":{"type":"string"},"ContractID":{"description":"Contract Number","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"CustomerAuthorizedBy":{"description":"Customer Authorized By","type":"string"},"CustomerAuthorizedDate":{"description":"Customer Authorized Date","type":"string"},"Description":{"description":"Description","type":"string"},"EffectiveDate":{"description":"Order Start Date","type":"string"},"EndDate":{"description":"Order End Date","type":"string"},"EndUserID":{"description":"End User Contact ID","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"Installation":{"description":"Installation Date","type":"string"},"InvoiceID":{"description":"Invoice ID","type":"string"},"IsReductionOrder":{"description":"Reduction Order","type":"boolean"},"Items":{"description":"The Order Items","items":{"$ref":"#/definitions/OrderItem"},"type":"array"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LineItemCount":{"description":"Line Item Count","format":"int64","type":"number"},"MonthlyAmount":{"description":"Monthly Amount","format":"double","type":"number"},"Name":{"description":"Order Name","type":"string"},"Open":{"description":"Open Order?","type":"boolean"},"OpportunityID":{"description":"Opportunity","type":"string"},"OrderNumber":{"description":"Order Number","type":"string"},"OrderReferenceNumber":{"description":"Order Reference Number","type":"string"},"OriginalOrderID":{"description":"Original Order","type":"string"},"OwnerID":{"description":"Order Owner","type":"string"},"PODate":{"description":"PO Date","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PaymentMethodID":{"description":"Payment Method ID","type":"string"},"PaymentTerms":{"description":"Payment Terms","type":"string"},"Posted":{"description":"Posted to external system?","type":"boolean"},"ProvisioningStatus":{"description":"Provisioning Status","type":"string"},"PurchaseAmount":{"description":"Purchase Amount","format":"double","type":"number"},"PurchaseOrderID":{"description":"PO ID","type":"string"},"QuoteID":{"description":"Quote","type":"string"},"RecordTypeID":{"description":"Order Record Type","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","type":"string"},"SalesTax":{"description":"Sales Tax","format":"double","type":"number"},"ServiceTerm":{"description":"Service Term","type":"string"},"ShippingAddress":{"$ref":"#/definitions/Address"},"ShippingContactID":{"description":"Shipping Contact ID","type":"string"},"ShippingHandling":{"description":"Shipping \u0026 Handling","format":"double","type":"number"},"Status":{"description":"Status","type":"string"},"Subtotal":{"description":"Subtotal","type":"number"},"TaxTransactions":{"description":"The taxes associated with this Order","items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"TelecomTax":{"description":"Telecom Tax","format":"double","type":"number"},"TemplateID":{"description":"Template","type":"string"},"Total":{"$ref":"#/definitions/Total"},"TotalAmount":{"description":"Order Amount","format":"double","type":"number"},"Type":{"description":"Order Type","type":"string"}},"type":"object"},"OrderBasic":{"properties":{"AccountID":{"description":"Account Identifier from Source System; ignored in tax calculations","type":"string"},"Amount":{"description":"Invoice Amount; ignored in tax calculation","type":"number"},"AmountDue":{"description":"Amount Due; ignored in tax calculations","type":"number"},"BusinessAddress":{"$ref":"#/definitions/Address"},"CustomerID":{"description":"OEM Customer Identifier","type":"string"},"EstimatedAmount":{"description":"Invoice Total from source system","format":"double","type":"number"},"EstimatedBusinessTax":{"description":"Business tax from source system","format":"double","type":"number"},"EstimatedCannabisTax":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedCogs":{"description":"Cost of Goods Sold from source system","format":"double","type":"number"},"EstimatedDiscount":{"description":"Discount from source system","format":"double","type":"number"},"EstimatedSalesTax":{"description":"Sales Tax from source system","format":"double","type":"number"},"EstimatedSubtotal":{"description":"Invoice Subtotal from source system","format":"double","type":"number"},"ID":{"description":"Taxnexus ID","type":"string"},"IngestID":{"description":"ID of the Ingest which created this Invoice","type":"string"},"Items":{"description":"The items associated with this Invoice","items":{"$ref":"#/definitions/ItemBasic"},"type":"array"},"JobID":{"description":"ID of the Job which created this Invoice","type":"string"},"OrderDate":{"description":"Invoice Date; should be date only or correct time zone if in time notation","type":"string"},"OrderNumber":{"description":"Source System Customer-Facing Invoice Number; ignored in tax calculation","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PeriodID":{"description":"Taxnexus Period ID","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","enum":["AdultUse","Caregiver","Consumer","Medicinal","MedicinalState","MedicinalThirdParty","Merchandise","Patient","Telecom"],"type":"string"},"ShippingHandling":{"description":"Shipping and Handling fees for this document","type":"number"},"Status":{"description":"Status used by for Billing Balances; ignored in tax calculation","enum":["closed","delivered","hold","issued","new","posted","rated","rating_failed","rating_ready","reissued","rendered","uncollectable","voided"],"type":"string"},"Subtotal":{"description":"Subtotal of items","type":"number"},"TaxTransaction":{"description":"The Tax Transactions \"Source System identifier for this record, if any; copied to invoiceitemid in Tax Transaction result records\"","items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"Total":{"$ref":"#/definitions/Total"},"Type":{"description":"Invoice Type","type":"string"}},"required":["AccountID","Items","OrderNumber","OrderDate","SalesRegulation"]},"OrderItem":{"properties":{"AccountID":{"description":"Account","type":"object"},"Activated":{"description":"Activated?","type":"boolean"},"ActiveatedByID":{"description":"Activated By","type":"string"},"AvailableQuantity":{"description":"Available Quantity","format":"double","type":"number"},"ContractID":{"description":"Contract Number","type":"string"},"CreateReservation":{"description":"Create Reservation?","type":"boolean"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"DateDelivered":{"description":"Date Delivered","type":"string"},"DateOrdered":{"description":"Date Ordered","type":"string"},"DatePromised":{"description":"Date Promised","type":"string"},"Description":{"description":"Line Description","type":"string"},"Discount":{"description":"Discount","format":"double","type":"number"},"EndDate":{"description":"End Date","type":"string"},"Family":{"description":"Family","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"InventoryTracking":{"description":"Inventory Tracking","type":"boolean"},"InvoiceItemID":{"description":"Invoice Item","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LineGrossAmount":{"description":"Line Gross Amount","format":"double","type":"number"},"LineItemNumber":{"description":"Line Item Number","format":"int64","type":"number"},"ListPrice":{"description":"List Price","format":"double","type":"number"},"LocationID":{"description":"Location","type":"string"},"OrderID":{"description":"Order","type":"string"},"OriginalOrderItemID":{"description":"Original Order Product","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"Posted":{"description":"Posted to external system?","type":"boolean"},"ProductID":{"description":"Product","type":"string"},"ProductName":{"description":"Product Name","type":"string"},"Quantity":{"description":"Quantity","format":"double","type":"number"},"QuantityOnHand":{"description":"Quantity On Hand","format":"double","type":"number"},"QuoteItemID":{"description":"Quote Line Item","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"ServiceDate":{"description":"Start Date","type":"string"},"ShippingHandling":{"description":"Shipping \u0026 Handling","format":"double","type":"number"},"Status":{"description":"Status","type":"string"},"SubscriptionID":{"description":"Subscription","type":"string"},"Subtotal":{"description":"Subtotal","format":"double","type":"number"},"TaxnexusCodeDisplay":{"description":"Taxnexus Code Display","type":"string"},"TaxnexusCodeID":{"description":"Taxnexus Code","type":"string"},"TotalPrice":{"description":"Total Price","format":"double","type":"number"},"UnitPrice":{"description":"Unit Price","format":"double","type":"number"},"Units":{"description":"Units","type":"string"}},"type":"object"},"OrderRequest":{"description":"An array of Order objects","properties":{"Data":{"items":{"$ref":"#/definitions/Order"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"required":["Meta","Data"],"type":"object"},"OrderResponse":{"description":"An array of Order objects","properties":{"Data":{"items":{"$ref":"#/definitions/Order"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Pagination":{"properties":{"Limit":{"format":"int64","type":"integer"},"Offset":{"format":"int64","type":"integer"},"PageSize":{"format":"int64","type":"integer"},"SetSize":{"format":"int64","type":"integer"}},"type":"object"},"PostResponse":{"properties":{"Data":{"items":{"$ref":"#/definitions/Message"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Pricebook":{"properties":{"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"Description":{"description":"Description","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"IsActive":{"description":"Active","type":"boolean"},"IsStandard":{"description":"Is Standard Price Book","type":"boolean"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"Name":{"description":"Price Book Name","type":"string"}},"type":"object"},"PricebookEntry":{"properties":{"AccountID":{"description":"Active","type":"string"},"AgentID":{"description":"Created By","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"ID":{"description":"Record Id","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"PricebookID":{"type":"string"},"ProductCode":{"description":"Product Code","type":"string"},"UnitPrice":{"description":"List Price","format":"double","type":"number"},"UseStandardPrice":{"description":"Use Standard Price","type":"boolean"},"procuctID":{"type":"string"}},"type":"object"},"Product":{"properties":{"AccountID":{"description":"Account ID of the account that owns this product"},"CompanyID":{"description":"Company","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"Description":{"description":"Product Description","type":"string"},"DescriptionSKU":{"description":"DescriptionSKU","type":"string"},"DisplayURL":{"description":"Display URL","type":"string"},"Family":{"description":"Product Family","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"Image500URL":{"description":"Image (500)","type":"string"},"ImageFullURL":{"description":"Image (Full)","type":"string"},"IsActive":{"description":"Active","type":"boolean"},"IsAssetTracking":{"description":"Asset Tracking?","type":"boolean"},"IsGeneric":{"description":"isGeneric","type":"boolean"},"IsInventoryTracking":{"description":"Inventory Tracking?","type":"boolean"},"IsMerchandise":{"description":"Merchandise Product?","type":"boolean"},"IsProrateable":{"description":"Prorateable?","type":"boolean"},"IsPublished":{"description":"Publish?","type":"boolean"},"IsRefundable":{"description":"Refundable?","type":"boolean"},"IsUnlimited":{"description":"Unlimited usage?","type":"boolean"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"MRCInterval":{"description":"MRC Interval","format":"int64","type":"number"},"MSRP":{"description":"MSRP","type":"number"},"ManufacturerID":{"description":"Manufacturer","type":"string"},"ManufacturerProductCode":{"description":"Manufacturer Product Code","type":"string"},"Name":{"description":"Product Name","type":"string"},"Prices":{"items":{"$ref":"#/definitions/PricebookEntry"},"type":"array"},"ProductCode":{"description":"Product Code","type":"string"},"QuantityUnitOfMeasure":{"description":"Quantity Unit Of Measure","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"SKU":{"description":"SKU","type":"string"},"ShippingWeight":{"description":"Shipping Weight","format":"double","type":"number"},"Specifications":{"description":"Specifications","type":"string"},"TaxnexusCodeDisplay":{"description":"Taxnexus Code Name","type":"string"},"TaxnexusCodeID":{"description":"Taxnexus Code","type":"string"},"UPC":{"description":"UPC","type":"string"},"Units":{"description":"Units","type":"string"},"VendorID":{"description":"Vendor","type":"string"},"VendorName":{"description":"Vendor Name","type":"string"},"VendorPartNumber":{"description":"Vendor Part Number","type":"string"},"VendorPrice":{"description":"Vendor Price","format":"double","type":"number"}},"type":"object"},"ProductBasic":{"properties":{"Cost":{"format":"double","type":"number"},"Description":{"type":"string"},"DescriptionSKU":{"type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"MRCInterval":{"type":"number"},"Name":{"type":"string"},"Price":{"format":"double","type":"number"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"TaxnexusCode":{"type":"string"},"Units":{"type":"string"}},"type":"object"},"ProductRequest":{"properties":{"Data":{"items":{"$ref":"#/definitions/Product"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"required":["Meta","Data"],"type":"object"},"ProductResponse":{"description":"An array of Product objects","properties":{"Data":{"items":{"$ref":"#/definitions/Product"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"PurchaseOrder":{"properties":{"AccountID":{"description":"Account ID","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"CreditCardID":{"type":"string"},"DateExpires":{"description":"Date Expires","type":"string"},"DatePromised":{"description":"Date Promised","type":"string"},"DateRequested":{"description":"Date Requested","type":"string"},"Description":{"description":"Description","type":"string"},"DueDate":{"description":"Due Date","type":"string"},"EndUserID":{"description":"End User Contact ID","type":"string"},"Grand":{"description":"Grand Total","format":"double","type":"number"},"ID":{"description":"Taxnexus Record Id","type":"string"},"Items":{"items":{"$ref":"#/definitions/PurchaseOrderItem"},"type":"array"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LineItemCount":{"description":"Line Item Count","format":"int64","type":"number"},"OpportunityID":{"description":"Opportunity Name","type":"string"},"OrderID":{"description":"Order Number","type":"string"},"PODate":{"description":"Date","type":"string"},"PONumber":{"description":"Number","type":"string"},"ParentFK":{"description":"The record identifier from the source system","type":"string"},"PaymentTerms":{"description":"Payment Terms","type":"string"},"Posted":{"description":"Posted to external system?","type":"boolean"},"QuoteID":{"description":"Quote Name","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"Sales":{"description":"Addl Tax","type":"number"},"SalesRegulation":{"description":"Sales Regulation Type (Medicinal or Recreational)","type":"string"},"ServiceTerm":{"description":"Service Term","type":"string"},"ShipDate":{"description":"Ship Date","type":"string"},"ShippingAddress":{"description":"Shipping Address","type":"string"},"ShippingCity":{"description":"Shipping City","type":"string"},"ShippingContactID":{"description":"Shipping Contact ID","type":"string"},"ShippingHandling":{"description":"Shipping \u0026 Handling","format":"double","type":"number"},"ShippingPostalcode":{"description":"Shipping Postal Code","type":"string"},"ShippingSpecialInstructions":{"description":"Shipping Special Instructions","type":"string"},"ShippingState":{"description":"Shipping State","type":"string"},"ShippingStreet":{"description":"Shipping Street","type":"string"},"Status":{"description":"Status","type":"string"},"Subtotal":{"description":"Subtotal","format":"double","type":"number"},"TaxTransactions":{"description":"The taxes associated with this Purchase Order","items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"Taxable":{"description":"Taxable?","type":"string"},"TotalID":{"$ref":"#/definitions/Total"},"TotalPrice":{"description":"Total Price","format":"double","type":"number"},"Type":{"description":"Type","type":"string"},"VendorID":{"description":"Vendor Account ID","type":"string"},"VendorQuoteNumber":{"description":"Vendor Quote Number","type":"string"},"shippingcountry":{"description":"Shipping Country","type":"string"}},"type":"object"},"PurchaseOrderBasic":{"properties":{"AccountID":{"description":"Account Identifier from Source System; ignored in tax calculations","type":"string"},"Amount":{"description":"Invoice Amount; ignored in tax calculation","type":"number"},"AmountDue":{"description":"Amount Due; ignored in tax calculations","type":"number"},"BusinessAddress":{"$ref":"#/definitions/Address"},"CustomerID":{"description":"OEM Customer Identifier","type":"string"},"EstimatedAmount":{"description":"Invoice Total from source system","format":"double","type":"number"},"EstimatedBusinessTax":{"description":"Business tax from source system","format":"double","type":"number"},"EstimatedCannabisTax":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedCogs":{"description":"Cost of Goods Sold from source system","format":"double","type":"number"},"EstimatedDiscount":{"description":"Discount from source system","format":"double","type":"number"},"EstimatedSalesTax":{"description":"Sales Tax from source system","format":"double","type":"number"},"EstimatedSubtotal":{"description":"Invoice Subtotal from source system","format":"double","type":"number"},"ID":{"description":"Taxnexus ID","type":"string"},"IngestID":{"description":"ID of the Ingest which created this Invoice","type":"string"},"Items":{"description":"The items associated with this Invoice","items":{"$ref":"#/definitions/ItemBasic"},"type":"array"},"JobID":{"description":"ID of the Job which created this Invoice","type":"string"},"PODate":{"description":"Invoice Date; should be date only or correct time zone if in time notation","type":"string"},"PONumber":{"description":"Source System Customer-Facing Invoice Number; ignored in tax calculation","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PeriodID":{"description":"Taxnexus Period ID","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","enum":["AdultUse","Caregiver","Consumer","Medicinal","MedicinalState","MedicinalThirdParty","Merchandise","Patient","Telecom"],"type":"string"},"ShippingHandling":{"description":"Shipping and Handling fees for this document","type":"number"},"Status":{"description":"Status used by for Billing Balances; ignored in tax calculation","enum":["closed","delivered","hold","issued","new","posted","rated","rating_failed","rating_ready","reissued","rendered","uncollectable","voided"],"type":"string"},"Subtotal":{"description":"Subtotal of items","type":"number"},"TaxTransaction":{"description":"The Tax Transactions \"Source System identifier for this record, if any; copied to invoiceitemid in Tax Transaction result records\"","items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"Total":{"$ref":"#/definitions/Total"},"Type":{"description":"Invoice Type","type":"string"}},"required":["AccountID","Items","PONumber","PODate","SalesRegulation"]},"PurchaseOrderItem":{"properties":{"AccountID":{"description":"Account","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"Description":{"description":"Line Item Description","type":"string"},"DueDate":{"description":"Due Date","type":"string"},"EndUserID":{"description":"End User","type":"string"},"ID":{"description":"Record Id","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LineNumber":{"description":"Line","format":"int64","type":"number"},"LocationID":{"description":"Location","type":"string"},"OrderItemID":{"description":"Order Item","type":"string"},"ParentFK":{"description":"The record identifier of the parent record from the source system","type":"string"},"PartnerAccountID":{"description":"Partner Account","type":"string"},"Posted":{"description":"Posted to external system?","type":"boolean"},"PricebookEntryID":{"description":"PricebookEntryID","type":"string"},"ProductCode":{"description":"Product Code","type":"string"},"ProductID":{"description":"Product ID","type":"string"},"PurchaseOrderID":{"description":"Purchase Order","type":"string"},"Quantity":{"description":"Quantity","format":"double","type":"number"},"QuoteLineItemID":{"description":"Quote Item","type":"string"},"ReceivedQuantity":{"description":"Received Quantity","format":"double","type":"number"},"RejectedQuantity":{"description":"Rejected Quantity","format":"double","type":"number"},"ShippmentItemID":{"description":"Shipment Item ID","type":"string"},"Status":{"description":"Status","type":"string"},"StockedQuantity":{"description":"Stocked Quantity","format":"double","type":"number"},"Subtotal":{"description":"Subtotal","format":"double","type":"number"},"TaxnexusCodeDisplay":{"description":"Taxnexus Code","type":"string"},"TaxnexusCodeID":{"description":"Taxnexus Code","type":"string"},"TotalPrice":{"description":"Total Price","format":"double","type":"number"},"UnitPrice":{"description":"Unit Price","format":"double","type":"number"},"Units":{"description":"Units","type":"string"}},"type":"object"},"PurchaseOrderRequest":{"properties":{"Data":{"items":{"$ref":"#/definitions/PurchaseOrder"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"required":["Meta","Data"],"type":"object"},"PurchaseOrderResponse":{"description":"An array of Purchase Order objects","properties":{"Data":{"items":{"$ref":"#/definitions/PurchaseOrder"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"PutResponse":{"properties":{"Data":{"items":{"$ref":"#/definitions/Message"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Quote":{"properties":{"AccountID":{"description":"Account ID","type":"string"},"AdditionalAddress":{"$ref":"#/definitions/Address"},"AdditionalName":{"description":"Additional To Name","type":"string"},"BillingAddress":{"$ref":"#/definitions/Address"},"BillingContactID":{"description":"Billing Contact ID","type":"string"},"BillingName":{"description":"Bill To Name","type":"string"},"BusinessAddress":{"$ref":"#/definitions/Address"},"CannabisTax":{"description":"Cannabis Tax","format":"double","type":"number"},"ContactID":{"description":"Contact ID","type":"string"},"ContractID":{"description":"Contract ID","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"CreditTerms":{"description":"Credit Terms","type":"string"},"CustomerID":{"description":"OEM Customer Identifier","type":"string"},"Date":{"description":"Quote Date","type":"string"},"Description":{"description":"Description","type":"string"},"Discount":{"description":"Discount Percentage","format":"double","type":"number"},"DiscountAmount":{"description":"Discount Amount","format":"double","type":"number"},"Email":{"description":"Email","type":"string"},"EndUserID":{"description":"End User Contact ID","type":"string"},"EstimatedAmount":{"description":"Invoice Total from source system","format":"double","type":"number"},"EstimatedBusinessTax":{"description":"Business tax from source system","format":"double","type":"number"},"EstimatedCannabisTax":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedCogs":{"description":"Cost of Goods Sold from source system","format":"double","type":"number"},"EstimatedDiscount":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedSalesTax":{"description":"Sales Tax from source system","format":"double","type":"number"},"EstimatedSubtotal":{"description":"Invoice Subtotal from source system","format":"double","type":"number"},"ExpirationDate":{"description":"Expiration Date","type":"string"},"Fax":{"description":"Fax","type":"string"},"GrandTotal":{"description":"Grand Total","format":"double","type":"number"},"ID":{"description":"Taxnexus Record Id","type":"string"},"IngestID":{"description":"ID of the Ingest which created this Invoice","type":"string"},"InstallationDate":{"description":"Installation Date","type":"string"},"IsSyncing":{"description":"Syncing","type":"boolean"},"Items":{"items":{"$ref":"#/definitions/QuoteItem"},"type":"array"},"JobID":{"description":"ID of the Job which created this Invoice","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LineItemCount":{"description":"Line Items","format":"int64","type":"number"},"MonthlyAmount":{"description":"Monthly Amount quoted","format":"double","type":"number"},"Name":{"description":"Quote Name","type":"string"},"OpportunityID":{"description":"Opportunity Name","type":"string"},"OwnerID":{"description":"Owner Name","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PaymentTerms":{"description":"Payment Terms","type":"string"},"Phone":{"description":"Phone","type":"string"},"PurchaseAmount":{"description":"Purchase Amount","format":"double","type":"number"},"QuoteAmount":{"description":"Quote Amount","format":"double","type":"number"},"QuoteNumber":{"description":"Quote Number","type":"string"},"QuoteToAddress":{"$ref":"#/definitions/Address"},"QuoteToName":{"description":"Quote To Name","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","type":"string"},"ServiceTerm":{"description":"Service Term","type":"string"},"ShippingAddress":{"$ref":"#/definitions/Address"},"ShippingContactID":{"description":"Shipping Contact ID","type":"string"},"ShippingHandling":{"description":"Shipping and Handling","format":"double","type":"number"},"ShippingName":{"description":"Ship To Name","type":"string"},"Status":{"description":"Status","type":"string"},"Subtotal":{"description":"Subtotal","type":"number"},"Tax":{"description":"Tax","format":"double","type":"number"},"TaxTransactions":{"description":"The taxes associated with this Quote","items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"TelecomTax":{"description":"Telecom Tax","format":"double","type":"number"},"TemplateID":{"description":"Template","type":"string"},"Total":{"$ref":"#/definitions/Total"},"TotalPrice":{"description":"Total Price","format":"double","type":"number"},"Type":{"description":"Quote Type","type":"string"}},"type":"object"},"QuoteBasic":{"properties":{"AccountID":{"description":"Account Identifier from Source System; ignored in tax calculations","type":"string"},"Amount":{"description":"Invoice Amount; ignored in tax calculation","type":"number"},"BusinessAddress":{"$ref":"#/definitions/Address"},"CustomerID":{"description":"OEM Customer Identifier","type":"string"},"EstimatedAmount":{"description":"Invoice Total from source system","format":"double","type":"number"},"EstimatedBusinessTax":{"description":"Business tax from source system","format":"double","type":"number"},"EstimatedCannabisTax":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedCogs":{"description":"Cost of Goods Sold from source system","format":"double","type":"number"},"EstimatedDiscount":{"description":"Cannabis Tax from source system","format":"double","type":"number"},"EstimatedSalesTax":{"description":"Sales Tax from source system","format":"double","type":"number"},"EstimatedSubtotal":{"description":"Invoice Subtotal from source system","format":"double","type":"number"},"ID":{"description":"Taxnexus ID","type":"string"},"IngestID":{"description":"ID of the Ingest which created this Invoice","type":"string"},"Items":{"description":"The items associated with this Invoice","items":{"$ref":"#/definitions/ItemBasic"},"type":"array"},"JobID":{"description":"ID of the Job which created this Invoice","type":"string"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PeriodID":{"description":"Taxnexus Period ID","type":"string"},"QuoteDate":{"description":"Invoice Date; should be date only or correct time zone if in time notation","type":"string"},"QuoteNumber":{"description":"Source System Customer-Facing Invoice Number; ignored in tax calculation","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","enum":["AdultUse","Caregiver","Consumer","Medicinal","MedicinalState","MedicinalThirdParty","Merchandise","Patient","Telecom"],"type":"string"},"ShippingHandling":{"description":"Shipping and Handling fees for this document","type":"number"},"Status":{"description":"Status used by for Billing Balances; ignored in tax calculation","enum":["closed","delivered","hold","issued","new","posted","rated","rating_failed","rating_ready","reissued","rendered","uncollectable","voided"],"type":"string"},"Subtotal":{"description":"Subtotal of items","type":"number"},"TaxTransactions":{"description":"The Tax Transactions \"Source System identifier for this record, if any; copied to quoteitemid in Tax Transaction result records\"","items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"Total":{"$ref":"#/definitions/Total"},"Type":{"description":"Invoice Type","type":"string"}},"required":["AccountID","Items","QuoteNumber","QuoteDate","SalesRegulation"]},"QuoteItem":{"properties":{"AccountID":{"description":"Account ID","type":"string"},"COGS":{"description":"Cost of Goods Sold","format":"double","type":"number"},"ContractID":{"description":"Contract Number","type":"string"},"CoordinateID":{"description":"The ID of the Coordinate used to rate this item","type":"string"},"CountyID":{"description":"County","type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"CustomerID":{"description":"Reseller or OEM customer identifier","type":"string"},"Description":{"description":"Line Item Description","type":"string"},"Discount":{"description":"Discount Percentage","format":"double","type":"number"},"DiscountAmount":{"description":"Discount Amount","format":"double","type":"number"},"ID":{"description":"Taxnexus Record Id","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"LineGrossAmount":{"description":"Line Gross Amount","format":"double","type":"number"},"LineNumber":{"description":"Line Item Number","type":"string"},"ListPrice":{"description":"List Price","type":"number"},"LocationID":{"description":"Location","type":"string"},"MRCInterval":{"description":"Quantity","format":"int64","type":"number"},"ParentFK":{"description":"UUID Reference the master record that owns this item","type":"string"},"PlaceGeocode":{"description":"Taxnexus Geocode of where this invoice item was rated","type":"string"},"ProductCode":{"description":"Product Code","type":"string"},"ProductID":{"description":"Product ID","type":"string"},"ProductName":{"description":"Product Name","type":"string"},"Quantity":{"description":"Quantity","format":"double","type":"number"},"QuoteID":{"description":"Quote Name","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"SalesRegulation":{"description":"Sales Regulation Type","type":"string"},"ServiceDate":{"description":"Date","type":"string"},"ShippingHandling":{"description":"Shipping \u0026 Handling","format":"double","type":"number"},"Subtotal":{"description":"Subtotal","format":"double","type":"number"},"SupplierID":{"description":"Supplier","type":"string"},"TaxnexusCode":{"description":"Taxnexus Code","type":"string"},"TotalPrice":{"description":"Total Price","format":"double","type":"number"},"UnitPrice":{"description":"Sales Price","format":"double","type":"number"},"Units":{"description":"The Unit of Measure for this item","type":"string"}},"type":"object"},"QuoteRequest":{"description":"An array of Quote objects","properties":{"Data":{"items":{"$ref":"#/definitions/QuoteBasic"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"required":["Meta","Data"],"type":"object"},"QuoteResponse":{"description":"An array of Quote objects","properties":{"Data":{"items":{"$ref":"#/definitions/Quote"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"RequestMeta":{"properties":{"TaxnexusAccount":{"description":"Taxnexus Account Number of the Reseller or OEM","type":"string"}},"required":["TaxnexusAccount"],"type":"object"},"ResponseMeta":{"properties":{"Contact":{"description":"Microservice Contact Info","type":"string"},"Copyright":{"description":"Copyright Info","type":"string"},"License":{"description":"License Information and Restrictions","type":"string"},"OperationID":{"description":"Operation ID","type":"string"},"Pagination":{"$ref":"#/definitions/Pagination"},"RequestIP":{"description":"Request IP Address","type":"string"},"RequestType":{"description":"Request Type","type":"string"},"RequestURL":{"description":"Request URL","type":"string"},"ServerInfo":{"description":"Data Server Info","type":"string"},"ServerResponseTime":{"description":"Data Server Response Time (ms)","type":"string"},"ServerTimestamp":{"description":"Backend Server Timestamp","type":"string"},"TaxnexusAccount":{"description":"Taxnexus Account Number used for recording transactions","type":"string"}},"type":"object"},"Subscription":{"properties":{"AccountID":{"description":"Account ID","type":"string"},"ActivatedDate":{"description":"Activated Date","type":"string"},"ActivatedUserID":{"description":"Activated By","type":"string"},"Amount":{"description":"Amount","format":"double","type":"number"},"AssetID":{"description":"Asset Name","type":"string"},"CancelDate":{"description":"Cancel Date","type":"string"},"ContractID":{"type":"string"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"Description":{"description":"Description","type":"string"},"EffectiveDate":{"description":"Effective Date","type":"string"},"Email":{"description":"Email","type":"string"},"EndUserID":{"description":"End User Contact ID","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"IsActive":{"description":"Active?","type":"boolean"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"OrderDate":{"description":"Order Date","type":"string"},"OrderItemID":{"description":"Order Item","type":"string"},"Password":{"description":"Password","type":"string"},"PaymentTerms":{"description":"Payment Terms","type":"string"},"PriceBookID":{"description":"Price Book","type":"string"},"ProductCode":{"description":"Product Code","type":"string"},"ProductID":{"type":"string"},"ProductName":{"description":"Product Name","type":"string"},"Quantity":{"description":"Quantity","type":"string"},"QuoteItemID":{"description":"Quote Item","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"Status":{"description":"Status","type":"string"},"Type":{"description":"Type","type":"string"},"UnitPrice":{"description":"Unit Price","format":"double","type":"number"},"Units":{"description":"Units","type":"string"},"Unlimited":{"description":"Unlimited usage?","type":"boolean"},"Username":{"description":"Username","type":"string"}},"type":"object"},"SubscriptionRequest":{"properties":{"Data":{"items":{"$ref":"#/definitions/Subscription"},"type":"array"},"Meta":{"$ref":"#/definitions/RequestMeta"}},"required":["Meta","Data"],"type":"object"},"SubscriptionResponse":{"description":"An array of Subscription Objects","properties":{"Data":{"items":{"$ref":"#/definitions/Subscription"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"TaxTransaction":{"properties":{"AccountID":{"description":"Account ID","type":"string"},"AccountingRuleCode":{"description":"Accounting Rule code","type":"string"},"Amount":{"description":"Total Amount Due (same as Tax)","format":"double","type":"number"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"CustomerID":{"description":"Customer ID","type":"string"},"DisplayName":{"description":"Tax or Fee Name","type":"string"},"EffectiveRate":{"description":"Effective Rate","format":"double","type":"number"},"FilingID":{"description":"Filing ID","type":"string"},"ID":{"description":"Taxnexus Record Id","type":"string"},"IngestID":{"description":"Ingest ID","type":"string"},"InvoiceID":{"description":"Invoice ID","type":"string"},"InvoiceItemID":{"description":"Invoiceitem ID","type":"string"},"IsSummary":{"description":"Is this a summary record?","type":"boolean"},"JobID":{"description":"Job ID","type":"string"},"JournalItemID":{"description":"Journal Item ID","type":"string"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"OrderID":{"description":"Order ID","type":"string"},"OrderItemID":{"description":"Order Item ID","type":"string"},"POID":{"description":"PO ID","type":"string"},"POItemID":{"description":"PO Item ID","type":"string"},"ParentRef":{"description":"Parent Ref copied from source","type":"string"},"PercentTaxable":{"description":"Percent Taxable","format":"double","type":"number"},"PeriodID":{"description":"Period ID","type":"string"},"PlaceGeocode":{"description":"The Taxnexus Geocode of the Place used for Situs","type":"string"},"PlaceID":{"description":"Place ID","type":"string"},"Posted":{"description":"Posted to external system?","type":"boolean"},"QuoteID":{"description":"Order ID","type":"string"},"QuoteItemID":{"description":"Order Item ID","type":"string"},"RatingType":{"description":"The Type of Object that was rated","type":"string"},"Ref":{"description":"Source System identifier for this record, if any","type":"string"},"RevenueBase":{"description":"The Revenue Amount that was taxed before any adjustments","format":"double","type":"number"},"RevenueNet":{"description":"The Revenue Amount that was taxed after any adjustments","format":"double","type":"number"},"RevenueNotTaxable":{"description":"The Revenue Amount that was not taxed","format":"double","type":"number"},"TaxExemptRevenue":{"description":"Tax Exempt Revenue","format":"double","type":"number"},"TaxOnTax":{"description":"Additional Tax calculated due to regulatory requirements","format":"double","type":"number"},"TaxRate":{"description":"The Tax Rate used for calculation","format":"double","type":"number"},"TaxTypeAccountID":{"description":"TaxType Account ID","type":"string"},"TaxTypeID":{"description":"TaxType ID","type":"string"},"TaxnexusCodeDisplay":{"description":"The Taxnexus Code for the Tax Type","type":"string"},"TaxnexusCodeID":{"description":"Taxnexus Code ID","type":"string"},"UnitBase":{"description":"Unit Base","format":"double","type":"number"},"UnitFeeRate":{"description":"Unit Fee Rate","format":"double","type":"number"}},"type":"object"},"TaxTransactionResponse":{"description":"An array of Tax Transaction Objects","properties":{"Data":{"items":{"$ref":"#/definitions/TaxTransaction"},"type":"array"},"Meta":{"$ref":"#/definitions/ResponseMeta"}},"type":"object"},"Total":{"properties":{"Amount":{"description":"The total amount for this object","format":"double","type":"number"},"BusinessTax":{"description":"The amount of Deferred Tax incurred with this invoice","format":"double","type":"number"},"BusinessTaxRate":{"description":"The Percentage of Deffered Tax from the Total","format":"double","type":"number"},"CannabisTax":{"description":"The total amount of Cannabis Tax charged on this object","format":"double","type":"number"},"CannabisTaxRate":{"description":"The percentage of Cannabis Tax from the Total","format":"double","type":"number"},"CreatedByID":{"description":"Created By User ID","type":"string"},"CreatedDate":{"description":"Created Date","type":"string"},"ID":{"description":"Unique Taxnexus ID","type":"string"},"Items":{"items":{"$ref":"#/definitions/TotalItem"},"type":"array"},"LastModifiedByID":{"description":"Last Modified By User ID","type":"string"},"LastModifiedDate":{"description":"Last Modified Date","type":"string"},"MonthlyAmount":{"description":"The monthly, pre-tax estimate of quoted and ordered periodic services","format":"double","type":"number"},"ObjectType":{"description":"The type of Object for which this Total has been constructed","type":"string"},"PurchaseAmount":{"format":"double","type":"number"},"SalesTax":{"description":"The amount of Sales Tax charged on this object","format":"double","type":"number"},"SalesTaxRate":{"description":"The percentage of Sales Tax from the Total","format":"double","type":"number"},"ShippingHandling":{"description":"The shipping and delivery charges charged on this object","format":"double","type":"number"},"Subtotal":{"description":"The sum of all the items on the object prior to tax rating and shipping \u0026 handling","format":"double","type":"number"},"TelecomTax":{"description":"The amount of Telecom Tax charged on this invoice","format":"double","type":"number"},"TelecomTaxRate":{"description":"The percentage of Telecom Tax from the Total","format":"double","type":"number"}},"type":"object"},"TotalItem":{"description":"Tabulates Tax Transactions on this object","properties":{"Amount":{"description":"The amount of this total item","format":"double","type":"number"},"Count":{"description":"The number of taxtransactions totaled","format":"int64","type":"number"},"DisplayName":{"description":"Total Item description to be used in bill presentment","type":"string"},"ID":{"description":"Unique Taxnexus ID","type":"string"},"TaxItems":{"items":{"$ref":"#/definitions/TotalTaxItem"},"type":"array"}},"type":"object"},"TotalTaxItem":{"description":"Links the tax items totals in the TotalItem struct","properties":{"ID":{"type":"string"},"TaxTransactionID":{"type":"string"},"TotalItemID":{"type":"string"}},"type":"object"}},"host":"ops.fabric.tnxs.net:8080","info":{"contact":{"email":"noc@taxnexus.net"},"description":"Taxnexus Finance Microservice","license":{"name":"Proprietary - Copyright (c) 2018-2020 by Taxnexus, Inc."},"termsOfService":"http://taxnexus.net/terms/","title":"ops","version":"1.2.6"},"parameters":{"X-API-Key":{"in":"header","name":"X-API-Key","required":true,"type":"string"},"accountIdQuery":{"description":"Taxnexus Record Id of an Account","in":"query","name":"accountId","required":false,"type":"string"},"accountIdQueryRequired":{"description":"Taxnexus Record Id of an Account","in":"query","name":"accountId","required":true,"type":"string"},"accountNumberQuery":{"description":"The Taxnexus Account Number of the Account to be used a record retrieval","in":"query","name":"accountnumber","required":false,"type":"string"},"cashreceiptIdQuery":{"description":"Taxnexus Record Id of a Cash Receipt","in":"query","name":"cashreceiptId","required":false,"type":"string"},"chargeIdQuery":{"description":"Taxnexus Record Id of a Charge","in":"query","name":"chargeId","required":false,"type":"string"},"companyIdQuery":{"description":"Taxnexus Record Id of a Company","in":"query","name":"companyId","required":false,"type":"string"},"dateFromQuery":{"description":"The Starting Date for an object retrieval","in":"query","name":"dateFrom","required":false,"type":"string"},"dateToQuery":{"description":"The Ending Date for an object retrieval","in":"query","name":"dateTo","required":false,"type":"string"},"idQueryRequired":{"description":"Taxnexus Id of the record to be retrieved","in":"query","name":"id","required":false,"type":"string"},"invoiceIdQuery":{"description":"Taxnexus Record Id of an Invoice","in":"query","name":"invoiceId","required":false,"type":"string"},"limitQuery":{"description":"How many objects to return at one time (max 300, default 100)","format":"int64","in":"query","name":"limit","required":false,"type":"integer"},"nameQuery":{"description":"The Name of this Object","in":"query","name":"name","required":false,"type":"string"},"offsetQuery":{"description":"How many objects to skip? (default 0)","format":"int64","in":"query","name":"offset","required":false,"type":"integer"},"orderIdQuery":{"description":"Taxnexus Record Id of an Order","in":"query","name":"orderId","required":false,"type":"string"},"orderRequestBody":{"description":"A request with an array of Order Objects","in":"body","name":"orderRequest","required":true,"schema":{"$ref":"#/definitions/OrderRequest"}},"productIdQuery":{"description":"Taxnexus Record Id of a Product","in":"query","name":"productId","required":false,"type":"string"},"productRequestBody":{"description":"A request with an array of Product Objects","in":"body","name":"productRequest","required":true,"schema":{"$ref":"#/definitions/ProductRequest"}},"productdQuery":{"description":"Taxnexus Id of the Product to be retrieved","in":"query","name":"id","required":false,"type":"string"},"purchaseOrderRequest":{"description":"A request with an array of Purchase Order Objects","in":"body","name":"poRequest","required":true,"schema":{"$ref":"#/definitions/PurchaseOrderRequest"}},"quoteIdQuery":{"description":"Taxnexus Record Id of a Quote","in":"query","name":"quoteId","required":false,"type":"string"},"quoteRequest":{"description":"A request with an array of Quote Objects","in":"body","name":"quoteRequest","required":true,"schema":{"$ref":"#/definitions/QuoteRequest"}},"subscriptionIdQuery":{"description":"Taxnexus Id of the Subscription to be retrieved","in":"query","name":"subscriptionId","required":false,"type":"string"},"subscriptionRequestBody":{"description":"A request with an array of Subscription Objects","in":"body","name":"subscriptionRequest","required":true,"schema":{"$ref":"#/definitions/SubscriptionRequest"}}},"paths":{"/cashreceipts":{"delete":{"description":"Delete cash receipt by ID","operationId":"deleteCashReceipt","parameters":[{"$ref":"#/parameters/idQueryRequired"}],"responses":{"200":{"$ref":"#/responses/DeleteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete a cash receipt","tags":["CashReceipt"]},"get":{"description":"Return a list of available Taxnexus Cash Receipts","operationId":"getCashReceipts","parameters":[{"$ref":"#/parameters/limitQuery"},{"$ref":"#/parameters/offsetQuery"},{"$ref":"#/parameters/accountIdQuery"},{"$ref":"#/parameters/companyIdQuery"},{"$ref":"#/parameters/cashreceiptIdQuery"}],"responses":{"200":{"$ref":"#/responses/CashReceiptResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Get a list of Cash Receipts","tags":["CashReceipt"]},"options":{"description":"CORS support","operationId":"cashReceiptOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"consumes":["application/json"],"description":"Create New Cash Receipts","operationId":"postCashReceipts","parameters":[{"in":"body","name":"cashReceiptRequest","schema":{"$ref":"#/definitions/CashReceiptRequest"}}],"responses":{"200":{"$ref":"#/responses/PostResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Create new Cash Receipts","tags":["CashReceipt"]},"put":{"consumes":["application/json"],"description":"Put a list of Cash Receipts","operationId":"putCashReceipts","parameters":[{"in":"body","name":"cashreceiptRequest","schema":{"$ref":"#/definitions/InvoiceRequest"}}],"responses":{"200":{"$ref":"#/responses/PutResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Put a list of Cash Receipts","tags":["CashReceipt"]}},"/charges":{"delete":{"description":"Delete a Charge by ID","operationId":"deleteCharge","parameters":[{"$ref":"#/parameters/idQueryRequired"}],"responses":{"200":{"$ref":"#/responses/DeleteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete a Charge","tags":["Charge"]},"get":{"description":"Return a list of available Taxnexus Charges","operationId":"getCharges","parameters":[{"$ref":"#/parameters/limitQuery"},{"$ref":"#/parameters/offsetQuery"},{"$ref":"#/parameters/accountIdQuery"},{"$ref":"#/parameters/companyIdQuery"},{"$ref":"#/parameters/chargeIdQuery"}],"responses":{"200":{"$ref":"#/responses/ChargeResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Get a list of Charges","tags":["Charge"]},"options":{"description":"CORS support","operationId":"chargeOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"consumes":["application/json"],"description":"Create New Charges","operationId":"postCharges","parameters":[{"in":"body","name":"chargeRequest","schema":{"$ref":"#/definitions/ChargeRequest"}}],"responses":{"200":{"$ref":"#/responses/PostResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Create new Charges","tags":["Charge"]},"put":{"consumes":["application/json"],"description":"Put a list of Charges","operationId":"putCharges","parameters":[{"in":"body","name":"chargeRequest","schema":{"$ref":"#/definitions/ChargeRequest"}}],"responses":{"200":{"$ref":"#/responses/PutResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Put a list of Charges","tags":["Charge"]}},"/invoices":{"delete":{"description":"Delete an invoice by ID","operationId":"deleteInvoice","parameters":[{"$ref":"#/parameters/idQueryRequired"}],"responses":{"200":{"$ref":"#/responses/DeleteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete an invoice","tags":["Invoice"]},"get":{"description":"Return a list of available Taxnexus Invoices","operationId":"getInvoices","parameters":[{"$ref":"#/parameters/limitQuery"},{"$ref":"#/parameters/offsetQuery"},{"$ref":"#/parameters/accountIdQuery"},{"$ref":"#/parameters/invoiceIdQuery"}],"responses":{"200":{"$ref":"#/responses/InvoiceResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Get a list of Invoices","tags":["Invoice"]},"options":{"description":"CORS support","operationId":"invoiceOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"consumes":["application/json"],"description":"Create New Invoices","operationId":"postInvoices","parameters":[{"in":"body","name":"invoiceRequest","schema":{"$ref":"#/definitions/InvoiceRequest"}}],"responses":{"200":{"$ref":"#/responses/InvoiceResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Create a new Invoice","tags":["Invoice"]},"put":{"consumes":["application/json"],"description":"Put a list of Invoices","operationId":"putInvoices","parameters":[{"in":"body","name":"invoiceRequest","schema":{"$ref":"#/definitions/InvoiceRequest"}}],"responses":{"200":{"$ref":"#/responses/PutResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Put a list of Invoices","tags":["Invoice"]}},"/orders":{"delete":{"description":"Delete an order by ID","operationId":"deleteOrder","parameters":[{"$ref":"#/parameters/idQueryRequired"}],"responses":{"200":{"$ref":"#/responses/DeleteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete an Order","tags":["Order"]},"get":{"description":"Return a list of Orders","operationId":"getOrders","parameters":[{"$ref":"#/parameters/limitQuery"},{"$ref":"#/parameters/offsetQuery"},{"$ref":"#/parameters/accountIdQuery"},{"$ref":"#/parameters/accountNumberQuery"},{"$ref":"#/parameters/companyIdQuery"},{"$ref":"#/parameters/orderIdQuery"}],"responses":{"200":{"$ref":"#/responses/OrderResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Get a list of Orders","tags":["Order"]},"options":{"description":"CORS support","operationId":"ordersOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"consumes":["application/json"],"description":"Create new Orders","operationId":"postOrders","parameters":[{"in":"body","name":"order","schema":{"$ref":"#/definitions/OrderRequest"}}],"responses":{"200":{"$ref":"#/responses/PostResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Create new Orders","tags":["Order"]},"put":{"consumes":["application/json"],"description":"Create new Orders","operationId":"putOrders","parameters":[{"in":"body","name":"order","schema":{"$ref":"#/definitions/Order"}}],"responses":{"200":{"$ref":"#/responses/PutResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Create new Orders","tags":["Order"]}},"/pos":{"delete":{"description":"Delete a PO by ID","operationId":"deletePo","parameters":[{"$ref":"#/parameters/idQueryRequired"}],"responses":{"200":{"$ref":"#/responses/DeleteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete a PO","tags":["PurchaseOrder"]},"get":{"description":"Return a list of available Purchase Orders","operationId":"getPos","parameters":[{"$ref":"#/parameters/limitQuery"},{"$ref":"#/parameters/offsetQuery"},{"$ref":"#/parameters/accountIdQuery"},{"$ref":"#/parameters/companyIdQuery"},{"$ref":"#/parameters/invoiceIdQuery"}],"responses":{"200":{"$ref":"#/responses/PurchaseOrderResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Get a list of Purchase Orders","tags":["PurchaseOrder"]},"options":{"description":"CORS support","operationId":"poOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"consumes":["application/json"],"description":"Create New Purchase Order","operationId":"postPos","parameters":[{"in":"body","name":"poRequest","schema":{"$ref":"#/definitions/PurchaseOrderRequest"}}],"responses":{"200":{"$ref":"#/responses/PurchaseOrderResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Create a new Purchase Order","tags":["PurchaseOrder"]},"put":{"consumes":["application/json"],"description":"Upsert a list of Purchase Order","operationId":"putPos","parameters":[{"in":"body","name":"poRequest","schema":{"$ref":"#/definitions/PurchaseOrderRequest"}}],"responses":{"200":{"$ref":"#/responses/PutResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Upsert a list of Purchase Order","tags":["PurchaseOrder"]}},"/products":{"delete":{"description":"Delete Taxnexus Product record","operationId":"deleteProduct","parameters":[{"$ref":"#/parameters/productIdQuery"}],"responses":{"200":{"$ref":"#/responses/ProductResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete a Product","tags":["Product"]},"get":{"description":"Return a list of all available Products","operationId":"getProducts","parameters":[{"$ref":"#/parameters/limitQuery"},{"$ref":"#/parameters/offsetQuery"},{"$ref":"#/parameters/accountIdQuery"},{"$ref":"#/parameters/companyIdQuery"},{"$ref":"#/parameters/productIdQuery"},{"$ref":"#/parameters/nameQuery"}],"responses":{"200":{"$ref":"#/responses/ProductResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Get a list of Products","tags":["Product"]},"options":{"description":"CORS support","operationId":"productOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Product records to be added","operationId":"postProducts","parameters":[{"$ref":"#/parameters/productRequestBody"}],"responses":{"200":{"$ref":"#/responses/ProductResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Add new Products","tags":["Product"]},"put":{"description":"Update Product records","operationId":"putProducts","parameters":[{"$ref":"#/parameters/productRequestBody"}],"responses":{"200":{"$ref":"#/responses/PutResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Update Products","tags":["Product"]}},"/quotes":{"delete":{"description":"Delete quote by ID","operationId":"deleteQuote","parameters":[{"$ref":"#/parameters/idQueryRequired"}],"responses":{"200":{"$ref":"#/responses/DeleteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Delete a quote","tags":["Quote"]},"get":{"description":"Return a list of available quotes","operationId":"getQuotes","parameters":[{"$ref":"#/parameters/limitQuery"},{"$ref":"#/parameters/offsetQuery"},{"$ref":"#/parameters/accountIdQuery"},{"$ref":"#/parameters/quoteIdQuery"}],"responses":{"200":{"$ref":"#/responses/QuoteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Get a list of Invoices","tags":["Quote"]},"options":{"description":"CORS support","operationId":"quoteOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"consumes":["application/json"],"description":"Create New Quotes","operationId":"postQuotes","parameters":[{"in":"body","name":"quoteRequest","schema":{"$ref":"#/definitions/QuoteRequest"}}],"responses":{"200":{"$ref":"#/responses/QuoteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Create a new Quotes","tags":["Quote"]},"put":{"consumes":["application/json"],"description":"Put a list of Quotes","operationId":"putQuotes","parameters":[{"in":"body","name":"quoteRequest","schema":{"$ref":"#/definitions/QuoteRequest"}}],"responses":{"200":{"$ref":"#/responses/QuoteResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Put a list of Quotes","tags":["Quote"]}},"/taxes/invoices":{"options":{"description":"CORS support","operationId":"taxInvoiceOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Rate a list of invoices","operationId":"postTaxesInvoices","parameters":[{"in":"body","name":"invoiceRequest","schema":{"$ref":"#/definitions/InvoiceRequest"}}],"responses":{"200":{"$ref":"#/responses/TaxTransactionResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Rate a list of invoices","tags":["Tax"]}},"/taxes/orders":{"options":{"description":"CORS support","operationId":"taxOrderOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Rate a list of invoices","operationId":"postTaxesOrders","parameters":[{"$ref":"#/parameters/orderRequestBody"}],"responses":{"200":{"$ref":"#/responses/TaxTransactionResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Rate a list of orders","tags":["Tax"]}},"/taxes/pos":{"options":{"description":"CORS support","operationId":"taxPoOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Rate a list of purchase orders","operationId":"postTaxesPos","parameters":[{"$ref":"#/parameters/purchaseOrderRequest"}],"responses":{"200":{"$ref":"#/responses/TaxTransactionResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Rate a list of purchase orders","tags":["Tax"]}},"/taxes/quotes":{"options":{"description":"CORS support","operationId":"taxQuoteOptions","responses":{"200":{"$ref":"#/responses/CORSResponse"}},"tags":["cors"]},"post":{"description":"Rate a list of quotes","operationId":"postTaxesQuotes","parameters":[{"$ref":"#/parameters/quoteRequest"}],"responses":{"200":{"$ref":"#/responses/TaxTransactionResponse"},"401":{"$ref":"#/responses/Unauthorized"},"403":{"$ref":"#/responses/AccessForbidden"},"404":{"$ref":"#/responses/NotFound"},"422":{"$ref":"#/responses/UnprocessableEntity"},"500":{"$ref":"#/responses/ServerError"}},"security":[{"ApiKeyAuth":[]}],"summary":"Rate a list of quotes","tags":["Tax"]}}},"produces":["application/json"],"responses":{"AccessForbidden":{"description":"Access forbidden, account lacks access","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"CORSResponse":{"description":"CORS OPTIONS response","headers":{"Access-Control-Allow-Credentials":{"type":"string"},"Access-Control-Allow-Headers":{"type":"string"},"Access-Control-Allow-Methods":{"type":"string"},"Access-Control-Allow-Origin":{"type":"string"},"Access-Control-Expose-Headers":{"type":"string"},"Access-Control-Max-Age":{"type":"string"},"Cache-Control":{"type":"string"}}},"CashReceiptResponse":{"description":"Taxnexus Response with Cash Receipt objects","headers":{"Access-Control-Allow-Origin":{"type":"string"},"Cache-Control":{"type":"string"}},"schema":{"$ref":"#/definitions/CashReceiptResponse"}},"ChargeResponse":{"description":"Taxnexus Response with Charge objects","headers":{"Access-Control-Allow-Origin":{"type":"string"},"Cache-Control":{"type":"string"}},"schema":{"$ref":"#/definitions/ChargeResponse"}},"Conflict":{"description":"Conflict","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"DeleteResponse":{"description":"Taxnexus Response with Message Objects with Delete Status","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/DeleteResponse"}},"InvalidDataError":{"description":"Invalid data was sent","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/InvalidError"}},"InvoiceResponse":{"description":"Taxnexus Response with an array of Invoice (full) objects","headers":{"Access-Control-Allow-Origin":{"type":"string"},"Cache-Control":{"type":"string"}},"schema":{"$ref":"#/definitions/InvoiceResponse"}},"NotFound":{"description":"Resource was not found","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"OrderResponse":{"description":"Taxnexus Response with an array of Order objects","headers":{"Access-Control-Allow-Origin":{"type":"string"},"Cache-Control":{"type":"string"}},"schema":{"$ref":"#/definitions/OrderResponse"}},"PostResponse":{"description":"Taxnexus Response with an array of Message objects in response to a POST -\u003e [\"ref\", \"id\"]","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/PostResponse"}},"ProductResponse":{"description":"Taxnexus Response with an array of Product objects","headers":{"Access-Control-Allow-Origin":{"type":"string"},"Cache-Control":{"type":"string"}},"schema":{"$ref":"#/definitions/ProductResponse"}},"PurchaseOrderResponse":{"description":"Taxnexus Response with an array of Purchase Order objects","headers":{"Access-Control-Allow-Origin":{"type":"string"},"Cache-Control":{"type":"string"}},"schema":{"$ref":"#/definitions/PurchaseOrderResponse"}},"PutResponse":{"description":"Taxnexus Response with an array of Message objects in response to a PUT","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/PutResponse"}},"QuoteResponse":{"description":"Taxnexus Response with an array of Quote objects","headers":{"Access-Control-Allow-Origin":{"type":"string"},"Cache-Control":{"type":"string"}},"schema":{"$ref":"#/definitions/QuoteResponse"}},"ServerError":{"description":"Server Internal Error","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"SubscriptionResponse":{"description":"Taxnexus Response with an array of Subscription Objects","schema":{"$ref":"#/definitions/SubscriptionResponse"}},"TaxTransactionResponse":{"description":"Taxnexus Response with Tax Transaction Objects","headers":{"Access-Control-Allow-Origin":{"type":"string"},"Cache-Control":{"type":"string"}},"schema":{"$ref":"#/definitions/TaxTransactionResponse"}},"Unauthorized":{"description":"Access unauthorized, invalid API-KEY was used","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}},"UnprocessableEntity":{"description":"Unprocessable Entity, likely a bad parameter","headers":{"Access-Control-Allow-Origin":{"type":"string"}},"schema":{"$ref":"#/definitions/Error"}}},"schemes":["http"],"securityDefinitions":{"ApiKeyAuth":{"in":"header","name":"X-API-Key","type":"apiKey"}},"swagger":"2.0"}
