API docs by Redocly

Repzo API - Contract (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Contract endpoints.

Find contracts

query Parameters
params
object

Query parameters for filtering contracts

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": { }
}

Create a contract

Request Body schema: application/json
title
string
client
string
startDate
string <date-time>
endDate
string <date-time>
totalAmount
number
currency
string
status
string
terms
string
installments
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "client": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalAmount": 0,
  • "currency": "string",
  • "status": "string",
  • "terms": "string",
  • "installments": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Get a contract by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "data": {
    }
}

Update a contract

path Parameters
id
required
string
Request Body schema: application/json
title
string
client
string
startDate
string <date-time>
endDate
string <date-time>
totalAmount
number
currency
string
status
string
terms
string
installments
Array of objects

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "client": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "endDate": "2019-08-24T14:15:22Z",
  • "totalAmount": 0,
  • "currency": "string",
  • "status": "string",
  • "terms": "string",
  • "installments": [
    ]
}

Response samples

Content type
application/json
{
  • "data": {
    }
}

Remove a contract

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "success": true
}