API Reference

Export Agreements as XLSX

post
https://api.scalepad.com/lifecycle-manager/v1/agreements/export/xlsx

Download the current agreements list as an XLSX spreadsheet.

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

Filter and sort options used when exporting agreements.

string | null

Client scoping filter. Use eq for one client id or in
for multiple client ids.

string | null

Agreement name filter. Use the cont operator to match the agreement name or display name.

is_hidden_filters
array of booleans | null

Hidden agreement filter. Use eq for one hidden state or in
for multiple hidden states. Defaults to false when omitted.

is_hidden_filters
statuses
array of objects | null

Agreement status filter. Use eq for one status or in
for multiple statuses. Available values: Active, Inactive.

statuses
Allowed:
cost_types
array of objects | null

Billing cost type filter. Use eq for one cost type or
in for multiple cost types. Available values: Actual, Estimate.

cost_types
Allowed:
billing_cycles
array of objects | null

Billing cycle filter. Use eq for one billing cycle or
in for multiple billing cycles.
Available values: Monthly, Quarterly, Annually, SemiAnnual, EveryTwoYears, EveryThreeYears, EveryFourYears, EveryFiveYears, EveryTenYears, OneTime, BiMonthly, Unknown, BiWeekly.

billing_cycles
string | null

Agreement location filter. Use eq for one location or in
for multiple locations.

string | null

Third-party agreement filter. Use the eq operator with
true or false.

string | null
enum

Auto-renew filter applied to the list query or export. Query requests
use the eq operator.
Available values: Yes, No, Either.

Allowed:
expiry_filters
array of objects | null

Renewal or expiry windows applied to the list or export. Query requests
use filter[expiry] with eq for one window or in for multiple windows.
Available values: Expired, ZeroToThirty, ThirtyOneToSixty, SixtyOneToNinety, NinetyPlus.

expiry_filters
Allowed:
string | null

One or more sortable fields, separated by commas. Prefix with +
for ascending or - for descending.
Available values: billing_next_due_at, end_at, name, client.name, billing_cost_subunits, status, billing_cycle, is_auto_renew.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json

Generated from available request content types

Allowed:
Responses

Updated 17 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
application/json

Updated 17 days ago

Did this page help you?