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 .jsv suffix or ?format=jsv

HTTP + JSV

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: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	itemsQb: 
	[
		{
			companyFile: V1,
			fullName: String,
			listId: String,
			glCode: String,
			type: IItemDiscountRet,
			name: String,
			isPOC: False,
			description: String,
			costByMonth: 
			[
				{
					month: 0001-01-01,
					productDescriptions: 
					[
						{
							type: Contracted,
							productId: 0,
							serviceId: 0,
							unit: String,
							precedence: 0,
							quantity: 0,
							description: String,
							supportCost: 0
						}
					],
					contractedTotal: 0,
					feesTotal: 0,
					overagesTotal: 0,
					supportCostTotal: 0,
					total: 0,
					contractedCostsTotal: 0,
					feesCostsTotal: 0,
					overagesCostsTotal: 0,
					supportCostCostsTotal: 0,
					costsTotal: 0,
					contractedCreditsTotal: 0,
					feesCreditsTotal: 0,
					overagesCreditsTotal: 0,
					supportCostCreditsTotal: 0,
					creditsTotal: 0
				}
			],
			productDescriptions: 
			[
				{
					type: Contracted,
					productId: 0,
					serviceId: 0,
					unit: String,
					precedence: 0,
					quantity: 0,
					description: String,
					supportCost: 0
				}
			],
			contractedTotal: 0,
			feesTotal: 0,
			overagesTotal: 0,
			supportCostTotal: 0,
			total: 0,
			contractedCostsTotal: 0,
			feesCostsTotal: 0,
			overagesCostsTotal: 0,
			supportCostCostsTotal: 0,
			costsTotal: 0,
			contractedCreditsTotal: 0,
			feesCreditsTotal: 0,
			overagesCreditsTotal: 0,
			supportCostCreditsTotal: 0,
			creditsTotal: 0
		}
	],
	environment: DEV
}