Inventory Zones

Sections

Theme switcher

Get Payment Profile

Header Parameters

Authorizationstring

Query Parameters

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
paymentProfileCodestring Required

Response

200
Object

OK

Response Attributes

accountFromstring
accountPriorityFromstring
accountPriorityTostring
accountTostring
allocationMarkerFromobject

Show child attributes

allocationMarkerToobject

Show child attributes

amountThresholdFrominteger
amountThresholdTointeger
amountTypeobject

Show child attributes

bankDetailsCodestring
bankFileFormatobject

Show child attributes

bankFileIdentifierstring
bankFileVariantobject

Show child attributes

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
currencySelectionobject

Show child attributes

currencyTo1integer
currencyTo10integer
currencyTo11integer
currencyTo12integer
currencyTo13integer
currencyTo2integer
currencyTo3integer
currencyTo4integer
currencyTo5integer
currencyTo6integer
currencyTo7integer
currencyTo8integer
currencyTo9integer
dataAccessGroupCodestring
dateTimeLastUpdatedstring
defaultBankSubcodestring
excludeIncludeAllobject

Show child attributes

excludeProvisionalPostingsobject

Show child attributes

includeClientDebitsobject

Show child attributes

lookupCodestring
payAtCurrentRateobject

Show child attributes

paymentAccountstring
paymentCurrencyobject

Show child attributes

paymentDocumentFormatCodestring
paymentFileIdentifierobject

Show child attributes

paymentMethodobject

Show child attributes

paymentOptionobject

Show child attributes

paymentProfileCodestring
paymentProfileNamestring
paymentReportFormatCodestring
paymentsDebitsobject

Show child attributes

postSingleTxnToPaymntAcntobject

Show child attributes

rateTypeinteger
ratesOverrideobject

Show child attributes

retainBankV4CurrCodeobject

Show child attributes

retainSupplierV4CurrCodeobject

Show child attributes

selectionCode1object

Show child attributes

selectionCode2object

Show child attributes

selectionCode3object

Show child attributes

selectionCode4object

Show child attributes

selectionCode5object

Show child attributes

statusobject

Show child attributes

subCategory1string
subCategory2string
subCategory3string
subCategory4string
subCategory5string
totalPaymentLimitinteger
updateCountinteger
userIdLastUpdatedstring
userDefinedFieldsobject
linksarray

Show child attributes

401
Object

Unauthorised.

403
Object

Forbidden

404
Object

Not found

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?

GET

/

Select
1

Response

Was this section helpful?