Read the payment schedules of an order

Returns the payment schedules of all lines of an order, one row per schedule, in pages (page 1 with 10 records by default). The order ID is mandatory and all other parameters are optional. Send lineId for one line only.

Only the caller's own tenant is read. Wrong parameter values and unknown parameter names are reported with a 400, and an order that does not exist with a 404. Without vendorsiteId, schedules on inactive vendor sites are left out. Requires the paymentsch_r permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

The order whose payment schedules are returned. It must be a positive whole number

Query Params
int64

Returns only the schedules of this line. It must be a positive whole number and a line of the order

int64

Returns only the schedules of this vendor site. It must be a positive whole number and a vendor site used on the order

int32
Defaults to 1

Page number to return, starting from 1. It must be a positive whole number

int32
Defaults to 10

Number of records per page. It must be a positive whole number

sort
array of strings

Fields to sort by, as field:ASC or field:DESC, separated by commas; the default is lineId, payFrom, payTo, paymentSchId. Any response field except paymentLineType, currency and totalPaymentAmount, in any case

sort
string
enum
Defaults to ASC

Direction for the sort fields given without their own direction; a field's own direction wins. Not case-sensitive. Another value is reported as "Invalid direction "

Allowed:

Returns only the schedules whose vendor name, vendor site code, period, type code or type label contains this text. Not case-sensitive; % and _ are matched as ordinary characters

fields
array of strings

Response fields to return, separated by commas. All fields are returned when this is not given. Field names are not case-sensitive; a name that is not a response field is reported as "Invalid fields value "

fields
string

Returns only the schedules whose vendor name contains this text. Not case-sensitive

string

Returns only the schedules whose vendor site code contains this text. Not case-sensitive

string

Returns only the schedules with this status code, in any case (e.g. PAID or Paid). Part of a code matches nothing. A status that does not exist is reported as "Invalid value for the status"

string

Returns only the schedules of this type, given as its code or its label in any case (e.g. CREDIT_MEMO or Credit Memo). Part of a type matches nothing. A type that does not exist is reported as "Invalid value for the type"

string

Returns only the schedules of this period, written MMM-YY. Not case-sensitive. Another format is reported as "Invalid period. Use the format MMM-YY, e.g. FEB-26"

string

Returns only the schedules whose pay-from date is on or after this date, written dd-MMM-yyyy. It must not be later than payTo

string

Returns only the schedules whose pay-from date is on or before this date, written dd-MMM-yyyy

string

Returns only the schedules with this pay date, written dd-MMM-yyyy

string

Returns only the schedules with this invoice date, written dd-MMM-yyyy

string

Accepted but not applied: sending it does not change the result

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json