Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

PropertyTypeId fieldFriendly property codeComment

Code

string



Should be the same as the code of the Third

ThirdOM.ThirdThird_IdThirdCode

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")

CustomIDictionnary<string, object>

List of custom fields + values




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

CustomIDictionnary<string, object>

List of custom fields + values

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

true
No Format
nopanel
{
    "$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": ""
}

...

Code Block
titleExample 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

PropertyTypeId fieldFriendly property codeComment
Indexshort

Allows to order the list of the addresses of a third party
ThirdOM.ThirdThird_IdThirdCode
CountryOM.CountryCountry_IdCountryCode
Address1string


Address2string


Townstring


Zipstring


Namestring

The name of the company at this address. Could be different from the name of the third party
Numberstring

Not used now. The number is put in Address1 or Address2.
Boxstring

Not used now.
PhoneNostring


FaxNostring


MemoTypeshort

Cfr Customer.MemoType
Memostring


IsDeliveringbool

true - it's a delivery address
IsDeliveringDefaultbool

true - it's the one by default
IsPostingbool

true - it's a posting address (where we send the invoices)
IsPostingDefaultbool

true - it's the one by default
IsInvoicingbool

true - it's an invoicing address (the address printed on the invoice)
IsInvoicingDefaultbool

true - it's the default one
CustomIDictionnary<string, object>

List of custom fields + values


No Format
nopaneltrue
    {
        "$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"
    }

...