API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_clients

Retrieves the collection of person_clients resources.

Retrieves the collection of person_clients resources.

Authorizations:
JWT
query Parameters
page
integer
Default: 1

The collection page number

itemsPerPage
integer [ 0 .. 1000 ]
Default: 30

The number of items per page

exists[projects]
boolean
exists[invoices]
boolean
exists[rents]
boolean
exists[potentialNotes]
boolean
exists[satisfactionNotes]
boolean
exists[satisfactionDate]
boolean
exists[marketingSource]
boolean
exists[code]
boolean
exists[accountNumber]
boolean
exists[notes]
boolean
exists[paymentTerms]
boolean
exists[shipper]
boolean
exists[paymentTime]
boolean
exists[projectType]
boolean
exists[partners]
boolean
exists[productSellPrices]
boolean
exists[orderMaxAmount]
boolean
exists[accountMaxAmount]
boolean
exists[deletedAt]
boolean
exists[customProperties]
boolean
exists[disabledAt]
boolean
properties[]
Array of strings

Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}

enabled
boolean

Filter entities by enabled (1), disabled (0), or all (nothing).

search
string
tag
string

Filter using tag.

order[createdDate]
string
Default: "asc"
Enum: "asc" "desc"
order[satisfactionDate]
string
Default: "asc"
Enum: "asc" "desc"
order[deletedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[createdAt]
string
Default: "asc"
Enum: "asc" "desc"
order[updatedAt]
string
Default: "asc"
Enum: "asc" "desc"
order[disabledAt]
string
Default: "asc"
Enum: "asc" "desc"
order[potential]
string
Default: "asc"
Enum: "asc" "desc"
order[satisfaction]
string
Default: "asc"
Enum: "asc" "desc"
order[discount]
string
Default: "asc"
Enum: "asc" "desc"
order[interestsOnPayment]
string
Default: "asc"
Enum: "asc" "desc"
order[paymentDiscount]
string
Default: "asc"
Enum: "asc" "desc"
order[orderMinAmount]
string
Default: "asc"
Enum: "asc" "desc"
order[orderMaxAmount]
string
Default: "asc"
Enum: "asc" "desc"
order[accountMaxAmount]
string
Default: "asc"
Enum: "asc" "desc"
order[potentialNotes]
string
Default: "asc"
Enum: "asc" "desc"
order[satisfactionNotes]
string
Default: "asc"
Enum: "asc" "desc"
order[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[paymentTerms]
string
Default: "asc"
Enum: "asc" "desc"
order[code]
string
Default: "asc"
Enum: "asc" "desc"
order[accountNumber]
string
Default: "asc"
Enum: "asc" "desc"
order[slug]
string
Default: "asc"
Enum: "asc" "desc"
order[deliveryTime]
string
Default: "asc"
Enum: "asc" "desc"
order[maxCredit]
string
Default: "asc"
Enum: "asc" "desc"
order[paymentTime]
string
Default: "asc"
Enum: "asc" "desc"
order[nbDaysPaymentDiscount]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
string
Default: "asc"
Enum: "asc" "desc"
order[person.firstName]
string
Default: "asc"
Enum: "asc" "desc"
order[person.lastName]
string
Default: "asc"
Enum: "asc" "desc"
accountMaxAmount_range[between]
string
accountMaxAmount_range[gt]
string
accountMaxAmount_range[gte]
string
accountMaxAmount_range[lt]
string
accountMaxAmount_range[lte]
string
accountMaxAmount
string
accountMaxAmount[]
Array of strings
accountNumber_end_with
string
accountNumber_partial
string
accountNumber_start_with
string
accountNumber
string
accountNumber[]
Array of strings
code_end_with
string
code_partial
string
code_start_with
string
code
string
code[]
Array of strings
createdAt[before]
string
createdAt[strictly_before]
string
createdAt[after]
string
createdAt[strictly_after]
string
createdDate[before]
string
createdDate[strictly_before]
string
createdDate[after]
string
createdDate[strictly_after]
string
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
deliveryTime_range[between]
string
deliveryTime_range[gt]
string
deliveryTime_range[gte]
string
deliveryTime_range[lt]
string
deliveryTime_range[lte]
string
deliveryTime
integer
deliveryTime[]
Array of integers
disabledAt[before]
string
disabledAt[strictly_before]
string
disabledAt[after]
string
disabledAt[strictly_after]
string
discount_range[between]
string
discount_range[gt]
string
discount_range[gte]
string
discount_range[lt]
string
discount_range[lte]
string
discount
string
discount[]
Array of strings
id_range[between]
string
id_range[gt]
string
id_range[gte]
string
id_range[lt]
string
id_range[lte]
string
id
integer
id[]
Array of integers
interestsOnPayment_range[between]
string
interestsOnPayment_range[gt]
string
interestsOnPayment_range[gte]
string
interestsOnPayment_range[lt]
string
interestsOnPayment_range[lte]
string
interestsOnPayment
string
interestsOnPayment[]
Array of strings
marketingSource
string
marketingSource[]
Array of strings
maxCredit_range[between]
string
maxCredit_range[gt]
string
maxCredit_range[gte]
string
maxCredit_range[lt]
string
maxCredit_range[lte]
string
maxCredit
integer
maxCredit[]
Array of integers
nbDaysPaymentDiscount_range[between]
string
nbDaysPaymentDiscount_range[gt]
string
nbDaysPaymentDiscount_range[gte]
string
nbDaysPaymentDiscount_range[lt]
string
nbDaysPaymentDiscount_range[lte]
string
nbDaysPaymentDiscount
integer
nbDaysPaymentDiscount[]
Array of integers
notes_end_with
string
notes_partial
string
notes_start_with
string
notes
string
notes[]
Array of strings
orderMaxAmount_range[between]
string
orderMaxAmount_range[gt]
string
orderMaxAmount_range[gte]
string
orderMaxAmount_range[lt]
string
orderMaxAmount_range[lte]
string
orderMaxAmount
string
orderMaxAmount[]
Array of strings
orderMinAmount_range[between]
string
orderMinAmount_range[gt]
string
orderMinAmount_range[gte]
string
orderMinAmount_range[lt]
string
orderMinAmount_range[lte]
string
orderMinAmount
string
orderMinAmount[]
Array of strings
partners
string
partners[]
Array of strings
paymentDiscount_range[between]
string
paymentDiscount_range[gt]
string
paymentDiscount_range[gte]
string
paymentDiscount_range[lt]
string
paymentDiscount_range[lte]
string
paymentDiscount
string
paymentDiscount[]
Array of strings
paymentTerms_end_with
string
paymentTerms_partial
string
paymentTerms_start_with
string
paymentTerms
string
paymentTerms[]
Array of strings
paymentTime_range[between]
string
paymentTime_range[gt]
string
paymentTime_range[gte]
string
paymentTime_range[lt]
string
paymentTime_range[lte]
string
paymentTime
integer
paymentTime[]
Array of integers
person
string
person[]
Array of strings
potential_range[between]
string
potential_range[gt]
string
potential_range[gte]
string
potential_range[lt]
string
potential_range[lte]
string
potential
string
potential[]
Array of strings
potentialNotes_end_with
string
potentialNotes_partial
string
potentialNotes_start_with
string
potentialNotes
string
potentialNotes[]
Array of strings
projectType
string
projectType[]
Array of strings
responsible
string
responsible[]
Array of strings
satisfaction_range[between]
string
satisfaction_range[gt]
string
satisfaction_range[gte]
string
satisfaction_range[lt]
string
satisfaction_range[lte]
string
satisfaction
string
satisfaction[]
Array of strings
satisfactionDate[before]
string
satisfactionDate[strictly_before]
string
satisfactionDate[after]
string
satisfactionDate[strictly_after]
string
satisfactionNotes_end_with
string
satisfactionNotes_partial
string
satisfactionNotes_start_with
string
satisfactionNotes
string
satisfactionNotes[]
Array of strings
shipper
string
shipper[]
Array of strings
slug_end_with
string
slug_partial
string
slug_start_with
string
slug
string
slug[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string
person.firstName
string
person.firstName[]
Array of strings
person.lastName
string
person.lastName[]
Array of strings

Responses

Response samples

Content type
{
  • "hydra:member": [
    ],
  • "hydra:totalItems": 0,
  • "hydra:view": {
    },
  • "hydra:search": {
    }
}

Creates a person_clients resource.

Creates a person_clients resource.

Authorizations:
JWT
Request Body schema:
required

The new person_clients resource

createdDate
required
string <date-time>
potential
required
string
potentialNotes
string or null
satisfaction
required
string
satisfactionNotes
string or null
satisfactionDate
string or null <date-time>
person_marketingsources.jsonld-add_post (object) or null
required
object (people.jsonld-add_post)

Get person.

discount
required
string
code
string or null
accountNumber
string or null
notes
string or null
paymentTerms
string or null
object (person_employees.jsonld-add_post)

Get responsible.

shipping_shippers.jsonld-add_post (object) or null
deliveryTime
integer
Default: 30
maxCredit
integer
paymentTime
integer or null
interestsOnPayment
required
string
paymentDiscount
required
string
nbDaysPaymentDiscount
integer
Default: 10
project_types.jsonld-add_post (object) or null

// @todo Review InversedBy, should be inversedBy client?

Array of objects (person_partners.jsonld-add_post)
Array of objects (product_productsellprices.jsonld-add_post)
orderMinAmount
string
orderMaxAmount
string or null
accountMaxAmount
string or null
deletedAt
string or null <date-time>
slug
required
string

DB Identifier

customData
Array of strings or null
disabledAt
string or null <date-time>

Responses

Request samples

Content type
{
  • "createdDate": "2019-08-24T14:15:22Z",
  • "potential": "string",
  • "potentialNotes": "string",
  • "satisfaction": "string",
  • "satisfactionNotes": "string",
  • "satisfactionDate": "2019-08-24T14:15:22Z",
  • "marketingSource": {
    },
  • "person": {
    },
  • "discount": "string",
  • "code": "string",
  • "accountNumber": "string",
  • "notes": "string",
  • "paymentTerms": "string",
  • "responsible": {
    },
  • "shipper": {
    },
  • "deliveryTime": 30,
  • "maxCredit": 0,
  • "paymentTime": 0,
  • "interestsOnPayment": "string",
  • "paymentDiscount": "string",
  • "nbDaysPaymentDiscount": 10,
  • "projectType": {
    },
  • "partners": [
    ],
  • "productSellPrices": [
    ],
  • "orderMinAmount": "string",
  • "orderMaxAmount": "string",
  • "accountMaxAmount": "string",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "slug": "string",
  • "customData": [
    ],
  • "disabledAt": "2019-08-24T14:15:22Z"
}

Response samples

Content type
{
  • "@context": "string",
  • "@id": "string",
  • "@type": "string",
  • "createdDate": "2019-08-24T14:15:22Z",
  • "potential": "string",
  • "potentialNotes": "string",
  • "satisfaction": "string",
  • "satisfactionNotes": "string",
  • "satisfactionDate": "2019-08-24T14:15:22Z",
  • "marketingSource": {
    },
  • "person": {
    },
  • "discount": "string",
  • "code": "string",
  • "accountNumber": "string",
  • "notes": "string",
  • "paymentTerms": "string",
  • "responsible": {
    },
  • "shipper": {
    },
  • "deliveryTime": 30,
  • "maxCredit": 0,
  • "paymentTime": 0,
  • "interestsOnPayment": "string",
  • "paymentDiscount": "string",
  • "nbDaysPaymentDiscount": 10,
  • "projectType": {
    },
  • "orderMinAmount": "string",
  • "orderMaxAmount": "string",
  • "accountMaxAmount": "string",
  • "owningCorporation": {
    },
  • "shortcode": "C",
  • "deletedAt": "2019-08-24T14:15:22Z",
  • "id": 0,
  • "slug": "string",
  • "customProperties": null,
  • "customData": [
    ],
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "disabledAt": "2019-08-24T14:15:22Z",
  • "toString": "string",
  • "anonymousToken": "string",
  • "projectsListing": "string",
  • "invoicesListing": "string",
  • "rentsListing": "string",
  • "clientRawNotes": null,
  • "partnersListing": "string",
  • "customPropertiesListing": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}