Skip to main content
GET
Get an amendment

Authorizations

Authorization
string
header
required

An API key created in Settings, sent as Authorization: Bearer <key>.

Path Parameters

id
string<uuid>
required

The amendment id.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Response

Successful response

A change to a contract's terms from its startAt. It holds every term from that date, not only the ones that change. Amendment 0 holds the terms the contract was created with.

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
contractId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
amendmentNumber
integer
required

The amendment's place among the contract's amendments: 0 for the original terms, higher for each later one.

Required range: -9007199254740991 <= x <= 9007199254740991
status
enum<string>
required

DRAFT: being written; only a draft's terms can change. FINALIZING: agreed, and the contract's invoices are being updated to match. FINALIZED: agreed, and the invoices match. VOIDING: being withdrawn, and the invoices are being updated back to the terms before it. VOIDED: withdrawn; it no longer applies.

Available options:
DRAFT,
FINALIZING,
FINALIZED,
VOIDING,
VOIDED
type
enum<string>
required

MODIFICATION: changes the contract's terms from startAt. CANCELLATION: ends the contract on endAt. A cancellation lists the line items of the terms it ends, and charges for none of them.

Available options:
MODIFICATION,
CANCELLATION
processingInvoices
boolean
required

Whether the contract's invoices are still being updated after this amendment was finalized or voided, or the contract was deleted.

startAt
string<date-time>
required

The calendar date these terms take effect, carried at UTC midnight. The time is not data.

endAt
string<date-time>
required

The calendar date these terms end, carried at UTC midnight: they cover the days before this date, not the date itself. The time is not data.

paymentTermsDays
integer
required

How many days the customer has to pay an invoice billed under these terms once it is issued.

Required range: -9007199254740991 <= x <= 9007199254740991
finalizedAt
string | null
required

When the amendment became FINALIZED; null if it has not. It stays set if the amendment is voided later.

voidedAt
string | null
required

When someone last asked to withdraw the amendment, which made it VOIDING; null if nobody has.

createdAt
string
required
updatedAt
string
required