Sales Receipt (deprecated) POST(DEPRECATED)

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/accounting-service/sales-receipt/

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

Description

This message has been DEPRECATED. Please use journal entry POST.

This method allows you to create a Sales Receipt for a customer account against just a customer account or against an order or even against an invoice for an order.

Things to be aware of:

  • You do not need an orderId or an invoiceReference if a customerId is provided.
  • You do not need a customerId if an orderId is provided.
  • The customer associated with the customerId must be a primary customer
  • If an orderId and a customerId is provided, the customer must be associated with the order.
  • You can over pay a invoice. The overpaid proportion will be placed against the customers account.
  • The bankAccountNominalCode must be a valid nominal code
  • channelId is optional.

Example 1

Creating a sales receipt for the invoice gdfgdf34 on order 1000 for customer 35345 with amount 12.43 GBP and crediting the bank account 1210.

Request URI

/sales-receipt/

Request body

{
	"orderId": "1000",
	"customerId": "200",
	"received": {
		"currency": "GBP",
		"value": "12.43"
	},
	"invoiceReference": "gdfgdf34",
	"bankAccountNominalCode": "1200",
	"description": "bla bal bal",
	"taxDate": "2011-05-02T00:00:00.000Z",
	"channelId": 4
}

Response

{
	"response": 30
}

Example 2

Creating a sales receipt for the customer 35345 with amount 1234.54 USD and crediting the bank account 1210.

Request URI

/sales-receipt/

Request body

{
	"customerId": "200",
	"received": {
		"currency": "USD",
		"value": "1234.54"
	},
	"bankAccountNominalCode": "1200",
	"description": "bla bal bal",
	"taxDate": "2011-05-02T00:00:00.000Z",
	"channelId": 1
}

Response

{
	"response": 32
}