Net3 API Interface for Customer Portal

<back to all web services

BillingSyncQB

Requires Authentication
The following routes are available for this service:
POST/billing/quickbooks/syncItemMappingsSyncronize Quickbooks GLCodes and items with the Onbaording mapping layer
BillingSyncQB Parameters:
NameParameterData TypeRequiredDescription
itemsQbbodyList<TypeBillingItemQB>No
environmentbodyN3TEnvironmentNo

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
TypeBillingItemQB Parameters:
NameParameterData TypeRequiredDescription
CompanyFileformCompanyFileNo
FullNameformstringNo
ListIdformstringNo
GLCodeformstringNo
TypeformItemTypeNo
NameformstringNo
IsPOCformboolNo
DescriptionformstringNo
CostByMonthformList<TypeBillingItemQBMonth>No
ProductDescriptionsformList<TypeBillingItemQBProdDesc>No
TypeBillingItemQBBase Parameters:
NameParameterData TypeRequiredDescription
ContractedTotalformdecimalNo
FeesTotalformdecimalNo
OveragesTotalformdecimalNo
SupportCostTotalformdecimalNo
TotalformdecimalNo
ContractedCostsTotalformdecimalNo
FeesCostsTotalformdecimalNo
OveragesCostsTotalformdecimalNo
SupportCostCostsTotalformdecimalNo
CostsTotalformdecimalNo
ContractedCreditsTotalformdecimalNo
FeesCreditsTotalformdecimalNo
OveragesCreditsTotalformdecimalNo
SupportCostCreditsTotalformdecimalNo
CreditsTotalformdecimalNo
CompanyFile Enum:
NameValue
V11
V22
Test3
ItemType Enum:
NameValue
IItemDiscountRet1
IItemFixedAssetRet2
IItemGroupRet3
IItemInventoryAssemblyRet4
IItemInventoryRet5
IItemNonInventoryRet6
IItemOtherChargeRet7
IItemPaymentRet8
IItemSalesTaxGroupRet9
IItemSalesTaxRet10
IItemServiceRet11
IItemSubtotalRet12
TypeBillingItemQBMonth Parameters:
NameParameterData TypeRequiredDescription
MonthformDateTimeNo
ProductDescriptionsformList<TypeBillingItemQBProdDesc>No
TypeBillingItemQBProdDesc Parameters:
NameParameterData TypeRequiredDescription
TypeformBillTypeNo
ProductIdformintNo
ServiceIdformintNo
UnitformstringNo
PrecedenceformintNo
QuantityformdecimalNo
DescriptionformstringNo
SupportCostformdecimalNo
BillType Enum:
Contracted
Overage
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /billing/quickbooks/syncItemMappings HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BillingSyncQB xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/N3TAPI.Services">
  <environment>DEV</environment>
  <itemsQb xmlns:d2p1="http://schemas.datacontract.org/2004/07/N3TEntities.Billing">
    <d2p1:TypeBillingItemQB>
      <d2p1:_x003C_ContractedCostsTotal_x003E_k__BackingField>0</d2p1:_x003C_ContractedCostsTotal_x003E_k__BackingField>
      <d2p1:_x003C_ContractedCreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_ContractedCreditsTotal_x003E_k__BackingField>
      <d2p1:_x003C_ContractedTotal_x003E_k__BackingField>0</d2p1:_x003C_ContractedTotal_x003E_k__BackingField>
      <d2p1:_x003C_CostsTotal_x003E_k__BackingField>0</d2p1:_x003C_CostsTotal_x003E_k__BackingField>
      <d2p1:_x003C_CreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_CreditsTotal_x003E_k__BackingField>
      <d2p1:_x003C_FeesCostsTotal_x003E_k__BackingField>0</d2p1:_x003C_FeesCostsTotal_x003E_k__BackingField>
      <d2p1:_x003C_FeesCreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_FeesCreditsTotal_x003E_k__BackingField>
      <d2p1:_x003C_FeesTotal_x003E_k__BackingField>0</d2p1:_x003C_FeesTotal_x003E_k__BackingField>
      <d2p1:_x003C_OveragesCostsTotal_x003E_k__BackingField>0</d2p1:_x003C_OveragesCostsTotal_x003E_k__BackingField>
      <d2p1:_x003C_OveragesCreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_OveragesCreditsTotal_x003E_k__BackingField>
      <d2p1:_x003C_OveragesTotal_x003E_k__BackingField>0</d2p1:_x003C_OveragesTotal_x003E_k__BackingField>
      <d2p1:_x003C_SupportCostCostsTotal_x003E_k__BackingField>0</d2p1:_x003C_SupportCostCostsTotal_x003E_k__BackingField>
      <d2p1:_x003C_SupportCostCreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_SupportCostCreditsTotal_x003E_k__BackingField>
      <d2p1:_x003C_SupportCostTotal_x003E_k__BackingField>0</d2p1:_x003C_SupportCostTotal_x003E_k__BackingField>
      <d2p1:_x003C_Total_x003E_k__BackingField>0</d2p1:_x003C_Total_x003E_k__BackingField>
      <d2p1:CompanyFile>V1</d2p1:CompanyFile>
      <d2p1:CostByMonth>
        <d2p1:TypeBillingItemQBMonth>
          <d2p1:_x003C_ContractedCostsTotal_x003E_k__BackingField>0</d2p1:_x003C_ContractedCostsTotal_x003E_k__BackingField>
          <d2p1:_x003C_ContractedCreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_ContractedCreditsTotal_x003E_k__BackingField>
          <d2p1:_x003C_ContractedTotal_x003E_k__BackingField>0</d2p1:_x003C_ContractedTotal_x003E_k__BackingField>
          <d2p1:_x003C_CostsTotal_x003E_k__BackingField>0</d2p1:_x003C_CostsTotal_x003E_k__BackingField>
          <d2p1:_x003C_CreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_CreditsTotal_x003E_k__BackingField>
          <d2p1:_x003C_FeesCostsTotal_x003E_k__BackingField>0</d2p1:_x003C_FeesCostsTotal_x003E_k__BackingField>
          <d2p1:_x003C_FeesCreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_FeesCreditsTotal_x003E_k__BackingField>
          <d2p1:_x003C_FeesTotal_x003E_k__BackingField>0</d2p1:_x003C_FeesTotal_x003E_k__BackingField>
          <d2p1:_x003C_OveragesCostsTotal_x003E_k__BackingField>0</d2p1:_x003C_OveragesCostsTotal_x003E_k__BackingField>
          <d2p1:_x003C_OveragesCreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_OveragesCreditsTotal_x003E_k__BackingField>
          <d2p1:_x003C_OveragesTotal_x003E_k__BackingField>0</d2p1:_x003C_OveragesTotal_x003E_k__BackingField>
          <d2p1:_x003C_SupportCostCostsTotal_x003E_k__BackingField>0</d2p1:_x003C_SupportCostCostsTotal_x003E_k__BackingField>
          <d2p1:_x003C_SupportCostCreditsTotal_x003E_k__BackingField>0</d2p1:_x003C_SupportCostCreditsTotal_x003E_k__BackingField>
          <d2p1:_x003C_SupportCostTotal_x003E_k__BackingField>0</d2p1:_x003C_SupportCostTotal_x003E_k__BackingField>
          <d2p1:_x003C_Total_x003E_k__BackingField>0</d2p1:_x003C_Total_x003E_k__BackingField>
          <d2p1:_x003C_Month_x003E_k__BackingField>0001-01-01T00:00:00</d2p1:_x003C_Month_x003E_k__BackingField>
          <d2p1:_x003C_ProductDescriptions_x003E_k__BackingField>
            <d2p1:TypeBillingItemQBProdDesc>
              <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
              <d2p1:_x003C_Precedence_x003E_k__BackingField>0</d2p1:_x003C_Precedence_x003E_k__BackingField>
              <d2p1:_x003C_ProductId_x003E_k__BackingField>0</d2p1:_x003C_ProductId_x003E_k__BackingField>
              <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField>
              <d2p1:_x003C_ServiceId_x003E_k__BackingField>0</d2p1:_x003C_ServiceId_x003E_k__BackingField>
              <d2p1:_x003C_SupportCost_x003E_k__BackingField>0</d2p1:_x003C_SupportCost_x003E_k__BackingField>
              <d2p1:_x003C_Type_x003E_k__BackingField>Contracted</d2p1:_x003C_Type_x003E_k__BackingField>
              <d2p1:_x003C_Unit_x003E_k__BackingField>String</d2p1:_x003C_Unit_x003E_k__BackingField>
            </d2p1:TypeBillingItemQBProdDesc>
          </d2p1:_x003C_ProductDescriptions_x003E_k__BackingField>
        </d2p1:TypeBillingItemQBMonth>
      </d2p1:CostByMonth>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:FullName>String</d2p1:FullName>
      <d2p1:GLCode>String</d2p1:GLCode>
      <d2p1:IsPOC>false</d2p1:IsPOC>
      <d2p1:ListId>String</d2p1:ListId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ProductDescriptions>
        <d2p1:TypeBillingItemQBProdDesc>
          <d2p1:_x003C_Description_x003E_k__BackingField>String</d2p1:_x003C_Description_x003E_k__BackingField>
          <d2p1:_x003C_Precedence_x003E_k__BackingField>0</d2p1:_x003C_Precedence_x003E_k__BackingField>
          <d2p1:_x003C_ProductId_x003E_k__BackingField>0</d2p1:_x003C_ProductId_x003E_k__BackingField>
          <d2p1:_x003C_Quantity_x003E_k__BackingField>0</d2p1:_x003C_Quantity_x003E_k__BackingField>
          <d2p1:_x003C_ServiceId_x003E_k__BackingField>0</d2p1:_x003C_ServiceId_x003E_k__BackingField>
          <d2p1:_x003C_SupportCost_x003E_k__BackingField>0</d2p1:_x003C_SupportCost_x003E_k__BackingField>
          <d2p1:_x003C_Type_x003E_k__BackingField>Contracted</d2p1:_x003C_Type_x003E_k__BackingField>
          <d2p1:_x003C_Unit_x003E_k__BackingField>String</d2p1:_x003C_Unit_x003E_k__BackingField>
        </d2p1:TypeBillingItemQBProdDesc>
      </d2p1:ProductDescriptions>
      <d2p1:Type>IItemDiscountRet</d2p1:Type>
    </d2p1:TypeBillingItemQB>
  </itemsQb>
</BillingSyncQB>