Search

Page tree
Skip to end of metadata
Go to start of metadata

Below is a list of the available BSS JSON objects. All basic objects when they sync the first time to the 3party system, they keep the 3party Object key in property IntegrationId.

 Account
Push method
Account
{
  "id": int,
  "integrationId": string,
  "createdAt": datetimeoffset,
  "updatedAt": datetimeoffset,
  "customValues": Array of CustomValue objects,
  "name": string,
  "enableOrdering": bool,
  "parentAccount": Account object
  "job": string,
  "code": string,
  "webSite": string,
  "phone": string,
  "fax": string,
  "description": string,
  "isLead": bool,
  "prorateBillingEnabled": int?,
  "creditLimitAmount": decimal,
  "unlimitedCreditLimit": bool?,
  "useDebitInvoice": int?,
  "separateInvoicesEnabled": bool,
  "locationCode": string,
  "partialChargesInvoicing": int,
  "corpEmail": string,
  "companyName": string,
  "enableReselling": bool,
  "autoInvoiceNotificationEnabled": bool,
  "vatNumber": string,
  "taxAuthority": string,
  "validVatNum": int?,
  "isTaxable": bool,
  "industry": Industry Object,
  "type": AccountType object,
  "source": AccountSource object,
  "currency" : Currency object,
  "creditLimitAmount": decimal,
  "addresses": Array of AccountAddress objects,
  "entityUsage": string,
  "transactionCurrency" : Currency Object,
  "responsibleUser" : User Object,
  "paymentMethod" : PaymentMethod Object
}
Account Industry
{
  "id": int,
  "integrationId" : string,
  "name" : string,
  "description" : string,
  "position" : int,
  "erpCode" : string,
  "isDefault" : bool?
}
Account Type
{
  "id": int,
  "integrationId" : string,
  "name" : string,
  "position" : int
}
Account Source
{
  "id": int,
  "integrationId" : string,
  "name" : string,
  "position" : int
}
Account Address
{
  "id": Guid,
  "integrationId" : string,
  "description": string,
  "address1": string,
  "address2": string,
  "city": string,
  "region": string,
  "postCode": string,
  "isBilling": bool,
  "stateCode" : string,
  "stateName" : string,
  "erpCode": string,
  "areaCode": string,
  "countryName" : string,
  "countryCode": string
 }
Pull method
Account
{
  "Name": string,
  "EnableOrdering": bool,
  "ParentAccountId": External system parent account Id,
  "Job": string,
  "Code": string,
  "WebSite": string,
  "Phone": string,
  "Fax": string,
  "Description": string,
  "IsLead": bool,
  "ProrateBillingEnabled": int?,
  "CreditLimitAmount": decimal,
  "UnlimitedCreditLimit": bool?,
  "UseDebitInvoice": int?,
  "SeparateInvoicesEnabled": bool,
  "LocationCode": string,
  "PartialChargesInvoicing": int,
  "CorpEmail": string,
  "CompanyName": string,
  "EnableReselling": bool,
  "AutoInvoiceNotificationEnabled": bool,
  "VatNumber": string,
  "TaxAuthority": string,
  "ValidVatNum": int?,
  "IsTaxable": bool,  
  "EntityUsage": string,
  "TypeID" : External system account type Id,
  "SourceId" : External system account source Id,
  "IndustryId" : External system account industry Id,
  "CurrencyCodeId" : External system account currency Id,
  "TransactionCurrencyCodeId" : External system account currency Id,
  "PaymentMethodId" : External system account currency Id,
  "Address" : Account Address object
}
Account Address
{
  "description": string,
  "Address1": string,
  "Address2": string,
  "City": string,
  "Region": string,
  "PostCode": string,
  "IsBilling": bool,
  "CountryCode": ISO 3166 country code, or custom value by using lookup table,
  "StateCode" : ISO 3166 State name or state code
 }
 User
User
{
"id" : int,
"name" : string,
"createdAt" : DateTimeOffset,
"updatedAt" : DateTimeOffset,
"firstName" : string,
"lastName" : string,
"email" : string,
"contact" : Contact Object,
"currency" : Currency Object,
"userType" : string
}
 Contact
Push method
Contact
{
  "id": int,
  "integrationId": string,
  "createdAt": datetimeoffset,
  "updatedAt": datetimeoffset,
  "customValues": Array of CustomValue objects,
  "account": Account object,
  "isPrimary": bool?,
  "lastName": string,
  "firstName": string,
  "mobilePhone": string,
  "phone": string,
  "fax": string,
  "email": string,
  "isBillTo": bool?,
  "jobTitle": string,
  "notes": string,
  "idSource": int?,
  "massMailEnabled": int?
}
Pull method
Contact
{
  "Account": External system account Id,
  "IsPrimary": bool?,
  "LastName": string,
  "FirstName": string,
  "MobilePhone": string,
  "Phone": string,
  "Fax": string,
  "Email": string,
  "IsBillTo": bool?,
  "JobTitle": string,
  "Notes": string,
  "IDSource": int?,
  "MassMailEnabled": int?,
  "OptIn": bool?,
  "CurrencyCodeId" : External system account currency Id
}
 Case
Push method
Case
{
  "id": int,
  "integrationId": string,
  "account": Account object,
  "contact": Contact object,
  "stage": Case Stage object,
  "initContact": CaseInitContact object,
  "type": CaseType object,
  "reason": Case Reason object,
  "satisfaction": Case Satisfaction object,
  "priority": CasePriority object,
  "name": string,
  "description": string,
  "percentComplete": byte,
  "dueDate" : datetimeoffset?
  "code" : string,
  "manHours": int?,
  "folder": Case Folder object,
  "originalMsg": int?,
  "onLineSupport": int?,
  "parent": Case object,
  "mainCase": Case object,
  "startDate": datetimeoffset?,
  "autoSchedule": bool?,
  "manHoursCalculation": double?,
  "duration" : timeSpan?,
  "product": Product object
}
Case Folder
{
  "id": int,
  "integrationId": string,
  "createdAt": datetimeoffset,
  "updatedAt": datetimeoffset,
  "description": string,
  "name": string,
  "parent": Case object
}
Case Stage
{
  "id": int,
  "integrationId": string,
  "name": string,
  "description": string,
  "positionList": byte,
  "type": string,
  "isActive": bool,
  "isDefault": bool?
}
Case Init Contact
{
  "id": int,
  "integrationId": string,
  "name": string,
  "positionList": byte?,
  "webComEnabled": bool
}
Case Priority
{
  "id": int,
  "integrationId": string,
  "name": string,
  "positionList": byte?,
  "webComEnabled": bool
}
Case Reason
{
  "id": int,
  "integrationId": string,
  "name": string,
  "positionList": byte?,
  "webComEnabled": bool
}
Case Satisfaction
{
  "id": int,
  "integrationId": string,
  "name": string,
  "positionList": byte?,
  "webComEnabled": bool
}
Case Type
{
  "id": int,
  "integrationId": string,
  "name": string,
  "positionList": byte?,
  "webComEnabled": bool,
  "isDefault" : bool?
}
Pull method
Case
{
  "account": Account object,
  "ContactId": External system case contact Id,
  "StageId": External system case stage Id,
  "TypeId": External system case type Id,
  "PriorityId": External system case priority Id,
  "Name": string,
  "Description": string,
  "Percentcomplete": byte,
  "DueDate" : datetimeoffset?
  "Code" : string,
  "ManHours": int?,
  "FolderId": Case Folder object,
  "OriginalMsg": int?,
  "OnLineSupport": int?,
  "parent": Case object,
  "mainCase": Case object,
  "StartDate": datetimeoffset?,
  "AutoSchedule": bool?,
  "ProductId": External system case product Id
}
 Order
Order
{
  "id": Guid,
  "integrationId": string,
  "createdAt": datetimeoffset,
  "updatedAt": datetimeoffset,
  "customValues": Array of CustomValue objects,
  "code": string,
  "name": string,
  "date": datetimeoffset,
  "deliveryDate": datetimeoffset?,
  "totalPrice": decimal,
  "discount": decimal?,
  "discountType": byte?,
  "usage": string,
  "creditLimitExceeded": bool?,
  "stage": OrderStage object,
  "type": OrderType object,
  "description":string,
  "account": Account object,
  "customer": Account object,
  "contact": Contact object,
  "paymentMethod": PaymentMethod object,
  "shippingMethod": ShippingMethod object,
  "isInvoiced": bool?,
  "parentId": string,
  "orderItems": Array of OrderItem objects
}
Order Item
{
  "id": Guid,
  "integrationId" : string,
  "order": Order object,
  "createdAt": datetimeoffset,
  "updatedAt": datetimeoffset,
  "name": string,
  "relatedItemId" : Guid?,
  "itemRelationType": string,
  "product": Product object,
  "price": decimal?,
  "quantity": decimal,
  "discount": decimal?,
  "discountType": byte?,
  "totalPrice" : decimal?,
  "basePrice" : decimal?
  "rowPosition" : int,
  "comments" : string,
  "baseQuantity" : decimal?,
  "promotionDiscount" : decimal,
  "promotionDiscountType" : byte?,
  "parentId" : Guid?,
  "billingOption" : int?,
  "isUserPrice" : bool?,
  "isInvoiced" : bool?,
  "taxes" : OrderItemTax Object,
  "variations" : OrderItemVariation Object,
  "lineAmount" : decimal?
}
Order Stage
{
  "id": int,
  "integrationId" : string,
  "name": string,
  "type": OrderStage Type enum
 }
OrderStage type
Executed = 0,
Submited = 1,
Canceled = 2
Order Type
{
  "id": int,
  "integrationId" : string,
  "name": string
 }
Order Item Tax
{
  "id": Guid,
  "integrationId" : string,
  "name": string,
  "rate": decimal?,
  "amount": decimal?
 }
Order Item Variation
{
  "id": Guid,
  "valueId" : string,
  "name": string,
  "value": string,
  "chargeAmount": string,
  "chargePercent": string,
  "allowUnlimited" : bool?,
  "orderItem" : OrderItem Object,
  "variation" : ProductTypeAttribute Object

 }
 Invoice
Invoice
{
  "id": Guid,
  "integrationId": string,
  "createdAt": datetimeoffset,
  "updatedAt": datetimeoffset,
  "customValues": Array of CustomValue objects,
  "code": string,
  "invoiceDate": datetimeoffset,
  "dueDate": datetimeoffset,
  "proformaDue": datetimeoffset,
  "datePaid": datetimeoffset,
  "grossAmount": decimal,
  "discountAmount": decimal,
  "totalAmount": decimal,
  "netAmount": decimal,
  "amountFactor": decimal,
  "balance": decimal,
  "isProforma": bool,
  "stage": InvoiceStage object,
  "type": InvoiceType object,
  "paymentMethod": PaymentMethod object,
  "account": Account object,
  "billingAccount": Account object,
  "invoiceItems": Array of InvoiceItem objects,
  "transactionCurrency" : Currency Object,
  "transactionExchangeRate" : decimal?
  "invoiceCurrency" : InvoiceCurrency Object
}
Invoice Stage
{
  "id": int,
  "integrationId" : string,
  "name": string,
  "type" : string
}
How to find Invoice Stages Values

Below you can find the procedure in order to find the IDs you need to use in your JSON file:

  1. Go to BSS > Setup > Billing > Invoices > Invoice Status.
  2. Locate the checkbox next to the "No." of each Status. 
  3. Right Click on each checkbox and select ‘Inspect Element’
  4. On the inspected element under the tr > td >div you will find the element Value

    Between the quotes you can find the ID of each Invoice Stage
  5. Follow the same procedure for all Stages/Statuses you have set.
Invoice Type
{
  "id": int,
  "integrationId" : string,
  "name": string,
  "type" : string
}
How to find Invoice Stages Values

Below you can find the procedure in order to find the IDs you need to use in your JSON file:

  1. Go to BSS > Setup > Billing > Invoices > Invoice Types.
  2. Locate the checkbox next to the "No." of each Type. 
  3. Right Click on each checkbox and select ‘Inspect Element’
  4. On the inspected element under the tr > td >div you will find the element Value

    Between the quotes you can find the ID of each Invoice Type
  5. Follow the same procedure for all Types you have set.
Invoice Item
{
  "id": Guid,
  "integrationId" : string,
  "account" : Account object,
  "invoice": Invoice object,
  "parent": InvoiceItem object,
  "invoiceItemTaxes": Array of InvoiceItemTax objects,
  "product": Product object,
  "orderItem": OrderItem object,
  "unit" : Unit Object
  "customUnitCategory": string,
  "itemName" : string,
  "quantity" : decimal?,
  "unitPrice" : decimal?,
  "costPrice" : decimal?,
  "amount" : decimal,
  "discount" : decimal,
  "discountType" : byte?,
  "finalPrice" : decimal,
  "leaseStart" : datetimeoffset,
  "leaseEnd" : datetimeoffset,
  "comments" : string,
  "invoiceDue" : datetimeoffset,
  "promotionDiscount" : decimal,
  "promotionEnd" : datetimeoffset,
  "vatPercent" : decimal,
  "usage" : string,
  "addonItemId" : Guid
  "subscriptionId": Guid? 
}
Invoice Item Tax
{
  "id": Guid,
  "integrationId" : string,
  "name": string,
  "rate": decimal?,
  "amount": decimal
 }
InvoiceCurrency
{
"id" : Guid,
"currency" : Currency Object,
"rateDate" : DateTimeOffset?
}
 Product
Product
{
  "id": Guid,
  "integrationId": string,
  "createdAt": datetimeoffset,
  "updatedAt": datetimeoffset,
  "customValues": Array of CustomValue objects,
  "isActivated": bool?,
  "storefrontEnabled": bool?,
  "isFeatured": bool?,
  "isEnabled": bool?,
  "trialDuration": int?,
  "trialDurationType": string,
  "trialNo": int?,
  "trialType": string,
  "ignoreProrate": int,
  "prorataBilling" : int?,
  "chargeType": string,
  "isNew": bool?,
  "overviewPage": string,
  "featuresTabVisible": bool?,
  "supportTabVisible": bool?,
  "supportOptions": string,
  "keyWords": string,
  "screenshotLinkEnabled": bool?,
  "demoLinkEnabled": bool?,
  "documentLinkEnabled": bool?,
  "termsOfUseEnabled": bool?,
  "termsOfUse": string,
  "isTaxable": bool,
  "trialVariationsEnabled": bool?,
  "webOfferEnabled": int?,
  "webCatalogueEnabled": bool,
  "groupPosition": int?,
  "availableViaPriceList": bool,
  "category": ProductCategory object,
  "unitgroup": UnitGroup object,
  "unitType" : UnitType object,
  "productType" : ProductType object
  "provisioningSystem" : ProvisioningSystem object
  "name": string,
  "code": string,
  "isBundle": bool,
  "isDeleted": bool,
  "numberOfDecimals": int,
  "chargeRule": string,
  "webOrderEnabled": int,
  "isProductGroup": bool,
  "shortDescription": string,
  "fullDescription": string,
  "isNegative": bool?,
  "comments": string,
  "isCompetitive": bool?,
  "competitionComments": string,
  "activateAllUnits": bool?,
  "filePath": string,
  "billingOption": int?,
  "isAddon": bool?,
  "includeAllProducts": int?,
  "extraKeyWords": string,
  "userProvisioningEnabled": int?,
  "requestType": int?,
  "idResource": int?,
  "productAttributeValues": Array of ProductAttributeValue objects,
  "productPrices": Array of ProductPrice objects,
  "term": int?,
  "termType": string,
  "freePeriodEnabled": bool?,
  "taxCode": string,
  "externalBilling": bool
}
Product Prices
{
    "priceProductId" : Guid,
	"salesPrice" : decimal?,
	"purchasePrice" : decimal?,
	"isSalesDefault" : byte?
	"sheet" : string,
	"cell" : string,
	"purSheet" : string,
	"purCell" : string,
	"isComputed" : bool? 
}
Unit Group
{
  "id": int,
  "integrationId" : string,
  "name": string,
  "description" : string,
  "lastUpdateID" : int?,
  "isActive" : bool,
  "systemType" : short,
  "isDeleted" : int,
  "iDCopyOf" : int
}
Unit Type
{
  "id": Guid,
  "integrationId" : string,
  "name": string,
  "position" : int?,
  "isActive" : bool,
  "isDefault" : int,
  "iDCopyOf" : Guid?
}
Unit
    {
        "id" : Guid,
        "integrationId" : string,
        "name" : string,
        "mnemonic" : string,
        "decimalPlaces" : string,
        "group" : UnitGroup object,
        "relatedUnitId" : Guid,
        "quantity" : int,
        "baseQuantity" : int,
        "isDefault" : bool,
        "isActive" : bool,
        "isEnabledForOrder" : bool,
        "isViewable" : bool?,
        "systemType" : int?,
        "duration" : int?,
        "durationType" : string,
        "isDeleted" : int?,
        "iDCopyOf" : Guid
    }
Product Type


{
 "id": Guid,
 "integrationId" : string,
 "name": string,
 "description" : string,
 "enableSerialNo" : bool,
 "productDescription" : string,
 "enforcePacking" : int?,
 "eRPCode" : string,
 "dueDays" : int?,
 "locationCode" : string,
 "serverCollection" : string,
 "usage" : string,
 "quantityLimit" : decimal?,
 "uniqueLease" : int,
 "restrictions" : string,
 "serverCollectionID" : int?,
 "vendor" : string,
 "requestType" : string,
 "quantityLimitLocked" : int?,
 "extraDetails" : string,
 "retentionPeriodDays" : int?,
 "iDCopyOf" : Guid,
 "productTypeAttributeGroups" : Array of ProductTypeAttributeGroup Objects,
 "productTypeAttributes" : Array of ProductTypeAttribute Objects
}
Product Attribute Value
{
  "id": Guid,
  "value" : string,
  "allowUnlimited" : bool?,
  "quantityLinked" : bool?,
  "usageBased" : int?,
  "ProductTypeAttribute" : ProductTypeAttribute Object
}
Product Category
{
  "id" : Guid,
  "integrationId" : string,
  "name" : string,
  "code" : string,
  "iDCopyOf" : Guid,
  "parent" : ProductCategory object,
  "productNo" : int?
  "isActivated" : bool,
  "description" : string
  "isSalesGroup" : byte?
  "positionList" : int?
  "createdAt" : datetime,
  "updatedAt" : datetime
}
Product Type Attribute
{
  "id" : Guid,
  "productType" : ProductType Object,
  "productTypeAttributeType" : ProductTypeAttributeType Object,
  "productTypeAttributeGroup" : ProductTypeAttributeGroup Object,
  "name" : string,
  "description" : string,
  "indent" : byte,
  "attributeType" : byte,
  "dataType" : byte?,
  "positionList" : int,
  "isCompulsory" : int,
  "valueDescription" : string,
  "idRow" : int,
  "hasExtraValue" : bool?,
  "conditionRule" : string,
  "allowUnlimited" : bool?,
  "quantityLinked" : bool?
  "usageBased" : int?,
  "externalSpec" : string,
  "positionInWeb" : int?,
  "isSyncLocked" : int?,
  "sliderMin" : int?,
  "sliderMax" : int?.
  "sliderStep" : int?
}
Product Type Attribute Type
{
  "id" : Guid,
  "createdAt" : DatetimeOffset,
  "updatedAt" : DatetimeOffset,
  "name" : string,
  "dataType" : short,
  "description" : string,
  "valueDescription" : string
}
Product Type Attribute Group
{
  "id" : Guid,
  "createdAt" : DatetimeOffset,
  "updatedAt" : DatetimeOffset,
  "name" : string,
  "description" : string,
  "positionInList" : int?
}
Product Type Attribute Value
    {
        "id" : Guid,
        "productTypeAttributeType" : ProductTypeAttributeType object,
        "value" : string,
        "language" : Language object,
        "iDParent" : System.Nullable<System.Guid>,
        "isDefault" : int,
        "code" : string,
        "positionInlist" : int?,
        "externalSpec" : string,
        "iDResource" : int?,
        "productTypeAttributeCharges" : Array of ProductTypeAttributeCharge objects,
        "iDCopyOf" : Guid
    }


Product Type Attribute Charge
    {
        "id" : Guid,
        "productTypeAttribute" : ProductTypeAttribute object,
        "productTypeAttributeValue" : ProductTypeAttributeValue object,
        "charge" : decimal?,
        "chargeType" : byte?,
        "sheet" : string,
        "cell" : string
    }
Product Type Attribute Value
    {
        "id" : Guid,
        "productTypeAttributeType" : ProductTypeAttributeType object,
        "value" : string,
        "language" : Language object,
        "iDParent" : System.Nullable<System.Guid>,
        "isDefault" : int,
        "code" : string,
        "positionInlist" : int?,
        "externalSpec" : string,
        "iDResource" : int?,
        "productTypeAttributeCharges" : Array of ProductTypeAttributeCharge objects,
        "iDCopyOf" : Guid
    }

 Payment
Push method
Payment
{
  "id": Guid,
  "integrationId": string,
  "createdAt": datetimeoffset
  "updatedAt": datetimeoffset,
  "type" : PaymentType object,
  "method" : PaymentMethod object,
  "gateway" : PaymentGateway object,
  "account": Account object,
  "contact": Contact object,
  "chequeBank" : Bank object,
  "paymentDate": datetimeoffset,
  "amount": decimal,
  "code": string,
  "state": string,
  "chequeNo": string,
  "dueDate": datetimeoffset,
  "chequePayTo": string,
  "creditCard": string,
  "creditCardId": Guid,
  "comments": string,
  "erpCode": string,
  "isCanceled": bool,
  "transactionFee": decimal,
  "sendConfirmation": bool,
  "sysState": int,
  "sysComment": string,
  "transactionID": string,
  "balance": decimal,
  "paymentInvoices": Array of PaymentInvoice objects
}
Payment Method
{
  "id": Guid,
  "integrationId" : string,
  "name": string,
  "active" : bool,
  "default" : bool?,
  "eRPName" : string,
  "payDays" : int,
  "type: " string,
  "gateway" : PaymentGateway Object
 }
Payment Type
{
  "id": Guid,
  "integrationId" : string,
  "name": string,
  "type": string,
  "isActive" : bool
}
Payment Gateway
{
  "id": int,
  "integrationId" : string,
  "name": string,
  "type": string,
  "isSupported" : bool
}
Bank
{
  "id": Guid,
  "integrationId" : string,
  "name": string,
  "description": string,
  "position" : byte,
  "isActive" : bool
  "payments" : Array of Payment objects
}
Payment Invoice
{
  "invoice": Invoice object,
  "amount" : decimal
}
Pull method
Payment
{
  "TypeId" : External system payment type Id,
  "MethodId" : External system payment method Id,
  "AccountId": External system payment account Id,
  "PaymentDate": datetimeoffset,
  "Amount": decimal,
  "Code": string,
  "State": string,
  "ChequeNo": string,
  "DueDate": datetimeoffset,
  "ChequePayTo": string,
  "Comments": string,
  "ERPCode": string,
  "IsCanceled": bool,
  "TransactionFee": decimal,
  "SendConfirmation": bool,
  "SysState": int,
  "SysComment": string,
  "Balance": decimal,
  "PaymentInvoices": Array of PaymentInvoice objects
}
Payment Invoice
{
  "InvoiceId": External system invoice Id,
  "Amount" : decimal
}
 Currency
Currency
{
  "id": Guid,
  "integrationId" : string,
  "name": string,
  "mnemonic": string,
  "sign" : string,
  "code": string
}
 Custom Value
Custom Value
{
  "customField": CustomFieldDefinition object,
  "value" : string,
  "values": string
 }
Custom Field Definition
{
  "id": int,
  "name" : string,
  "caption": string,
  "apiField" : string
}
 Subscription
Lease
    {
        "id" : Guid,
        "integrationId" : string,
        "createdAt" : DateTimeOffset,
        "updatedAt" : DateTimeOffset,
        "customValues" : Array of CustomValue objects,
        "name" : string,
        "startDate" : DateTimeOffset,
        "endDate" : DateTimeOffset,
        "duration" : int?,
        "durationType" : string,
        "signupDate" : DateTimeOffset,
        "effectiveDate" : DateTimeOffset,
        "account" : Account object,
        "billingAccount" : Account object,
        "stage" : LeaseStage object,
        "quantity" : int,
        "autoRenew" : bool,
        "isTrial" : bool,
        "contact" : Contact object,
        "expirationNotice" : int?,
        "billingOption" : bool,
        "unit" : Unit object,
        "dataMigration" : bool,
        "unitPrice" : decimal?,
        "subscriptionAmount" : decimal?,
        "finalPrice" : decimal?,
        "totalAmount" : decimal?,
        "basePrice" : decimal?,
        "discount" : decimal?,
        "discountType" : Int16?,
        "isUserPrice" : Int16?,
        "isExcelPrice" : bool?,
        "prorataRate" : decimal,
        "rounding" : Int32?,
        "prorataDay" : Int32?,
        "monthlyRunRate" : decimal?,
        "productAmount" : decimal?,
        "usage" : string,
        "product" : Product object,
        "order" : Order object,
        "promotion" : Promotion object,
        "promotionDiscountType" : int?,
        "promotionDiscount" : decimal?,
        "promotionEndDate" : DateTimeOffset?,
        "iDParent" : Guid?,
        "term" : int?,
        "termType" : string,
        "termStartDate" : DateTimeOffset?,
        "termEndDate" : DateTimeOffset?,
        "freePeriodStartDate" : DateTimeOffset?,
        "freePeriodEndDate" : DateTimeOffset?,
        "priceList" : Pricelist object,
        "variations" : Array of LeaseVariation objects,
        "leaseCurrency" : LeaseCurrency object,
        "derivative" : string,
        "type" : LeaseType object,
        "productSalesPrice" : decimal?,
        "productCostPrice" : decimal?,
		"Description" : string 
    }


Lease Variation
    {
        "id" : int,
        "subscription" : Lease object,
        "variation" : ProductTypeAttribute object,
        "variationValues" : Array of ProductTypeAttributeValue objects,
        "value" : string,
        "allowUnlimited" : bool,
        "variationName" : string
    }

Language
    {
        "id" : string,
        "integrationId" : string,
        "label" : string,
        "isEnabled" : bool,
        "charSet" : string,
        "pageCode" : string,
        "guid" : Guid
    }
Lease Stage
    {
        "id" : int,
        "integrationId" : string,
        "translation" : Translation object,
        "name" : string,
        "positioninlist" : int,
        "type" : string,
        "color" : string,
        "isactive" : bool,
        "isdefault" : bool?,
        "idstring" : int?
    }
Translation
    {
        "id" : int,
        "label" : string,
        "english" : string,
        "french" : string,
        "spanish" : string,
        "italian" : string,
        "portugese" : string,
        "german" : string,
        "norwegian" : string,
        "dutch" : string,
        "greek" : string,
        "bulgarian" : string,
        "romanian" : string,
        "croatian" : string,
        "hungarian" : string,
        "polish" : string,
        "serbian" : string,
        "russian" : string,
        "arabic" : string,
        "hebrew" : string,
        "indonesian" : string,
        "bosnian" : string,
        "malagacy" : string,
        "chinese" : string,
        "traditionalChinese" : string,
        "turkish" : string,
        "arabicMoroccan" : string,
        "swedish" : string,
        "wallisFutuna" : string,
        "newCaledonia" : string,
        "frenchPolynesia" : string,
        "georgian" : string
    }
Promotion
    {
        "id" : Guid,
        "createdAt" : DateTimeOffset,
        "updatedAt" : DateTimeOffset,
        "customValues" : Array of CustomValue objects,
        "subject" : string,
        "description" : string,
        "stage" : PromotionStage object
    }
Promotion Stage
    {
        "id" : int,
        "integrationId" : string,
        "name" : string
    }
Pricelist
    {
        "id" : int,
        "createdAt" : DateTimeOffset,
        "updatedAt" : DateTimeOffset,
        "customValues" : Array of CustomValue objects,
        "products" : Array of PricelistItem objects,
        "fromDate" : DateTimeOffset?,
        "name" : string,
        "toDate" : DateTimeOffset?,
        "description" : string,
        "active" : int,
        "pricelistCurrency" : PricelistCurrency object
    }
Pricelist Item
    {
        "id" : int,
        "priceType" : byte,
        "price" : decimal?,
        "sheet" : string,
        "cell" : string,
        "conditionRule" : string,
        "name" : string,
        "comment" : string,
        "status" : int?,
        "unit" : Unit object,
        "priceGroup" : PriceGroup object,
        "product" : Product object,
        "volumeDiscount" : VolumeDiscount object
    }
Price Group
    {
        "id" : Guid,
        "createdAt" : DateTimeOffset,
        "updatedAt" : DateTimeOffset,
        "name" : string,
        "description" : string,
        "lastUpdateID" : int?,
        "isActive" : bool,
        "systemType" : short,
        "isDeleted" : int,
        "iDCopyOf" : Guid?
  }


Volume Discount
    {
        "id" : int,
        "integrationId" : string,
        "createdAt" : DateTimeOffset,
        "updatedAt" : DateTimeOffset,
        "name" : string,
        "isActive" : bool,
        "isScalable" : int,
        "iDCopyOf" : int,
        "volumeDiscountItems" : Array of VolumeDiscountItem objects
    }
Volume Discount Item
    {
        "id" : int,
        "fromQuantity" : decimal?,
        "toQuantity" : decimal?,
        "amount" : decimal
    }
Pricelist Currency
    {
        "id" : int,
        "rateDate" : DateTimeOffset?,
        "exchangeRate" : decimal?,
        "currency" : Currency object
    }
Lease Currency
    {
        "id" : Guid,
        "myProperty" : Guid,
        "rateDate" : DateTimeOffset?,
        "exchangeRate" : decimal?,
        "currency" : Currency object,
        "lease" : Lease object
    }
Lease Type
    {
        "id" : int,
        "integrationId" : string,
        "name" : string,
        "positionInList" : int
    }

Property IntegrationId is accessible only up to the third level dot notation.

For examlpe:

$.contact.account.type.IntegrationId is accessible but

$.invoice.invoiceItem.product.unitType.integrationId is not accessible

Nested objects can be accessed with dot notation, i.e to access the ID of the parentAccount object on account use $.account.parentAccount.Id


Supported Push and Pull Methods


This article explains which are the Push and Pull methods supported by our custom connector.
Push are the methods where interworks.cloud platform sends information to external systems and pull are the methods where we get information from the external systems.


PushPull
CreateUpdateDeleteCreateUpdate
Account(tick)(tick)
(tick)(tick)
Contact(tick)(tick)
(tick)(tick)
Product(tick)(tick)


Invoice(tick)(tick)


Invoice Items(tick)(tick)


Orders(tick)(tick)


Order Items(tick)(tick)


Payments(tick)(tick)
(tick)(tick)
Leases(tick)(tick)


Cases(tick)(tick)
(tick)(tick)







  • No labels