API docs by Redocly

PHPR API (3.7.0)

Download OpenAPI specification:

PHPR API USING API-PLATFORM

person_suppliers

Retrieves the collection of person_suppliers resources.

Retrieves the collection of person_suppliers 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[bills]
boolean
exists[products]
boolean
exists[notes]
boolean
exists[paymentTerms]
boolean
exists[responsible]
boolean
exists[socialReason]
boolean
exists[owner]
boolean
exists[fedTaxNumber]
boolean
exists[provTaxNumber]
boolean
exists[orderDay]
boolean
exists[fileTypes]
boolean
exists[code]
boolean
exists[accountNumber]
boolean
exists[paymentTime]
boolean
exists[shipper]
boolean
exists[deliveryFrequency]
boolean
exists[productBuyCosts]
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[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[notes]
string
Default: "asc"
Enum: "asc" "desc"
order[paymentTerms]
string
Default: "asc"
Enum: "asc" "desc"
order[socialReason]
string
Default: "asc"
Enum: "asc" "desc"
order[owner]
string
Default: "asc"
Enum: "asc" "desc"
order[fedTaxNumber]
string
Default: "asc"
Enum: "asc" "desc"
order[provTaxNumber]
string
Default: "asc"
Enum: "asc" "desc"
order[orderDay]
string
Default: "asc"
Enum: "asc" "desc"
order[fileTypes]
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[paymentTime]
string
Default: "asc"
Enum: "asc" "desc"
order[nbDaysPaymentDiscount]
string
Default: "asc"
Enum: "asc" "desc"
order[deliveryTime]
string
Default: "asc"
Enum: "asc" "desc"
order[deliveryFrequency]
string
Default: "asc"
Enum: "asc" "desc"
order[id]
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"
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
deletedAt[before]
string
deletedAt[strictly_before]
string
deletedAt[after]
string
deletedAt[strictly_after]
string
deliveryFrequency_range[between]
string
deliveryFrequency_range[gt]
string
deliveryFrequency_range[gte]
string
deliveryFrequency_range[lt]
string
deliveryFrequency_range[lte]
string
deliveryFrequency
integer
deliveryFrequency[]
Array of integers
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
fedTaxNumber_end_with
string
fedTaxNumber_partial
string
fedTaxNumber_start_with
string
fedTaxNumber
string
fedTaxNumber[]
Array of strings
fileTypes_end_with
string
fileTypes_partial
string
fileTypes_start_with
string
fileTypes
string
fileTypes[]
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
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
orderDay_end_with
string
orderDay_partial
string
orderDay_start_with
string
orderDay
string
orderDay[]
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
owner_end_with
string
owner_partial
string
owner_start_with
string
owner
string
owner[]
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
provTaxNumber_end_with
string
provTaxNumber_partial
string
provTaxNumber_start_with
string
provTaxNumber
string
provTaxNumber[]
Array of strings
responsible
string
responsible[]
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
socialReason_end_with
string
socialReason_partial
string
socialReason_start_with
string
socialReason
string
socialReason[]
Array of strings
updatedAt[before]
string
updatedAt[strictly_before]
string
updatedAt[after]
string
updatedAt[strictly_after]
string

Responses

Response samples

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

Creates a person_suppliers resource.

Creates a person_suppliers resource.

Authorizations:
JWT
Request Body schema:
required

The new person_suppliers resource

required
object (people.jsonld-add_post)

Get person.

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

Get responsible.

socialReason
string or null
owner
string or null
fedTaxNumber
string or null
provTaxNumber
string or null
orderDay
string or null
fileTypes
string or null
code
string or null
accountNumber
string or null
paymentTime
integer or null
interestsOnPayment
required
string
paymentDiscount
required
string
nbDaysPaymentDiscount
integer
Default: 10
shipping_shippers.jsonld-add_post (object) or null
deliveryTime
integer
Default: 30
deliveryFrequency
integer or null
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
{
  • "person": {
    },
  • "discount": "string",
  • "notes": "string",
  • "paymentTerms": "string",
  • "responsible": {
    },
  • "socialReason": "string",
  • "owner": "string",
  • "fedTaxNumber": "string",
  • "provTaxNumber": "string",
  • "orderDay": "string",
  • "fileTypes": "string",
  • "code": "string",
  • "accountNumber": "string",
  • "paymentTime": 0,
  • "interestsOnPayment": "string",
  • "paymentDiscount": "string",
  • "nbDaysPaymentDiscount": 10,
  • "shipper": {
    },
  • "deliveryTime": 30,
  • "deliveryFrequency": 0,
  • "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",
  • "person": {
    },
  • "discount": "string",
  • "notes": "string",
  • "paymentTerms": "string",
  • "responsible": {
    },
  • "socialReason": "string",
  • "owner": "string",
  • "fedTaxNumber": "string",
  • "provTaxNumber": "string",
  • "orderDay": "string",
  • "fileTypes": "string",
  • "code": "string",
  • "accountNumber": "string",
  • "paymentTime": 0,
  • "interestsOnPayment": "string",
  • "paymentDiscount": "string",
  • "nbDaysPaymentDiscount": 10,
  • "shipper": {
    },
  • "deliveryTime": 30,
  • "deliveryFrequency": 0,
  • "owningCorporation": {
    },
  • "orderMinAmount": "string",
  • "orderMaxAmount": "string",
  • "accountMaxAmount": "string",
  • "shortcode": "F",
  • "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": 0,
  • "billsListing": "string",
  • "productsListing": "string",
  • "customPropertiesListing": "string",
  • "anonymousToken": "string",
  • "uniqueId": "string",
  • "taggingListing": "string",
  • "enabled": true,
  • "disabled": true
}