Electronic Payments

Working with Electronic payments via the API

Electronic Payments are not supported via the API however we can still send the payment to the Electronic payments bank account to be processed from the UI.

Please note that there is no endpoint for Prepare Electronic Payments via the API to create an API bank file to upload to the bank or pay this directly - this is a UI feature only. 

When making a payment via the API if you select the Electronic bank account this will still send that payment to the Prepare Electronic.  

Electronic Payments Support Articles from the UI: 

https://help.myob.com/wiki/display/ar/Electronic+payments

API 

When using the API to Post a payment to the Electronic payments account we need to ensure that the PayFrom account is ElectronicPayments and then the appropriate UID is selected for the account. 

Endpoint: /{cf_uri}/Purchase/SupplierPayment

{
	"PayFrom": "ElectronicPayments",
	"Account": {
		"UID": "161904cc-c2be-4cd7-afbd-ccd304473216",
		"Name": "Electronic Clearing Account",
		"DisplayID": "1-1190",
		"URI": "https://arl2.api.myob.com/accountright/dcc6be7f-6e9e-4c5e-b14d-470e702606fc/GeneralLedger/Account/161904cc-c2be-4cd7-afbd-ccd304473216"
	},
	"Supplier": {
		"UID": "9906d35a-0652-494a-b25e-663e7ff1518a",
		"Name": "Hannah Supplier Test ",
		"DisplayID": "*None",
		"URI": "https://arl2.api.myob.com/accountright/dcc6be7f-6e9e-4c5e-b14d-470e702606fc/Contact/Supplier/9906d35a-0652-494a-b25e-663e7ff1518a"
	},
	"PayeeAddress": "Hannah Supplier Test \r\nAPI Test \r\n",
	"StatementParticulars": "PAYMENT 18",
	"PaymentNumber": "18",
	"Date": "2023-04-13T00:00:00",
	"AmountPaid": 10.000000,
	"AmountPaidForeign": null,
	"Memo": "Payment; Hannah Supplier Test ",
	"Lines": [
		{
		
			"Type": "Bill",
			"Purchase": {
				"UID": "6dadd783-b04f-4153-bfa3-d0ff29ed7227",
				"Number": "00000077",
				"URI": "https://arl2.api.myob.com/accountright/dcc6be7f-6e9e-4c5e-b14d-470e702606fc/Purchase/Bill/Service/6dadd783-b04f-4153-bfa3-d0ff29ed7227"
			},
			"AmountApplied": 10.000000,
			"AmountAppliedForeign": null,
			"GainOrLossAmount": null,
			"RowVersion": "-4753725328550002688"
		}
	],
	"DeliveryStatus": "Print",
	"ForeignCurrency": null,
	"CurrencyExchangeRate": null

}

If you have any questions, feel to log a ticket with the Customisation & Integration Team