Agreement programs: create, get, list

Reference for Agreement, one group of Agreement programs.

Agreement.create

Creates an Agreement. Verb page.

Text

do: return await $.Agreement.create(input)

Emits Agreement.created.

Inputs

Input	Type	Description
`term`	`text`	How long it runs and how it ends.
`signedAt`	`datetime`	When the last Party signed.
`terminatedAt`	`datetime`	When it ended under its term; it stays on record.
`payoutSchedule`	`string`	For a Supplier’s Agreement: how often the released earned balance pays out.
`clearanceDays`	`integer`	For a Supplier’s Agreement: days an Order’s earnings wait after confirmation before they can pay out.

Returns

Output	Type	Required	Description
`agreement`	Agreement	required	The Agreement.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Agreement.create({ term: 'Example term' })"
  }
}

Returns one Agreement by id. Verb page.

Text

do: return await $.Agreement.get(input)

Reads only: it emits no Event.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Agreement.
`at`	`string`		A time or Version name: the record as it stood then. Unset: as it stands now.

Returns

Output	Type	Required	Description
`agreement`	Agreement	required	The Agreement.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Agreement.get({ id: 'agreement_zHIUnX8LwY' })"
  }
}

Returns Agreements, newest first, one page at a time. Verb page.

Text

do: return await $.Agreement.list(input)

Reads only: it emits no Event.

Inputs

Input	Type	Description
`limit`	`integer`	At most this many records, up to 100. The default is 20.
`after`	`string`	The cursor from the previous page.
`where`	`string`	A filter over the properties, such as `paidAt = null and total.amount > 500`.
`sort`	`string`	Properties to sort by, comma-separated; a leading minus sorts descending.
`total`	`boolean`	True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above.
`facets`	`string`	Properties to count by value, comma-separated, returned as `meta.facets`.
`fields`	`string`	Properties to return on each record, comma-separated; `$id` and `$type` always return.
`include`	`string`	Related records to embed in place of their URLs, comma-separated.
`depth`	`integer`	How many levels of related records to embed. The default is 1.
`q`	`string`	Words to match across the text properties, ranked by relevance.
`match`	`string`	Ranks the search by `words`, or `meaning`; words is the default.

Returns

Output	Type	Required	Description
`agreements`	list of Agreement	required	One page of Agreements.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

JSON

{
  "name": "do",
  "arguments": {
    "code": "return await $.Agreement.list({ limit: 20 })"
  }
}