<back to all web services
BillingSyncQB
The following routes are available for this service:| POST | /billing/quickbooks/syncItemMappings | Syncronize Quickbooks GLCodes and items with the Onbaording mapping layer | |
|---|
BillingSyncQB Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| itemsQb | body | List<TypeBillingItemQB> | No | |
| environment | body | N3TEnvironment | No | Allowable Values |
TypeBillingItemQB Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| CompanyFile | form | CompanyFile | No | |
| FullName | form | string | No | |
| ListId | form | string | No | |
| GLCode | form | string | No | |
| Type | form | ItemType | No | |
| Name | form | string | No | |
| IsPOC | form | bool | No | |
| Description | form | string | No | |
| CostByMonth | form | List<TypeBillingItemQBMonth> | No | |
| ProductDescriptions | form | List<TypeBillingItemQBProdDesc> | No | |
TypeBillingItemQBBase Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| ContractedTotal | form | decimal | No | |
| FeesTotal | form | decimal | No | |
| OveragesTotal | form | decimal | No | |
| SupportCostTotal | form | decimal | No | |
| Total | form | decimal | No | |
| ContractedCostsTotal | form | decimal | No | |
| FeesCostsTotal | form | decimal | No | |
| OveragesCostsTotal | form | decimal | No | |
| SupportCostCostsTotal | form | decimal | No | |
| CostsTotal | form | decimal | No | |
| ContractedCreditsTotal | form | decimal | No | |
| FeesCreditsTotal | form | decimal | No | |
| OveragesCreditsTotal | form | decimal | No | |
| SupportCostCreditsTotal | form | decimal | No | |
| CreditsTotal | form | decimal | No | |
CompanyFile Enum:| Name | Value | |
|---|
| V1 | 1 | |
| V2 | 2 | |
| Test | 3 | |
ItemType Enum:| Name | Value | |
|---|
| IItemDiscountRet | 1 | |
| IItemFixedAssetRet | 2 | |
| IItemGroupRet | 3 | |
| IItemInventoryAssemblyRet | 4 | |
| IItemInventoryRet | 5 | |
| IItemNonInventoryRet | 6 | |
| IItemOtherChargeRet | 7 | |
| IItemPaymentRet | 8 | |
| IItemSalesTaxGroupRet | 9 | |
| IItemSalesTaxRet | 10 | |
| IItemServiceRet | 11 | |
| IItemSubtotalRet | 12 | |
TypeBillingItemQBMonth Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Month | form | DateTime | No | |
| ProductDescriptions | form | List<TypeBillingItemQBProdDesc> | No | |
TypeBillingItemQBProdDesc Parameters:| Name | Parameter | Data Type | Required | Description |
|---|
| Type | form | BillType | No | |
| ProductId | form | int | No | |
| ServiceId | form | int | No | |
| Unit | form | string | No | |
| Precedence | form | int | No | |
| Quantity | form | decimal | No | |
| Description | form | string | No | |
| SupportCost | form | decimal | No | |
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>