SapccApiGetOrgDocumentsRequest
Request parameters for getOrgDocuments operation in SapccApi. SapccApiGetOrgDocumentsRequest
interface SapccApiGetOrgDocumentsRequest {
readonly baseSiteId: string;
readonly endRange?: string;
readonly fields?: string;
readonly filterByKey?: string;
readonly filterByValue?: string;
readonly orgUnitId: string;
readonly page?: number;
readonly pageSize?: number;
readonly sort?: string;
readonly startRange?: string;
readonly status?: string;
readonly userId: string;
}Properties
| Name | Required | Type | Description |
|---|---|---|---|
baseSiteId | Required | string | Base site identifier {string} SapccApiGetOrgDocuments |
endRange | Optional | string | Upper limit for a specified range filter (for range filterByKeys: orgDocumentIdRange, createdAtDateRange (format: MM/dd/yyyy), dueAtDateRange (format: MM/dd/yyyy), amountRange (number) and openAmountRange (number).) {string} SapccApiGetOrgDocuments |
fields | Optional | string | Response configuration. This is the list of fields that should be returned in the response body. Examples: BASIC,DEFAULT,FULL {string} SapccApiGetOrgDocuments |
filterByKey | Optional | string | Filter to apply on the retrieved list of organizational documents. Possible values are: orgDocumentId, orgDocumentIdRange, orgDocumentType, createdAtDateRange, dueAtDateRange, amountRange, and openAmountRange. {string} SapccApiGetOrgDocuments |
filterByValue | Optional | string | Value for a specified filter (for single value filterByKeys: orgDocumentId and orgDocumentType.) {string} SapccApiGetOrgDocuments |
orgUnitId | Required | string | Organizational unit identifier. {string} SapccApiGetOrgDocuments |
page | Optional | number | Current result page. Default value is 0. {number} SapccApiGetOrgDocuments |
pageSize | Optional | number | Number of results returned per page. {number} SapccApiGetOrgDocuments |
sort | Optional | string | Sorting method applied to the return results. Default value is: byCreatedAtDateAsc. {string} SapccApiGetOrgDocuments |
startRange | Optional | string | Lower limit for a specified range filter (for range filterByKeys: orgDocumentIdRange, createdAtDateRange (format: MM/dd/yyyy), dueAtDateRange (format: MM/dd/yyyy), amountRange (number) and openAmountRange (number).) {string} SapccApiGetOrgDocuments |
status | Optional | string | Organizational document status. Possible values are: open, closed, and all. {string} SapccApiGetOrgDocuments |
userId | Required | string | User identifier or one of the literals : 'current' for currently authenticated user, 'anonymous' for anonymous user {string} SapccApiGetOrgDocuments |