API docs by Redocly

Payaca API (1.0.0)

Download OpenAPI specification:Download

Tech Team: tech@payaca.com License: Proprietary

Welcome to the Payaca API

Create project for a customer

Creates a new project for the specified customer

Authorizations:
basicAuth
path Parameters
id
required
string
Example: 123
Request Body schema: application/json
reference
required
string or null
required
object or string or null
Any of
line1
required
string
line2
required
string or null
city
required
string or null
postcode
required
string
country
required
string or null
tags
required
Array of strings or null
required
object or object or null
Any of
title
required
string
required
object or object or null
Any of
title
required
string
required
object or null
email
required
string <email>
notes
required
Array of strings or null

Responses

Request samples

Content type
application/json
{
  • "reference": "ABC123",
  • "siteAddress": {
    },
  • "tags": [
    ],
  • "pipeline": {
    },
  • "pipelineStage": {
    },
  • "assignTo": {
    },
  • "notes": [
    ]
}

Response samples

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

Create or update Customer

Creates a new Customer, or if any Customer with an email exists, adds to that one instead. If multiple Customers are found, the earliest created one is used.

Authorizations:
basicAuth
Request Body schema: application/json
name
required
string or null
required
Array of objects non-empty
Array (non-empty)
fullName
required
string
email
required
string or null
phoneNumber
required
string or null
description
string or null
isPrimaryContact
required
boolean
required
Array of objects or null
Array
required
object or string
isBillingAddress
required
boolean
required
Array of objects or null

Responses

Request samples

Content type
application/json
{
  • "name": "Harper Property Management",
  • "contacts": [
    ],
  • "addresses": [
    ]
}

Response samples

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