Journal GET

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/accounting-service/journal/{ID-SET}

Refer to our documentation on URI syntax for more information on how to construct URIs.

Example

Request all the journals with IDs in the range 1-2. The response shows two journals each with a number of credits and debits.

Request URI

/journal/1-2

Response

{
	"response": {
		"journals": [
			{
				"id": 1,
				"contactId": 1434,
				"journalTypeCode": "SI",
				"taxDate": "2008-01-02T00:00:00.000Z",
				"dueDate": "2008-02-15T00:00:00.000Z",
				"createdOn": "2008-01-16T00:00:00.000Z",
				"createdByContactId": 95,
				"taxReconciliation": {
					"date": "2008-04-29T00:00:00.000+01:00",
					"taxPeriodId": 18
				},
				"credits": [
					{
						"nominalCode": "2200",
						"change": {
							"value": "15.66"
						},
						"assignment": {
							"channelId": 2,
							"projectId": 1
						},
						"orderId": 100003,
						"invoiceReference": "SI-1000",
						"taxCode": "T00",
						"transactionAmount": "15.66"
					},
					{
						"nominalCode": "4001",
						"change": {
							"value": "14.50"
						},
						"assignment": {
							"channelId": 2,
							"projectId": 1
						},
						"orderId": 100003,
						"invoiceReference": "SI-1000",
						"taxCode": "T00",
						"transactionAmount": "14.50"
					},
					{
						"nominalCode": "4000",
						"change": {
							"value": "75.00"
						},
						"assignment": {
							"channelId": 2,
							"projectId": 1
						},
						"orderId": 100003,
						"invoiceReference": "SI-1000",
						"taxCode": "T00",
						"transactionAmount": "75.00"
					}
				],
				"debits": [
					{
						"nominalCode": "1100",
						"change": {
							"value": "105.16"
						},
						"assignment": {
							"channelId": 2,
							"projectId": 1
						},
						"orderId": 100003,
						"invoiceReference": "SI-1000",
						"taxCode": "T05",
						"transactionAmount": "105.16"
					}
				],
				"currencyId": 1,
				"exchangeRate": "1.000000"
			},
			{
				"id": 2,
				"contactId": 1438,
				"journalTypeCode": "SI",
				"taxDate": "2008-01-17T00:00:00.000Z",
				"dueDate": "2008-02-16T00:00:00.000Z",
				"createdOn": "2008-01-17T00:00:00.000Z",
				"createdByContactId": 95,
				"taxReconciliation": {
					"date": "2008-04-29T00:00:00.000+01:00",
					"taxPeriodId": 18
				},
				"credits": [
					{
						"nominalCode": "2200",
						"change": {
							"value": "66.66"
						},
						"assignment": {
							"channelId": 2
						},
						"orderId": 100011,
						"invoiceReference": "SI-1001",
						"taxCode": "T20",
						"transactionAmount": "92.73"
					},
					{
						"nominalCode": "4000",
						"change": {
							"value": "333.34"
						},
						"assignment": {
							"channelId": 2
						},
						"orderId": 100011,
						"invoiceReference": "SI-1001",
						"taxCode": "T20",
						"transactionAmount": "463.67"
					}
				],
				"debits": [
					{
						"nominalCode": "1100",
						"change": {
							"value": "400.00"
						},
						"assignment": {
							"channelId": 2
						},
						"orderId": 100011,
						"invoiceReference": "SI-1001",
						"taxCode": "T20",
						"transactionAmount": "556.40"
					}
				],
				"currencyId": 2,
				"exchangeRate": "1.391000"
			}
		]
	}
}