Skip to main content

get partners

POST 
/sus/partner/v1/getpartners

Searches/loads partners (main-address partner records). The request body is technically optional: a null body, or a body with no supported filter, intentionally returns an empty partner list (logged server-side as "no restrictions") and never raises an error. Supply at least one filter. Filters are evaluated in a fixed priority order and the FIRST non-empty one wins; the remaining filters are then ignored: (1) identifiers, (2) contractActionUsageDetails (used when its contractTypeSid or contractVersionSid is set), (3) partnerTypeSids (used only when partnerOrAddressName is blank), (4) lfbisCode, (5) altId6, (6) userSid, (7) partnerOrAddressName, (8) filterXDSid alone, (9) fiAccountSids. numberOfDS limits the result size (the contractActionUsageDetails branch defaults to 50 when numberOfDS is null). filterXDSid and the caller's API role additionally restrict the result via a FilterXD where-clause. loadInvoiceAddressCommKinds is not a filter: when true the result additionally carries the invoice-address CommKind per partner. To search by (person or company) NAME, use the top-level partnerOrAddressName filter - this is the path the Fabular UI itself uses for partner name/typeahead search. The identifiers list is for looking up partners by a KNOWN key (partnerSid, partnerRowGuid, or exact partnerName), first non-null wins per entry; identifiers[].searchString is a legacy partial-name path and should be avoided for name search.

Request​

Responses​

successful operation