Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB
Contract

Retrieves the collection of Contract resources.

Retrieves the collection of Contract resources.

get/contracts

Query parameters

pageinteger

The collection page number

itemsPerPageinteger

The number of items per page

Response

Contract collection

idstring
integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

the unique identifier of the source 3rd party integration

contractNamestring nullable

contract name

customerstring nullable

customer related to the contract

contractDatestring date-time nullable

when the contract is signed

startDatestring date-time nullable

when the contract will start

endDatestring date-time nullable

when the contract will end

descriptionstring nullable

additional details about the contract

statusstring nullable

status of the contract e.g: activated, draft

Example response

[
  {
    "integration": "quickbooks"
  }
]