Get all Payment Profiles
Header Parameters
Authorizationstring
Query Parameters
accountFromstring
accountPriorityFromstring
accountPriorityTostring
accountTostring
allocationMarkerFrom.codeinteger
allocationMarkerFrom.descriptionstring
allocationMarkerTo.codeinteger
allocationMarkerTo.descriptionstring
amountThresholdFrominteger
amountThresholdTointeger
amountType.codeinteger
amountType.descriptionstring
bankDetailsCodestring
bankFileFormat.codeinteger
bankFileFormat.descriptionstring
bankFileIdentifierstring
bankFileVariant.codeinteger
bankFileVariant.descriptionstring
bankSubCodestring
currencyCode1string
currencyCode10string
currencyCode11string
currencyCode12string
currencyCode13string
currencyCode14string
currencyCode15string
currencyCode16string
currencyCode17string
currencyCode18string
currencyCode19string
currencyCode2string
currencyCode20string
currencyCode21string
currencyCode22string
currencyCode23string
currencyCode24string
currencyCode25string
currencyCode26string
currencyCode27string
currencyCode28string
currencyCode29string
currencyCode3string
currencyCode30string
currencyCode4string
currencyCode5string
currencyCode6string
currencyCode7string
currencyCode8string
currencyCode9string
currencyFrom1integer
currencyFrom10integer
currencyFrom11integer
currencyFrom12integer
currencyFrom13integer
currencyFrom2integer
currencyFrom3integer
currencyFrom4integer
currencyFrom5integer
currencyFrom6integer
currencyFrom7integer
currencyFrom8integer
currencyFrom9integer
currencySelection.codeinteger
currencySelection.descriptionstring
currencyTo1integer
currencyTo10integer
currencyTo11integer
currencyTo12integer
currencyTo13integer
currencyTo2integer
currencyTo3integer
currencyTo4integer
currencyTo5integer
currencyTo6integer
currencyTo7integer
currencyTo8integer
currencyTo9integer
dataAccessGroupCodestring
dateTimeLastUpdatedstring
defaultBankSubcodestring
excludeIncludeAll.codeinteger
excludeIncludeAll.descriptionstring
excludeProvisionalPostings.codeinteger
excludeProvisionalPostings.descriptionstring
includeClientDebits.codeinteger
includeClientDebits.descriptionstring
lookupCodestring
payAtCurrentRate.codeinteger
payAtCurrentRate.descriptionstring
paymentAccountstring
paymentCurrency.codeinteger
paymentCurrency.descriptionstring
paymentDocumentFormatCodestring
paymentFileIdentifier.codeinteger
paymentFileIdentifier.descriptionstring
paymentMethod.codeinteger
paymentMethod.descriptionstring
paymentOption.codeinteger
paymentOption.descriptionstring
paymentProfileCodestring
paymentProfileNamestring
paymentReportFormatCodestring
paymentsDebits.codeinteger
paymentsDebits.descriptionstring
postSingleTxnToPaymntAcnt.codeinteger
postSingleTxnToPaymntAcnt.descriptionstring
rateTypeinteger
ratesOverride.codeinteger
ratesOverride.descriptionstring
retainBankV4CurrCode.codeinteger
retainBankV4CurrCode.descriptionstring
retainSupplierV4CurrCode.codeinteger
retainSupplierV4CurrCode.descriptionstring
selectionCode1.codeinteger
selectionCode1.descriptionstring
selectionCode2.codeinteger
selectionCode2.descriptionstring
selectionCode3.codeinteger
selectionCode3.descriptionstring
selectionCode4.codeinteger
selectionCode4.descriptionstring
selectionCode5.codeinteger
selectionCode5.descriptionstring
status.codeinteger
status.descriptionstring
subCategory1string
subCategory2string
subCategory3string
subCategory4string
subCategory5string
totalPaymentLimitinteger
updateCountinteger
userIdLastUpdatedstring
pagestring
Default value
0
pageSizestring
Minimum
1
Maximum
20000
Default value
100
selectstring
Allows a comma-separated list of columns to select. If no columns are specified, all columns will be selected by default.
e.g. LedgerBalances.accountCode, LedgerBalances.accountingPeriod, LedgerBalances.baseAmount_amount
Path Parameters
businessUnitstring Required
Response
200
Object
OK
Response Attributes
linksarray
Show child attributes
contentarray
Show child attributes
401
Object
Unauthorised.
403
Object
Forbidden
500
Object
Internal server error
Response Attributes
statusCodestring
The HTTP status code.
internalStatusCodestring
A internal status code for diagnosing the error.
messagestring
A user friendly message describing the error.
errorsstring
A collection of error messages that give more detail of the error.
retryablestring
Indicates that the operation can be retried.
504
Object
Request timed out.
Response Attributes
statusCodestring
The HTTP status code.
internalStatusCodestring
A internal status code for diagnosing the error.
messagestring
A user friendly message describing the error.
errorsstring
A collection of error messages that give more detail of the error.
retryablestring
Indicates that the operation can be retried.
Was this section helpful?
Response
Was this section helpful?