Norgate Trader API Docs

Appearance

Clients ​

Get all clients ​

Method : GET
Endpoint : /api/clients

{
	"data": [
		{
			"CLIENT_ID": 1,
			"CLIENT_NAME": "Kompānija SIA",
			"CLIENT_NR": 123,
			"IS_FIZISKA": false,
			"REG_NR": "123123123",
			"PVN_REG_NR": "LV123123123",
			"ADDRESS": "Rīga, Rīgas iela 2",
			"REAL_ADDRESS": "Rīga, Rīgas iela 2",
			"PHONE": "",
			"MOBILE_PHONE": "",
			"EMAIL": "epasts@kompanija.lv",
			"NOTES": "",
			"PRICE_LEVEL_ID": 1,
			"CLIENT_DEBIT_GROUP_ID": 1,
			"banks": [
				{
					"BANK_CODE": "HABALV22",
					"BANK_SWIFT_CODE": "HABALV22",
					"BANK_NAME": "Swedbank AS",
					"ACCOUNT": "LV64HABA123123123",
					"IS_DEFAULT": true
				}
			],
			"types": [],
			"payer": null
		}
	],
	"links": {
		"first": "/api/clients?page=1",
		"last": "/api/clients?page=254",
		"prev": null,
		"next": "/api/clients?page=2"
	},
	"meta": {
		"current_page": 1,
		"from": 1,
		"last_page": 254,
		"path": "/api/clients",
		"per_page": 100,
		"to": 100,
		"total": 25301
	}
}

Get only changed clients ​

Method : GET
Endpoint : /api/clients/changes

TIP

Returns changed clients by default within the last hour or specified timestamp (if date is specified). Example:

https://<yourdomain>/api/clients/changes?token=<your_token>&date=1672527661

Get single client ​

Method : GET
Endpoint : /api/clients/{id}

{
	"CLIENT_ID": 1,
	"CLIENT_NAME": "Kompānija SIA",
	"CLIENT_NR": 123,
	"IS_FIZISKA": false,
	"REG_NR": "123123123",
	"PVN_REG_NR": "LV123123123",
	"ADDRESS": "Rīga, Rīgas iela 2",
	"REAL_ADDRESS": "Rīga, Rīgas iela 2",
	"PHONE": "",
	"MOBILE_PHONE": "",
	"EMAIL": "epasts@kompanija.lv",
	"NOTES": "",
	"PRICE_LEVEL_ID": 1,
	"CLIENT_DEBIT_GROUP_ID": 1,
	"banks": [
		{
			"BANK_CODE": "HABALV22",
			"BANK_SWIFT_CODE": "HABALV22",
			"BANK_NAME": "Swedbank AS",
			"ACCOUNT": "LV64HABA123123123",
			"IS_DEFAULT": true
		}
	],
	"types": [],
	"payer": null
}

Insert a client ​

Method : POST
Endpoint /api/clients

{
	"CLIENT_NAME": "Kompānija SIA",
	"IS_FIZISKA": false,
	"REG_NR": "123123123",
	"PVN_REG_NR": "LV123123123",
	"ADDRESS": "Rīga, Rīgas iela 2",
	"REAL_ADDRESS": "Rīga, Rīgas iela 2",
	"PHONE": "",
	"EMAIL": "epasts@kompanija.lv",
	"banks": [
		{
			"BANK_CODE": "HABALV22",
			"BANK_SWIFT_CODE": "HABALV22",
			"BANK_NAME": "Swedbank AS",
			"ACCOUNT": "LV64HABA123123123",
			"IS_DEFAULT": true
		}
	],
	"types": [],
	"payer": null
}

TIP

Returns existing client if IS_FIZISKA is true with the same EMAIL else with the same REG_NR.

Update client ​

Method : PUT
Endpoint /api/clients/{id}

{
	"CLIENT_ID": 1,
	"CLIENT_NAME": "Kompānija SIA",
	"IS_FIZISKA": false,
	"REG_NR": "123123123",
	"PVN_REG_NR": "LV123123123",
	"ADDRESS": "Rīga, Rīgas iela 2",
	"PHONE": "",
	"FAX": "",
	"EMAIL": "epasts@kompanija.lv",
	"banks": [
		{
			"BANK_CODE": "HABALV22",
			"BANK_SWIFT_CODE": "HABALV22",
			"BANK_NAME": "Swedbank AS",
			"ACCOUNT": "LV64HABA123123123",
			"IS_DEFAULT": true
		}
	],
	"types": [],
	"payer": null
}

Debitor groups ​

Method : GET
Endpoint /api/clients/debitor_groups

[
	{
		"CLIENT_DEBIT_GROUP_ID": 1,
		"CLIENT_DEBIT_GROUP_NAME": "VIP", //Nosaukums
		"CLIENT_DEBIT_GROUP_TEXT": "", //Komentārs
		"COLOR": "#C0C000", //Krāsa
		"SELL_NOT_ALLOWED": false, //Atļauts pārdot
		"SHOW_ALERT": false, //Rādīt paziņojumu
		"ONLY_PREPAYMENT": false //Tikai priekšapmaksa
	}
]

Client types ​

Method : GET
Endpoint /api/clients/types

[
	{
		"CLT_ID": 1,
		"CLT_NAME": "Klienti"
	}
]