Supplier Payment POST

URI

https://{DATACENTER}.brightpearl.com/public-api/{ACCOUNT}
/accounting-service/supplier-payment

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

Description

Field description

Field Data type Description Required Notes
transactionRef String Your unique reference for this payment. no Max length 64. If provided a check of the uniqueness of transactionRef AND paymentMethodCode is triggered.
paymentMethodCode String The code of the Brightpearl Payment Method yes Max length 36
paymentType String yes PAYMENT or RECEIPT
orderId Integer yes
currencyIsoCode String yes Must be length 3
exchangeRate Decimal no Must be greater than 0, rounded to 6dp
amountPaid Decimal no Defaults to 0
journalId Integer no Inserted by Brightpearl following the creation of an SR or PP journal. Insert a valid journal ID to prevent Brightpearl from creating SR or PP from this payment.
journalRef String no Will truncate anything longer than 64 characters.
paymentDate DateTime yes This is the date that the payment occurred.

Example 1

Record a PAYMENT of $50 for purchase order 1234.

Request URI

/supplier-payment

Request body

{
	"transactionRef": "REF0001",
	"paymentMethodCode": "ACME_PAY",
	"paymentType": "PAYMENT",
	"orderId": 1234,
	"currencyIsoCode": "USD",
	"exchangeRate": 1.445,
	"amountPaid": 50.00,
	"paymentDate": "2016-06-19T12:00:00"
}

Response

{
	"response": 200
}

Example 2

Record a RECEIPT of £25 for purchase credit 5000.

Request URI

/supplier-payment

Request body

{
	"transactionRef": "REF0002",
	"paymentMethodCode": "ACME_PAY",
	"paymentType": "RECEIPT",
	"orderId": 5000,
	"currencyIsoCode": "GBP",
	"amountPaid": 25.00,
	"paymentDate": "2016-06-19T12:00:00"
}

Response

{
	"response": 201
}