For the type, "OM" stand for the namespace prefix "Winbooks.TORM.OM"

Decimal separator is a point

Date are given in Unix Timestamp. Example: "/Date(1520491871000)/" = GMT: Thursday, March 8, 2018 6:51:11 AM

Schema

The customer entity is referencing several other entities. The schema is this one:

Customer
- Third
  - DefautAddress
  - Addresses (List of OM.Address)
  - Contacts (List of OM.Third_Contact)
  - BankAccounts (List of OM.BankAccount)

Customer

Type: OM.Accounting.Customer

Logistics

At this time, there is no Friendly property code for the Logistics foreigner key (ex: Agent_Id).

Property	Type	Id field	Friendly property code	Comment
Code	string			Should be the same as the code of the Third
Third	OM.Third	Third_Id	ThirdCode
Vat	OM.Accounting.VatAccount	Vat_Id	VatCode	Default Vat (ex: 21)
Category	OM.CustomerCategory	CustomerCategory_Id	CategoryCode
GLAccountDefault	OM.Accounting.GLAccount	GLAccount_Id	GLAccountDefaultCode	Default account for the base (ex: "700000")
GLAccountCentral	OM.Accounting.GLAccount	GLAccount2_Id	GLAccountCentralCode	Central account for the clients (ex: "400000")
GLTemplate	OM.Accounting.GLTemplate	GLTemplate_Id	GLTemplateCode	Booking template
PayCode	OM.Accounting.PayCode	PayCode_Id	PayCodeCode	Payment conditions (ex: "30")
VatApplicable	int			0 - Undefined 1 - Subject to 2 - Exempt from 3 - Not subject to
LastReminderLevel	short
LastReminderDate	DateTime
IsReminderBlocked	bool			true - the customer will not receive any reminder of payment
IsLocked	bool			true - we cannot book anymore on this Customer
IsHidden	bool			true - we don't see the customer anymore
MemoType	short			0 - None 1 - Green 5 - Yellow 9 - Red
Memo	string
ConditionalDiscountRate	decimal			Ex: 2.5
ConditionalDiscountDays	decimal			Ex: 7
CommodityCode	string			Default intrastat code for the goods delivered (ex: "01022961")
				Properties used for Logistics only
DiscountCategory_Id				Crossed with the Item.ItemDiscountCategory, it allows to get a discount for a group of customers and a group of items.
Tariff_Id
PayMode_Id				Ex: BANK, CASH, ...
PayTerm_Id				Not used at this time
DeliveryTerm_Id				Ex: CIF, FOB, ...
Agent_Id
ThirdAccountGroup_Id				That's not used often but allows to have the general account depending on the customer and the item.
DiscountRate	decimal			Default discount proposed on each row of the document
GlobalDiscountRate	decimal			Default global discount proposed
IsPartialDelivery	bool			true - the customer accepts partial delivery
IsPartialDeliveryClosed	bool			true - in case of partial delivery, we close the order (no back orders)
IsGroupOrderAllowed	bool			true - the customer accepts to group several orders on one delivery or invoice
IsGroupOrderDifferentAgent	bool			true - group orders with different agents
IsGroupOrderDifferentReference	bool			true - group orders with different references
IsGroupDeliveryAllowed	bool			true - the customer accepts to group several delivery notes on one invoice
IsGroupDeliveryDifferentAgent	bool			true - group delivery notes with different agents
IsGroupDeliveryDifferentAddress	bool			true - group delivery notes with different addresses
IsGroupDeliveryDifferentReference	bool			true - group delivery notes with different references
Custom	IDictionnary<string, object>			List of custom fields + values

Example of respons for: GET {{url}}/app/Customer/BEBOP/Folder/{{folder}}?MaxLevel=1

{
    "$type": "Winbooks.TORM.OM.Customer, Winbooks.TORM.OM",
    "TotalLevel": 1,
    "Version": 15,
    "Modified": "/Date(1520504972000)/",
    "ModifiedBy": "7507ea76-474b-4ccc-80d3-a35b0090b2b6",
    "Created": "/Date(1514995132000)/",
    "CreatedBy": "7507ea76-474b-4ccc-80d3-a35b0090b2b6",
    "Folder_Id": "3a6a9ea1-ce6e-45e7-889a-d8e325a43b70",
    "Third_Id": "7fd099fb-1a6e-43c6-b315-a85d0117d790",
    "Vat_Id": "d939ccde-90ec-45bb-97fe-a74d006cd718",
    "CustomerCategory_Id": "00000000-0000-0000-0000-000000000000",
    "GLTemplate_Id": "00000000-0000-0000-0000-000000000000",
    "GLAccount_Id": "c61c5554-0803-4286-9315-a74d006cd5aa",
    "GLAccount2_Id": "023a99d0-f1e5-45c8-b902-a74d006cd5a8",
    "PayCode_Id": "48a7b7ab-0f1b-4420-af2e-a74d006cd9a8",
    "DiscountCategory_Id": "00000000-0000-0000-0000-000000000000",
    "Tariff_Id": "00000000-0000-0000-0000-000000000000",
    "PayMode_Id": "00000000-0000-0000-0000-000000000000",
    "PayTerm_Id": "00000000-0000-0000-0000-000000000000",
    "DeliveryTerm_Id": "00000000-0000-0000-0000-000000000000",
    "Agent_Id": "00000000-0000-0000-0000-000000000000",
    "ThirdAccountGroup_Id": "00000000-0000-0000-0000-000000000000",
    "Code": "BEBOP",
    "VatApplicable": 1,
    "LastReminderLevel": 0,
    "LastReminderDate": null,
    "DiscountRate": 0,
    "GlobalDiscountRate": 0,
    "IsPartialDelivery": false,
    "IsPartialDeliveryClosed": false,
    "IsGroupOrderAllowed": false,
    "IsGroupOrderDifferentAgent": false,
    "IsGroupOrderDifferentReference": false,
    "IsGroupDeliveryAllowed": false,
    "IsGroupDeliveryDifferentAgent": false,
    "IsGroupDeliveryDifferentAddress": false,
    "IsGroupDeliveryDifferentReference": false,
    "IsReminderBlocked": false,
    "IsLocked": false,
    "IsHidden": false,
    "MemoType": 0,
    "Memo": "",
    "ConditionalDiscountRate": 2.5,
    "ConditionalDiscountDays": 7,
    "CommodityCode": "01022961",
    "Id": "f5e92880-31c0-43af-9348-a85d0117d78b",
    "ResultState": 0,
    "ActionState": 0,
    "CachedCollection": {},
    "IsBinding": false,
    "IsSpecifiedId": false,
    "IsDirty": false,
    "UpdatedEntities": {},
    "Custom_ListValueTypes": [
        "System.String, mscorlib",
        "System.Decimal, mscorlib"
    ],
    "Custom": {
        "Sector": "IT",
        "Turnover": 6000000
    },
    "UpdatedProperties": [],
    "UpdatedValues": [],
    "FolderCode": "JF_TEST_RESTAPI",
    "ThirdCode": "BEBOP",
    "VatCode": "21",
    "CategoryCode": "",
    "GLTemplateCode": "",
    "GLAccountDefaultCode": "700000",
    "GLAccountCentralCode": "400000",
    "PayCodeCode": "7",
    "DiscountCategoryCode": "",
    "ThirdAccountGroupCode": ""
}

Third

Type: OM.Third

Property	Type	Id field	Friendly property code	Comment
Code	string			Should be the same as the code of the Customer
ThirdCivility	OM.ThirdCivility	ThirdCivility_Id	CivilityCode	Ex: "NV"
VatCountry	OM.Country	VatCountry_Id	VatCountryCode	Ex: "BE"
Language	OM.Language	Language_Id	LanguageCode	Ex: "nl"
Currency	OM.Currency	Currency_Id	CurrencyCode	Ex: "EUR"
DefautAddress	OM.DefaultAddress
Addresses	List of OM.Address
Contacts	List of OM.Third_Contact
BankAccounts	List of OM.BankAccount
VatNumber	string			Ex: "0000000196" (without formatting)
WebSite	string			Ex: "www.bebop.be"

Example of respons on: GET url/app/Third/BEBOP/Folder/folder?MaxLevel=1

{
    "$type": "Winbooks.TORM.OM.Third, Winbooks.TORM.OM",
    "TotalLevel": 1,
    "Version": 14,
    "Modified": "/Date(1520504972000)/",
    "ModifiedBy": "7507ea76-474b-4ccc-80d3-a35b0090b2b6",
    "Created": "/Date(1514995132000)/",
    "CreatedBy": "7507ea76-474b-4ccc-80d3-a35b0090b2b6",
    "Folder_Id": "3a6a9ea1-ce6e-45e7-889a-d8e325a43b70",
    "ThirdCivility_Id": "9bc5b8f4-3682-46c6-ac84-a74d006cd9ad",
    "VatCountry_Id": "4bb898f0-21ba-4ea9-9c35-a74d006cd473",
    "Language_Id": "d7176dd5-fe2c-41b3-9bec-a74d006cd54e",
    "Currency_Id": "00000000-0000-0000-0000-000000000000",
    "Code": "BEBOP",
    "Name": "BEBOP",
    "VatNumber": "0000000196",
    "WebSite": "www.bebop.be",
    "LocalizedProperties": [
        "Name"
    ],
    "LocalizedColumns": [
        "Name"
    ],
    "Id": "7fd099fb-1a6e-43c6-b315-a85d0117d790",
    "ResultState": 0,
    "ActionState": 0,
    "CachedCollection": {},
    "IsBinding": false,
    "IsSpecifiedId": false,
    "IsDirty": false,
    "UpdatedEntities": {},
    "Localized": {},
    "Custom": {},
    "UpdatedProperties": [],
    "UpdatedValues": [],
    "FolderCode": "JF_TEST_RESTAPI",
    "CivilityCode": "NV",
    "VatCountryCode": "BE",
    "LanguageCode": "nl",
    "CurrencyCode": ""
}

Address

Property	Type	Id field	Friendly property code	Comment
Index	short			Allows to order the list of the addresses of a third party
Third	OM.Third	Third_Id	ThirdCode
Country	OM.Country	Country_Id	CountryCode
Address1	string
Address2	string
Town	string
Zip	string
Name	string			The name of the company at this address. Could be different from the name of the third party
Number	string			Not used now. The number is put in Address1 or Address2.
Box	string			Not used now.
PhoneNo	string
FaxNo	string
MemoType	short			Cfr Customer.MemoType
Memo	string
IsDelivering	bool			true - it's a delivery address
IsDeliveringDefault	bool			true - it's the one by default
IsPosting	bool			true - it's a posting address (where we send the invoices)
IsPostingDefault	bool			true - it's the one by default
IsInvoicing	bool			true - it's an invoicing address (the address printed on the invoice)
IsInvoicingDefault	bool			true - it's the default one
Custom	IDictionnary<string, object>			List of custom fields + values

    {
        "$type": "Winbooks.TORM.OM.Address, Winbooks.TORM.OM",
        "TotalLevel": 1,
        "Version": 12,
        "Modified": "/Date(1520492557000)/",
        "ModifiedBy": "7507ea76-474b-4ccc-80d3-a35b0090b2b6",
        "Created": "/Date(1520327985000)/",
        "CreatedBy": "7507ea76-474b-4ccc-80d3-a35b0090b2b6",
        "Folder_Id": "3a6a9ea1-ce6e-45e7-889a-d8e325a43b70",
        "Third_Id": "7fd099fb-1a6e-43c6-b315-a85d0117d790",
        "Country_Id": "4bb898f0-21ba-4ea9-9c35-a74d006cd473",
        "Index": 0,
        "Address1": "Vuchtlaan 76",
        "Address2": "",
        "Town": "Antwerpen  ",
        "Zip": "2000  ",
        "Name": "",
        "Number": "",
        "Box": "",
        "PhoneNo": "+3233215476",
        "FaxNo": "",
        "MemoType": 0,
        "Memo": "",
        "IsDelivering": true,
        "IsDeliveringDefault": true,
        "IsPosting": true,
        "IsPostingDefault": true,
        "IsInvoicing": true,
        "IsInvoicingDefault": true,
        "Id": "56e918d4-0cc0-42db-a040-a89b00aa382d",
        "ResultState": 0,
        "ActionState": 0,
        "CachedCollection": {},
        "IsBinding": false,
        "IsSpecifiedId": false,
        "IsDirty": false,
        "UpdatedEntities": {},
        "Custom": {},
        "UpdatedProperties": [],
        "UpdatedValues": [],
        "FolderCode": "JF_TEST_RESTAPI",
        "ThirdCode": "BEBOP",
        "CountryCode": "BE"
    }

Third_Contact

Type: OM.Third_Contact

Content

Space Tools

Schema

Customer

Third

Address

Third_Contact