docs.jsonld
type: ApiDocumentation
title: Glinko
entrypoint: /api
supported class: Zone
supported class: PriceSpecification
supported class: Tender
supported class: CompanyCustomPage
supported class: Accountant
supported class: Company
supported class: CompanyCourier
supported class: CompanyDepartmentAssignation
supported class: CustomPage
supported class: CustomPageUser
supported class: Delivery
supported class: DeliveryTemplate
supported class: Department
supported class: Document
supported class: File
supported class: FreightForwarder
supported class: Hub
supported class: IndependentCourier
supported class: InvoicingGroup
supported class: InvoicingSummary
supported class: Manager
supported class: CustomPageAdvancedSettings
supported class: LoginCustomPage
supported class: WaypointUpdateEstimatedTimeOfArrival
supported class: Operator
supported class: Parameter
supported class: Ride
supported class: Scenario
supported class: StateLog
supported class: Thread
supported class: UnreadMessage
supported class: User
supported class: Vehicle
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

Zone
type: Class
title: Zone
supported property: SupportedProperty
  property: values
  title: values
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Zone resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Zone resource.
  returns: Zone
supported operation: Replaces the Zone resource.
  type: Operation
  type: ReplaceAction
  expects: Zone
  method: PUT
  title: Replaces the Zone resource.
  returns: Zone

values
type: Property
domain: Zone
range: string

name
type: Property
domain: Zone
range: string

PriceSpecification
type: Class
title: PriceSpecification
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: description
  title: description
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: allowance1MaxMileage
  title: allowance1MaxMileage
  required: false
  readable: true
  writeable: true
  description: Max mileage in kilometers.
supported property: SupportedProperty
  property: allowance1FlatPrice
  title: allowance1FlatPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: allowance2MaxMileage
  title: allowance2MaxMileage
  required: false
  readable: true
  writeable: true
  description: Max mileage in kilometers.
supported property: SupportedProperty
  property: allowance2FlatPrice
  title: allowance2FlatPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: allowance3MaxMileage
  title: allowance3MaxMileage
  required: false
  readable: true
  writeable: true
  description: Max mileage in kilometers.
supported property: SupportedProperty
  property: allowance3FlatPrice
  title: allowance3FlatPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: allowance4MaxMileage
  title: allowance4MaxMileage
  required: false
  readable: true
  writeable: true
  description: Max mileage in kilometers.
supported property: SupportedProperty
  property: allowance4Rate
  title: allowance4Rate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: allowance5MaxMileage
  title: allowance5MaxMileage
  required: false
  readable: true
  writeable: true
  description: Max mileage in kilometers.
supported property: SupportedProperty
  property: allowance5FlatPrice
  title: allowance5FlatPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: allowance6Rate
  title: allowance6Rate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  title: allowance6CeilingPrice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: flatPrice
  title: flatPrice
  required: false
  readable: true
  writeable: true
  description: If this price is provided, no calculation is performed and this amount is always used.
supported property: SupportedProperty
  property: pickupTimeLimit
  title: pickupTimeLimit
  required: false
  readable: true
  writeable: true
  description: Time in minutes.
supported property: SupportedProperty
  property: tailgateGuaranteed
  title: tailgateGuaranteed
  required: false
  readable: true
  writeable: true
  description: Price guaranteed if tailgate.
supported property: SupportedProperty
  property: notWorkingDayRate
  title: notWorkingDayRate
  required: false
  readable: true
  writeable: true
  description: Apply this rate when delivery is created on a not worked day (weekend or holiday).
supported property: SupportedProperty
  property: eveningDepartment
  title: eveningDepartment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: proposal
  title: proposal
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fastProposalShortRangeRate
  title: fastProposalShortRangeRate
  required: false
  readable: true
  writeable: true
  description: Rate to apply to a fast proposal when the mileage is between allowance3MaxMileage and allowance5MaxMileage.
supported property: SupportedProperty
  property: fastProposalLongRangeRate
  title: fastProposalLongRangeRate
  required: false
  readable: true
  writeable: true
  description: Rate to apply to a fast proposal when the mileage is greater or equal to allowance5MaxMileage.
supported property: SupportedProperty
  property: postalCodesNotGuaranteed
  title: postalCodesNotGuaranteed
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a PriceSpecification resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a PriceSpecification resource.
  returns: PriceSpecification
supported operation: Replaces the PriceSpecification resource.
  type: Operation
  type: ReplaceAction
  expects: PriceSpecification
  method: PUT
  title: Replaces the PriceSpecification resource.
  returns: PriceSpecification

name
type: Property
domain: PriceSpecification
range: string

description
type: Property
domain: PriceSpecification
range: string

allowance1MaxMileage
type: Property
domain: PriceSpecification
range: integer

allowance1FlatPrice
type: Property
domain: PriceSpecification
range: integer

allowance2MaxMileage
type: Property
domain: PriceSpecification
range: integer

allowance2FlatPrice
type: Property
domain: PriceSpecification
range: integer

allowance3MaxMileage
type: Property
domain: PriceSpecification
range: integer

allowance3FlatPrice
type: Property
domain: PriceSpecification
range: integer

allowance4MaxMileage
type: Property
domain: PriceSpecification
range: integer

allowance4Rate
type: Property
domain: PriceSpecification
range: decimal

allowance5MaxMileage
type: Property
domain: PriceSpecification
range: integer

allowance5FlatPrice
type: Property
domain: PriceSpecification
range: integer

allowance6Rate
type: Property
domain: PriceSpecification
range: decimal

allowance6CeilingPrice
type: Property
domain: PriceSpecification
range: integer

flatPrice
type: Property
domain: PriceSpecification
range: integer

pickupTimeLimit
type: Property
domain: PriceSpecification
range: integer

tailgateGuaranteed
type: Property
domain: PriceSpecification
range: string

notWorkingDayRate
type: Property
domain: PriceSpecification
range: decimal

eveningDepartment
type: Link
domain: PriceSpecification
max cardinality: 1
range: Zone

proposal
type: Property
domain: PriceSpecification
range: string

fastProposalShortRangeRate
type: Property
domain: PriceSpecification
range: decimal

fastProposalLongRangeRate
type: Property
domain: PriceSpecification
range: decimal

postalCodesNotGuaranteed
type: Property
domain: PriceSpecification
range: string

Tender
type: Class
title: Tender
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priceSpecificationT1
  title: priceSpecificationT1
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priceSpecificationT2
  title: priceSpecificationT2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: priceSpecificationT3
  title: priceSpecificationT3
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: departments
  title: departments
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Tender resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Tender resource.
  returns: Tender
supported operation: Replaces the Tender resource.
  type: Operation
  type: ReplaceAction
  expects: Tender
  method: PUT
  title: Replaces the Tender resource.
  returns: Tender
supported operation: Deletes the Tender resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Tender resource.
  returns: Nothing

name
type: Property
domain: Tender
range: string

priceSpecificationT1
type: Link
domain: Tender
max cardinality: 1
range: PriceSpecification

priceSpecificationT2
type: Link
domain: Tender
max cardinality: 1
range: PriceSpecification

priceSpecificationT3
type: Link
domain: Tender
max cardinality: 1
range: PriceSpecification

departments
type: Property
domain: Tender
range: string

CompanyCustomPage
type: Class
title: CompanyCustomPage
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a CompanyCustomPage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CompanyCustomPage resource.
  returns: Nothing

id
type: Property
domain: CompanyCustomPage
range: integer

enabled
type: Property
domain: CompanyCustomPage
range: boolean

slug
type: Property
domain: CompanyCustomPage
range: string

company
type: Link
domain: CompanyCustomPage
max cardinality: 1
range: Company

Accountant
type: Class
title: Accountant
supported property: SupportedProperty
  property: managedCompany
  title: managedCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: courierOfCompany
  title: courierOfCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: PHP will cast strings like “06…” to integers Numbers like “+336…” will already be typed as strings So it can be a string or an integer internally.
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
  description: The below length depends on the "algorithm" you use for encoding the password, but this works well with bcrypt.
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: termsOfUseAccepted
  title: termsOfUseAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: confirmationToken
  title: confirmationToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailConfirmed
  title: emailConfirmed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: passwordResetToken
  title: passwordResetToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docKbisExtract
  title: docKbisExtract
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountStatus
  title: accountStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountValidationRequested
  title: accountValidationRequested
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountRejectedMessage
  title: accountRejectedMessage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: newEmailConfirmationToken
  title: newEmailConfirmationToken
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: newEmail
  title: newEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: newPhoneNumConfirmationToken
  title: newPhoneNumConfirmationToken
  required: false
  readable: false
  writeable: false
  description: “$newPhoneNumberConfirmationToken” shortened for PHPMD.
supported property: SupportedProperty
  property: newPhoneNumber
  title: newPhoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNewDeliveryEmail
  title: sendNewDeliveryEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deletedAt
  title: deletedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: isSyncedToHubSpot
  title: isSyncedToHubSpot
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docTransportLicense
  title: docTransportLicense
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docUrssafAttestation
  title: docUrssafAttestation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docMerchandiseInsurance
  title: docMerchandiseInsurance
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docIdentityCard
  title: docIdentityCard
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docCompanyStatus
  title: docCompanyStatus
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Accountant resource.

managedCompany
type: Link
domain: Accountant
max cardinality: 1
range: Company

courierOfCompany
type: Link
domain: Accountant
max cardinality: 1
range: Company

state
type: Property
domain: Accountant

firstname
type: Property
domain: Accountant
range: string

lastname
type: Property
domain: Accountant
range: string

email
type: Property
domain: Accountant
range: string

phoneNumber
type: Property
domain: Accountant
range: string

password
type: Property
domain: Accountant
range: string

plainPassword
type: Property
domain: Accountant
range: string

roles
type: Property
domain: Accountant

termsOfUseAccepted
type: Property
domain: Accountant
range: boolean

confirmationToken
type: Property
domain: Accountant
range: string

emailConfirmed
type: Property
domain: Accountant
range: boolean

passwordResetToken
type: Property
domain: Accountant

docKbisExtract
type: Link
domain: Accountant
max cardinality: 1
range: Document

accountStatus
type: Property
domain: Accountant
range: string

accountValidationRequested
type: Property
domain: Accountant
range: boolean

accountRejectedMessage
type: Property
domain: Accountant
range: string

newEmailConfirmationToken
type: Property
domain: Accountant

newEmail
type: Property
domain: Accountant
range: string

newPhoneNumConfirmationToken
type: Property
domain: Accountant

newPhoneNumber
type: Property
domain: Accountant
range: string

sendNewDeliveryEmail
type: Property
domain: Accountant
range: boolean

createdAt
type: Property
domain: Accountant
range: dateTime

updatedAt
type: Property
domain: Accountant
range: dateTime

deletedAt
type: Property
domain: Accountant
range: dateTime

isSyncedToHubSpot
type: Property
domain: Accountant
range: boolean

company
type: Link
domain: Accountant
max cardinality: 1
range: Company

docTransportLicense
type: Link
domain: Accountant
max cardinality: 1
range: Document

docUrssafAttestation
type: Link
domain: Accountant
max cardinality: 1
range: Document

docMerchandiseInsurance
type: Link
domain: Accountant
max cardinality: 1
range: Document

docIdentityCard
type: Link
domain: Accountant
max cardinality: 1
range: Document

docCompanyStatus
type: Link
domain: Accountant
max cardinality: 1
range: Document

docConcealedWork
type: Link
domain: Accountant
max cardinality: 1
range: Document

docLiabilityInsurance
type: Link
domain: Accountant
max cardinality: 1
range: Document

uploadedRequiredDocuments
type: Property
domain: Accountant
range: boolean

requiredDocuments
type: Property
domain: Accountant

optionalDocuments
type: Property
domain: Accountant

deliveriesAsCompanyCourierStart
type: Link
domain: Accountant
range: Delivery

deliveriesAsCompanyCourierFinish
type: Link
domain: Accountant
range: Delivery

deliveryRefusals
type: Property
domain: Accountant

deliveryRejected
type: Property
domain: Accountant

counterOffersStart
type: Property
domain: Accountant

counterOffersFinish
type: Property
domain: Accountant

ridesStart
type: Link
domain: Accountant
range: Ride

ridesFinish
type: Link
domain: Accountant
range: Ride

availableDeliveries
type: Link
domain: Accountant
range: Delivery

stateOrCreate
type: Property
domain: Accountant

contactForDelivery
type: Link
domain: Accountant
max cardinality: 1
range: User

counterOffersStartFinish
type: Property
domain: Accountant

deliveriesAsFreightForwarder
type: Link
domain: Accountant
range: Delivery

deliveriesAsCustomer
type: Link
domain: Accountant
range: Delivery

heartBeatAt
type: Property
domain: Accountant
range: dateTime

hubSpotId
type: Property
domain: Accountant
range: string

fullName
type: Property
domain: Accountant
range: string

type
type: Property
domain: Accountant
range: string

salt
type: Property
domain: Accountant
range: string

username
type: Property
domain: Accountant
range: string

passwordResetTokenOrCreate
type: Property
domain: Accountant

accountStatusPending
type: Property
domain: Accountant

accountStatusRejected
type: Property
domain: Accountant

accountStatusAccepted
type: Property
domain: Accountant

accountStatusDisabled
type: Property
domain: Accountant

newEmailConfirmationTokenOrCreate
type: Property
domain: Accountant

newPhoneNumberConfirmationToken
type: Property
domain: Accountant

newPhoneNumberConfirmationTokenOrCreate
type: Property
domain: Accountant

deleted
type: Property
domain: Accountant
range: boolean

syncedToHubSpot
type: Property
domain: Accountant
range: boolean

Company
type: Class
title: Company
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: vatIdentificationNumber
  title: vatIdentificationNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: streetAddress
  title: streetAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: additionalAddress
  title: additionalAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: postalCode
  title: postalCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: city
  title: city
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: country
  title: country
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sponsorshipCode
  title: sponsorshipCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: managers
  title: managers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: couriers
  title: couriers
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: vehicles
  title: vehicles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: statute
  title: statute
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeProofOfIdentity
  title: legalRepresentativeProofOfIdentity
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: proofOfRegistration
  title: proofOfRegistration
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: shareholderDeclaration
  title: shareholderDeclaration
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeFirstName
  title: legalRepresentativeFirstName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeLastName
  title: legalRepresentativeLastName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeBirthDay
  title: legalRepresentativeBirthDay
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeNationality
  title: legalRepresentativeNationality
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeCountryOfResidence
  title: legalRepresentativeCountryOfResidence
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeEmail
  title: legalRepresentativeEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeStreetAddress
  title: legalRepresentativeStreetAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeAdditionalStreetAddress
  title: legalRepresentativeAdditionalStreetAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativePostalCode
  title: legalRepresentativePostalCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeCity
  title: legalRepresentativeCity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: legalRepresentativeCountry
  title: legalRepresentativeCountry
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headquartersStreetAddress
  title: headquartersStreetAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headquartersAdditionalStreetAddress
  title: headquartersAdditionalStreetAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headquartersPostalCode
  title: headquartersPostalCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headquartersCity
  title: headquartersCity
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: headquartersCountry
  title: headquartersCountry
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: iban
  title: iban
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Company resource.
supported operation: Replaces the Company resource.
supported operation: Creates a Company resource.

name
type: Property
domain: Company
range: string

email
type: Property
domain: Company
range: string

vatIdentificationNumber
type: Property
domain: Company
range: string

streetAddress
type: Property
domain: Company
range: string

additionalAddress
type: Property
domain: Company
range: string

postalCode
type: Property
domain: Company
range: string

city
type: Property
domain: Company
range: string

country
type: Property
domain: Company
range: string

sponsorshipCode
type: Property
domain: Company
range: string

managers
type: Property
domain: Company
range: User

couriers
type: Property
domain: Company
range: CompanyCourier

vehicles
type: Link
domain: Company
range: Vehicle

statute
type: Property
domain: Company
range: string

legalRepresentativeProofOfIdentity
type: Property
domain: Company
range: string

proofOfRegistration
type: Property
domain: Company
range: string

shareholderDeclaration
type: Property
domain: Company
range: string

legalRepresentativeFirstName
type: Property
domain: Company
range: string

legalRepresentativeLastName
type: Property
domain: Company
range: string

legalRepresentativeBirthDay
type: Property
domain: Company
range: string

legalRepresentativeNationality
type: Property
domain: Company
range: string

legalRepresentativeCountryOfResidence
type: Property
domain: Company
range: string

legalRepresentativeEmail
type: Property
domain: Company
range: string

legalRepresentativeStreetAddress
type: Property
domain: Company
range: string

legalRepresentativeAdditionalStreetAddress
type: Property
domain: Company
range: string

legalRepresentativePostalCode
type: Property
domain: Company
range: string

legalRepresentativeCity
type: Property
domain: Company
range: string

legalRepresentativeCountry
type: Property
domain: Company
range: string

headquartersStreetAddress
type: Property
domain: Company
range: string

headquartersAdditionalStreetAddress
type: Property
domain: Company
range: string

headquartersPostalCode
type: Property
domain: Company
range: string

headquartersCity
type: Property
domain: Company
range: string

headquartersCountry
type: Property
domain: Company
range: string

iban
type: Property
domain: Company
range: string

bankInformationFullName
type: Property
domain: Company
range: string

bankInformationStreetAddress
type: Property
domain: Company
range: string

bankInformationAdditionalStreetAddress
type: Property
domain: Company
range: string

bankInformationPostalCode
type: Property
domain: Company
range: string

bankInformationCity
type: Property
domain: Company
range: string

bankInformationCountry
type: Property
domain: Company
range: string

mangoMandateStatus
type: Property
domain: Company
range: string

mangoMandateUrl
type: Property
domain: Company
range: string

disabledAt
type: Property
domain: Company
range: dateTime

customPage
type: Property
domain: Company
max cardinality: 1
range: CustomPage

allDepartments
type: Property
domain: Company

bankInformationComplete
type: Property
domain: Company
range: boolean

CompanyCourier
type: Class
title: CompanyCourier
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: PHP will cast strings like “06…” to integers Numbers like “+336…” will already be typed as strings So it can be a string or an integer internally.
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: termsOfUseAccepted
  title: termsOfUseAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailConfirmed
  title: emailConfirmed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docKbisExtract
  title: docKbisExtract
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountStatus
  title: accountStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountValidationRequested
  title: accountValidationRequested
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountRejectedMessage
  title: accountRejectedMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: courierOfCompany
  title: courierOfCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNewDeliveryEmail
  title: sendNewDeliveryEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a CompanyCourier resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CompanyCourier resource.
  returns: CompanyCourier
supported operation: Replaces the CompanyCourier resource.
  type: Operation
  type: ReplaceAction
  expects: CompanyCourier
  method: PUT
  title: Replaces the CompanyCourier resource.
  returns: CompanyCourier
supported operation: Retrieves a CompanyCourier resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CompanyCourier resource.
  returns: CompanyCourier
supported operation: Retrieves a CompanyCourier resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CompanyCourier resource.
  returns: CompanyCourier
supported operation: Replaces the CompanyCourier resource.
  type: Operation
  type: ReplaceAction
  expects: CompanyCourier
  method: PUT
  title: Replaces the CompanyCourier resource.
  returns: CompanyCourier
supported operation: Retrieves a CompanyCourier resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CompanyCourier resource.
  returns: CompanyCourier

state
type: Property
domain: CompanyCourier

firstname
type: Property
domain: CompanyCourier
range: string

lastname
type: Property
domain: CompanyCourier
range: string

email
type: Property
domain: CompanyCourier
range: string

phoneNumber
type: Property
domain: CompanyCourier
range: string

plainPassword
type: Property
domain: CompanyCourier
range: string

termsOfUseAccepted
type: Property
domain: CompanyCourier
range: boolean

emailConfirmed
type: Property
domain: CompanyCourier
range: boolean

docKbisExtract
type: Property
domain: CompanyCourier
max cardinality: 1
range: Document

accountStatus
type: Property
domain: CompanyCourier
range: string

accountValidationRequested
type: Property
domain: CompanyCourier
range: boolean

accountRejectedMessage
type: Property
domain: CompanyCourier
range: string

courierOfCompany
type: Property
domain: CompanyCourier
max cardinality: 1
range: Company

sendNewDeliveryEmail
type: Property
domain: CompanyCourier
range: boolean

createdAt
type: Property
domain: CompanyCourier
range: dateTime

updatedAt
type: Property
domain: CompanyCourier
range: dateTime

CompanyDepartmentAssignation
type: Class
title: CompanyDepartmentAssignation
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: department
  title: department
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: meanPrice
  title: meanPrice
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a CompanyDepartmentAssignation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CompanyDepartmentAssignation resource.
  returns: CompanyDepartmentAssignation
supported operation: Replaces the CompanyDepartmentAssignation resource.
  type: Operation
  type: ReplaceAction
  expects: CompanyDepartmentAssignation
  method: PUT
  title: Replaces the CompanyDepartmentAssignation resource.
  returns: CompanyDepartmentAssignation
supported operation: Deletes the CompanyDepartmentAssignation resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the CompanyDepartmentAssignation resource.
  returns: Nothing

company
type: Link
domain: CompanyDepartmentAssignation
max cardinality: 1
range: Company

department
type: Link
domain: CompanyDepartmentAssignation
max cardinality: 1
range: Department

meanPrice
type: Property
domain: CompanyDepartmentAssignation
range: integer

CustomPage
type: Class
title: CustomPage
supported property: SupportedProperty
  property: enabled
  title: enabled
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: slug
  title: slug
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: backgroundColor
  title: backgroundColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: buttonColor
  title: buttonColor
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recipientEmail
  title: recipientEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: collectionDelayT1
  title: collectionDelayT1
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: collectionDelayT2
  title: collectionDelayT2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: collectionDelayT3
  title: collectionDelayT3
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: users
  title: users
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: backgroundImage
  title: backgroundImage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: backgroundImagePath
  title: backgroundImagePath
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: backgroundImageUrl
  title: backgroundImageUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: logo
  title: logo
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: logoPath
  title: logoPath
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: logoUrl
  title: logoUrl
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: departments
  title: departments
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: morningTimeSlotAvailable
  title: morningTimeSlotAvailable
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: morningTimeSlotStart
  title: morningTimeSlotStart
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: morningTimeSlotEnd
  title: morningTimeSlotEnd
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: afternoonTimeSlotAvailable
  title: afternoonTimeSlotAvailable
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: afternoonTimeSlotStart
  title: afternoonTimeSlotStart
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: afternoonTimeSlotEnd
  title: afternoonTimeSlotEnd
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a CustomPage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CustomPage resource.
  returns: CustomPage
supported operation: Updates the CustomPage resource.
  type: Operation
  expects: CustomPage
  method: PATCH
  title: Updates the CustomPage resource.
  returns: CustomPage
supported operation: Replaces the CustomPage resource.
  type: Operation
  type: ReplaceAction
  expects: CustomPage
  method: PUT
  title: Replaces the CustomPage resource.
  returns: CustomPage
supported operation: Creates a CustomPage resource.
  type: Operation
  type: CreateAction
  expects: CustomPage
  method: POST
  title: Creates a CustomPage resource.
  returns: CustomPage

enabled
type: Property
domain: CustomPage
range: boolean

slug
type: Property
domain: CustomPage
range: string

backgroundColor
type: Property
domain: CustomPage
range: string

buttonColor
type: Property
domain: CustomPage
range: string

recipientEmail
type: Property
domain: CustomPage
range: string
label: email
domain: Hub
domain: CustomPageAdvancedSettings

collectionDelayT1
type: Property
domain: CustomPage
range: integer

collectionDelayT2
type: Property
domain: CustomPage
range: integer

collectionDelayT3
type: Property
domain: CustomPage
range: integer

company
type: Link
domain: CustomPage
max cardinality: 1
range: Company

users
type: Link
domain: CustomPage
range: CustomPageUser

backgroundImage
type: Property
domain: CustomPage

backgroundImagePath
type: Property
domain: CustomPage
range: string

backgroundImageUrl
type: Property
domain: CustomPage
range: string

logo
type: Property
domain: CustomPage

logoPath
type: Property
domain: CustomPage
range: string

logoUrl
type: Property
domain: CustomPage
range: string

updatedAt
type: Property
domain: CustomPage
range: dateTime

departments
type: Link
domain: CustomPage
range: Department

morningTimeSlotAvailable
type: Property
domain: CustomPage
range: boolean

morningTimeSlotStart
type: Property
domain: CustomPage
range: string

morningTimeSlotEnd
type: Property
domain: CustomPage
range: string

afternoonTimeSlotAvailable
type: Property
domain: CustomPage
range: boolean

afternoonTimeSlotStart
type: Property
domain: CustomPage
range: string

afternoonTimeSlotEnd
type: Property
domain: CustomPage
range: string

CustomPageUser
type: Class
title: CustomPageUser
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: companyName
  title: companyName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: active
  title: active
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: t1shortRangeRate
  title: t1shortRangeRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: t2shortRangeRate
  title: t2shortRangeRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: t3shortRangeRate
  title: t3shortRangeRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: t1longRangeRate
  title: t1longRangeRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: t2longRangeRate
  title: t2longRangeRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: t3longRangeRate
  title: t3longRangeRate
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customPage
  title: customPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: salt
  title: salt
  required: false
  readable: true
  writeable: false
  description: Returns the salt that was originally used to encode the password.
supported property: SupportedProperty
  property: username
  title: username
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a CustomPageUser resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CustomPageUser resource.
  returns: CustomPageUser
supported operation: Updates the CustomPageUser resource.
  type: Operation
  expects: CustomPageUser
  method: PATCH
  title: Updates the CustomPageUser resource.
  returns: CustomPageUser
supported operation: Creates a CustomPageUser resource.
  type: Operation
  type: CreateAction
  expects: CustomPageUser
  method: POST
  title: Creates a CustomPageUser resource.
  returns: CustomPageUser

firstname
type: Property
domain: CustomPageUser
range: string

lastname
type: Property
domain: CustomPageUser
range: string

email
type: Property
domain: CustomPageUser
range: string

plainPassword
type: Property
domain: CustomPageUser
range: string

phoneNumber
type: Property
domain: CustomPageUser
range: string

companyName
type: Property
domain: CustomPageUser
range: string

active
type: Property
domain: CustomPageUser
range: boolean

t1shortRangeRate
type: Property
domain: CustomPageUser
range: integer

t2shortRangeRate
type: Property
domain: CustomPageUser
range: integer

t3shortRangeRate
type: Property
domain: CustomPageUser
range: integer

t1longRangeRate
type: Property
domain: CustomPageUser
range: integer

t2longRangeRate
type: Property
domain: CustomPageUser
range: integer

t3longRangeRate
type: Property
domain: CustomPageUser
range: integer

customPage
type: Link
domain: CustomPageUser
max cardinality: 1
range: CustomPage

salt
type: Property
domain: CustomPageUser
range: string

username
type: Property
domain: CustomPageUser
range: string

type
type: Property
domain: CustomPageUser
range: string

fullName
type: Property
domain: CustomPageUser
range: string

Delivery
type: Class
title: Delivery
supported property: SupportedProperty
  property: realCourierPriceWithVat
  title: realCourierPriceWithVat
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: companyCourierStart
  title: companyCourierStart
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: companyCourierFinish
  title: companyCourierFinish
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: adjustedPrice
  title: adjustedPrice
  required: false
  readable: true
  writeable: false
  description: Adjusted price in cents for FreightForwarder.
supported property: SupportedProperty
  property: maximalCourierPrice
  title: maximalCourierPrice
  required: false
  readable: true
  writeable: false
  description: Maximal price for Courier.
supported property: SupportedProperty
  property: realPrice
  title: realPrice
  required: false
  readable: true
  writeable: false
  description: Real price in cents for FreightForwarder.
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: false
  description: Workflow current state.
supported property: SupportedProperty
  property: operatorState
  title: operatorState
  required: false
  readable: true
  writeable: false
  description: Workflow current state.
supported property: SupportedProperty
  property: timeoutNoCourierFoundEvents
  title: timeoutNoCourierFoundEvents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: requestSearchEvents
  title: requestSearchEvents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: submitEvent
  title: submitEvent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: confirmationEvent
  title: confirmationEvent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: startEvent
  title: startEvent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: pickupEvent
  title: pickupEvent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: receiptEvent
  title: receiptEvent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: majorIncidentEvents
  title: majorIncidentEvents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: delayEvents
  title: delayEvents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: pickupEvents
  title: pickupEvents
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cancellation
  title: cancellation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: pickupUnexpectedHandlingEvent
  title: pickupUnexpectedHandlingEvent
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: cancellationAfterMajorIncidentEvent
  title: cancellationAfterMajorIncidentEvent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: receiptEvents
  title: receiptEvents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: receiptUnexpectedHandlingEvent
  title: receiptUnexpectedHandlingEvent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: acceptEvent
  title: acceptEvent
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: invoiceFilename
  title: invoiceFilename
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: reference
  title: reference
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: ecmr
  title: ecmr
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updateMessage
  title: updateMessage
  required: false
  readable: false
  writeable: true
  description: Not persisted, only used when the Operator send messages.
supported property: SupportedProperty
  property: updateMessageMail
  title: updateMessageMail
  required: false
  readable: false
  writeable: true
  description: Not persisted, only used when the Operator send messages.
supported property: SupportedProperty
  property: updateMessageChat
  title: updateMessageChat
  required: false
  readable: false
  writeable: true
  description: Not persisted, only used when the Operator send messages.
supported property: SupportedProperty
  property: freightForwarder
  title: freightForwarder
  required: false
  readable: true
  writeable: false
  description: FreightForwarder and Manager can create deliveries.
supported property: SupportedProperty
  property: merchandise
  title: merchandise
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Delivery resource.
supported operation: Updates the Delivery resource.
supported operation: Replaces the Delivery resource.
supported operation: Creates a Delivery resource.

realCourierPriceWithVat
type: Property
domain: Delivery
range: integer

companyCourierStart
type: Property
domain: Delivery
max cardinality: 1
range: CompanyCourier

companyCourierFinish
type: Property
domain: Delivery
max cardinality: 1
range: CompanyCourier

adjustedPrice
type: Property
domain: Delivery
range: integer

maximalCourierPrice
type: Property
domain: Delivery
range: integer

realPrice
type: Property
domain: Delivery
range: integer

state
type: Property
domain: Delivery
range: string

operatorState
type: Property
domain: Delivery
range: string

timeoutNoCourierFoundEvents
type: Property
domain: Delivery

requestSearchEvents
type: Property
domain: Delivery

submitEvent
type: Property
domain: Delivery

confirmationEvent
type: Property
domain: Delivery

startEvent
type: Property
domain: Delivery

pickupEvent
type: Property
domain: Delivery

receiptEvent
type: Property
domain: Delivery

majorIncidentEvents
type: Property
domain: Delivery

delayEvents
type: Property
domain: Delivery

pickupEvents
type: Property
domain: Delivery

cancellation
type: Property
domain: Delivery

pickupUnexpectedHandlingEvent
type: Property
domain: Delivery

cancellationAfterMajorIncidentEvent
type: Property
domain: Delivery

receiptEvents
type: Property
domain: Delivery

receiptUnexpectedHandlingEvent
type: Property
domain: Delivery

acceptEvent
type: Property
domain: Delivery

invoiceFilename
type: Property
domain: Delivery
range: string

reference
type: Property
domain: Delivery
range: string

ecmr
type: Property
domain: Delivery
range: boolean

updateMessage
type: Property
domain: Delivery
range: string

updateMessageMail
type: Property
domain: Delivery
range: boolean

updateMessageChat
type: Property
domain: Delivery
range: boolean

freightForwarder
type: Property
domain: Delivery
max cardinality: 1
range: User

merchandise
type: Property
domain: Delivery

vehicleType
type: Property
domain: Delivery
range: string

vehicleLoadType
type: Property
domain: Delivery
range: string

transportRules
type: Property
domain: Delivery

options
type: Property
domain: Delivery

pickupWaypoints
type: Property
domain: Delivery

receiptWaypoints
type: Property
domain: Delivery

receiptComment
type: Property
domain: Delivery
range: string

mileage
type: Property
domain: Delivery
range: integer

estimatedPrice
type: Property
domain: Delivery
range: integer

estimatedCourierPrice
type: Property
domain: Delivery
range: integer

scheduled
type: Property
domain: Delivery
range: boolean

name
type: Property
domain: Delivery
range: string

guaranteedPrice
type: Property
domain: Delivery
range: boolean

guaranteedPriceErrors
type: Property
domain: Delivery

operatorValidated
type: Property
domain: Delivery
range: boolean

createdAt
type: Property
domain: Delivery
range: dateTime

updatedAt
type: Property
domain: Delivery
range: dateTime

template
type: Link
domain: Delivery
max cardinality: 1
range: DeliveryTemplate

tender
type: Property
domain: Delivery
range: string

openProposalPrice
type: Property
domain: Delivery
range: boolean

hasCounterOffer
type: Property
domain: Delivery
range: boolean

estimatedDuration
type: Property
domain: Delivery
range: integer

proposalType
type: Property
domain: Delivery
range: string

nameForCourier
type: Property
domain: Delivery
range: string

DeliveryTemplate
type: Class
title: DeliveryTemplate
supported property: SupportedProperty
  property: estimatedPrice
  title: estimatedPrice
  required: false
  readable: true
  writeable: false
  description: Estimated price in cents for FreightForwarder.
supported property: SupportedProperty
  property: freightForwarder
  title: freightForwarder
  required: false
  readable: true
  writeable: false
  description: FreightForwarder and Manager can create deliveries.
supported property: SupportedProperty
  property: merchandise
  title: merchandise
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: vehicleType
  title: vehicleType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: vehicleLoadType
  title: vehicleLoadType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: transportRules
  title: transportRules
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: options
  title: options
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: pickupWaypoints
  title: pickupWaypoints
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: receiptWaypoints
  title: receiptWaypoints
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: receiptComment
  title: receiptComment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: mileage
  title: mileage
  required: false
  readable: true
  writeable: true
  description: Mileage in meters.
supported property: SupportedProperty
  property: estimatedCourierPrice
  title: estimatedCourierPrice
  required: false
  readable: true
  writeable: false
  description: Estimated price in cents for Courier.
supported property: SupportedProperty
  property: scheduled
  title: scheduled
  required: false
  readable: true
  writeable: false
  description: All deliveries will be scheduled by default, the deliveries created before this change won't be altered
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: guaranteedPrice
  title: guaranteedPrice
  required: false
  readable: true
  writeable: false
  description: This value is used during estimation and is not persisted.
supported property: SupportedProperty
  property: guaranteedPriceErrors
  title: guaranteedPriceErrors
  required: false
  readable: true
  writeable: false
  description: This value is used during estimation and is not persisted.
supported property: SupportedProperty
  property: operatorValidated
  title: operatorValidated
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: proposalType
  title: proposalType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: nameForCourier
  title: nameForCourier
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: estimatedDuration
  title: estimatedDuration
  required: false
  readable: true
  writeable: false
  description: Compatibility layer for the previous “estimatedDuration” property.
supported operation: Retrieves a DeliveryTemplate resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a DeliveryTemplate resource.
  returns: DeliveryTemplate
supported operation: Updates the DeliveryTemplate resource.
  type: Operation
  expects: DeliveryTemplate
  method: PATCH
  title: Updates the DeliveryTemplate resource.
  returns: DeliveryTemplate
supported operation: Deletes the DeliveryTemplate resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the DeliveryTemplate resource.
  returns: Nothing

estimatedPrice
type: Property
domain: DeliveryTemplate
range: integer

freightForwarder
type: Property
domain: DeliveryTemplate
max cardinality: 1
range: User

merchandise
type: Property
domain: DeliveryTemplate

vehicleType
type: Property
domain: DeliveryTemplate
range: string

vehicleLoadType
type: Property
domain: DeliveryTemplate
range: string

transportRules
type: Property
domain: DeliveryTemplate

options
type: Property
domain: DeliveryTemplate

pickupWaypoints
type: Property
domain: DeliveryTemplate

receiptWaypoints
type: Property
domain: DeliveryTemplate

receiptComment
type: Property
domain: DeliveryTemplate
range: string

mileage
type: Property
domain: DeliveryTemplate
range: integer

estimatedCourierPrice
type: Property
domain: DeliveryTemplate
range: integer

scheduled
type: Property
domain: DeliveryTemplate
range: boolean

name
type: Property
domain: DeliveryTemplate
range: string

guaranteedPrice
type: Property
domain: DeliveryTemplate
range: boolean

guaranteedPriceErrors
type: Property
domain: DeliveryTemplate

operatorValidated
type: Property
domain: DeliveryTemplate
range: boolean

createdAt
type: Property
domain: DeliveryTemplate
range: dateTime

updatedAt
type: Property
domain: DeliveryTemplate
range: dateTime

proposalType
type: Property
domain: DeliveryTemplate
range: string

nameForCourier
type: Property
domain: DeliveryTemplate
range: string

estimatedDuration
type: Property
domain: DeliveryTemplate
range: integer

Department
type: Class
title: Department
supported property: SupportedProperty
  property: available
  title: available
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: departmentName
  title: departmentName
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: departmentCode
  title: departmentCode
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hubs
  title: hubs
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: assignations
  title: assignations
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Department resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Department resource.
  returns: Department

available
type: Property
domain: Department
range: boolean

departmentName
type: Property
domain: Department
range: string

departmentCode
type: Property
domain: Department
range: string

hubs
type: Property
domain: Department

assignations
type: Link
domain: Department
range: CompanyDepartmentAssignation

Document
type: Class
title: Document
supported property: SupportedProperty
  property: fileName
  title: fileName
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Document resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Document resource.
  returns: Document

fileName
type: Property
domain: Document
range: string

createdAt
type: Property
domain: Document
range: dateTime

updatedAt
type: Property
domain: Document
range: dateTime

File
type: Class
title: File
supported operation: Retrieves a File resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a File resource.
  returns: File

FreightForwarder
type: Class
title: FreightForwarder
supported property: SupportedProperty
  property: managedCompany
  title: managedCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docInsurance
  title: docInsurance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docTransportAttestation
  title: docTransportAttestation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: PHP will cast strings like “06…” to integers Numbers like “+336…” will already be typed as strings So it can be a string or an integer internally.
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: termsOfUseAccepted
  title: termsOfUseAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailConfirmed
  title: emailConfirmed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docKbisExtract
  title: docKbisExtract
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountStatus
  title: accountStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountValidationRequested
  title: accountValidationRequested
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountRejectedMessage
  title: accountRejectedMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: courierOfCompany
  title: courierOfCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNewDeliveryEmail
  title: sendNewDeliveryEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docIdentityCard
  title: docIdentityCard
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docCompanyStatus
  title: docCompanyStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docConcealedWork
  title: docConcealedWork
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docLiabilityInsurance
  title: docLiabilityInsurance
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a FreightForwarder resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a FreightForwarder resource.
  returns: FreightForwarder
supported operation: Replaces the FreightForwarder resource.
  type: Operation
  type: ReplaceAction
  expects: FreightForwarder
  method: PUT
  title: Replaces the FreightForwarder resource.
  returns: FreightForwarder

managedCompany
type: Property
domain: FreightForwarder
max cardinality: 1
range: Company

docInsurance
type: Property
domain: FreightForwarder
max cardinality: 1
range: Document

docTransportAttestation
type: Property
domain: FreightForwarder
max cardinality: 1
range: Document

firstname
type: Property
domain: FreightForwarder
range: string

lastname
type: Property
domain: FreightForwarder
range: string

email
type: Property
domain: FreightForwarder
range: string

phoneNumber
type: Property
domain: FreightForwarder
range: string

plainPassword
type: Property
domain: FreightForwarder
range: string

termsOfUseAccepted
type: Property
domain: FreightForwarder
range: boolean

emailConfirmed
type: Property
domain: FreightForwarder
range: boolean

docKbisExtract
type: Property
domain: FreightForwarder
max cardinality: 1
range: Document

accountStatus
type: Property
domain: FreightForwarder
range: string

accountValidationRequested
type: Property
domain: FreightForwarder
range: boolean

accountRejectedMessage
type: Property
domain: FreightForwarder
range: string

courierOfCompany
type: Property
domain: FreightForwarder
max cardinality: 1
range: Company

sendNewDeliveryEmail
type: Property
domain: FreightForwarder
range: boolean

createdAt
type: Property
domain: FreightForwarder
range: dateTime

updatedAt
type: Property
domain: FreightForwarder
range: dateTime

docIdentityCard
type: Property
domain: FreightForwarder
max cardinality: 1
range: Document

docCompanyStatus
type: Property
domain: FreightForwarder
max cardinality: 1
range: Document

docConcealedWork
type: Property
domain: FreightForwarder
max cardinality: 1
range: Document

docLiabilityInsurance
type: Property
domain: FreightForwarder
max cardinality: 1
range: Document

Hub
type: Class
title: Hub
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: code
  title: code
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: address
  title: address
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: departmentId
  title: departmentId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: localisation
  title: localisation
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recipientEmail
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Hub resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Hub resource.
  returns: Hub
supported operation: Replaces the Hub resource.
  type: Operation
  type: ReplaceAction
  expects: Hub
  method: PUT
  title: Replaces the Hub resource.
  returns: Hub
supported operation: Deletes the Hub resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Hub resource.
  returns: Nothing

name
type: Property
domain: Hub
range: string

code
type: Property
domain: Hub
range: string

address
type: Property
domain: Hub

departmentId
type: Property
domain: Hub
range: string

phoneNumber
type: Property
domain: Hub
range: string

localisation
type: Property
domain: Hub

id
type: Property
domain: Hub
range: string

IndependentCourier
type: Class
title: IndependentCourier
supported property: SupportedProperty
  property: managedCompany
  title: managedCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docTransportLicense
  title: docTransportLicense
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docInsurance
  title: docInsurance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docAdrCertification
  title: docAdrCertification
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docAnimalsCertification
  title: docAnimalsCertification
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: PHP will cast strings like “06…” to integers Numbers like “+336…” will already be typed as strings So it can be a string or an integer internally.
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: termsOfUseAccepted
  title: termsOfUseAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailConfirmed
  title: emailConfirmed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docKbisExtract
  title: docKbisExtract
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountStatus
  title: accountStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountValidationRequested
  title: accountValidationRequested
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountRejectedMessage
  title: accountRejectedMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: courierOfCompany
  title: courierOfCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNewDeliveryEmail
  title: sendNewDeliveryEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docIdentityCard
  title: docIdentityCard
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docCompanyStatus
  title: docCompanyStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docConcealedWork
  title: docConcealedWork
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docLiabilityInsurance
  title: docLiabilityInsurance
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a IndependentCourier resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a IndependentCourier resource.
  returns: IndependentCourier
supported operation: Replaces the IndependentCourier resource.
  type: Operation
  type: ReplaceAction
  expects: IndependentCourier
  method: PUT
  title: Replaces the IndependentCourier resource.
  returns: IndependentCourier

managedCompany
type: Property
domain: IndependentCourier
max cardinality: 1
range: Company

docTransportLicense
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

docInsurance
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

docAdrCertification
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

docAnimalsCertification
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

state
type: Property
domain: IndependentCourier

firstname
type: Property
domain: IndependentCourier
range: string

lastname
type: Property
domain: IndependentCourier
range: string

email
type: Property
domain: IndependentCourier
range: string

phoneNumber
type: Property
domain: IndependentCourier
range: string

plainPassword
type: Property
domain: IndependentCourier
range: string

termsOfUseAccepted
type: Property
domain: IndependentCourier
range: boolean

emailConfirmed
type: Property
domain: IndependentCourier
range: boolean

docKbisExtract
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

accountStatus
type: Property
domain: IndependentCourier
range: string

accountValidationRequested
type: Property
domain: IndependentCourier
range: boolean

accountRejectedMessage
type: Property
domain: IndependentCourier
range: string

courierOfCompany
type: Property
domain: IndependentCourier
max cardinality: 1
range: Company

sendNewDeliveryEmail
type: Property
domain: IndependentCourier
range: boolean

createdAt
type: Property
domain: IndependentCourier
range: dateTime

updatedAt
type: Property
domain: IndependentCourier
range: dateTime

docIdentityCard
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

docCompanyStatus
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

docConcealedWork
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

docLiabilityInsurance
type: Property
domain: IndependentCourier
max cardinality: 1
range: Document

InvoicingGroup
type: Class
title: InvoicingGroup
supported property: SupportedProperty
  property: reference
  title: reference
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deliveries
  title: deliveries
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: periodEnd
  title: periodEnd
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invoice
  title: invoice
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invoiceValidatedAt
  title: invoiceValidatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invoiceRefusedAt
  title: invoiceRefusedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invoiceUploadedAt
  title: invoiceUploadedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: declaredPaidAt
  title: declaredPaidAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: declaredTreatingAt
  title: declaredTreatingAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: placeholderDocument
  title: placeholderDocument
  required: false
  readable: true
  writeable: false
  description: Returns a placeholder document in order to force the status of InvoicingGroup.
supported operation: Retrieves a InvoicingGroup resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InvoicingGroup resource.
  returns: InvoicingGroup
supported operation: Creates a InvoicingGroup resource.
  type: Operation
  type: CreateAction
  expects: InvoicingGroup
  method: POST
  title: Creates a InvoicingGroup resource.
  returns: InvoicingGroup
supported operation: Retrieves a InvoicingGroup resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InvoicingGroup resource.
  returns: InvoicingGroup
supported operation: Updates the InvoicingGroup resource.
  type: Operation
  expects: InvoicingGroup
  method: PATCH
  title: Updates the InvoicingGroup resource.
  returns: InvoicingGroup
supported operation: Updates the InvoicingGroup resource.
  type: Operation
  expects: InvoicingGroup
  method: PATCH
  title: Updates the InvoicingGroup resource.
  returns: InvoicingGroup
supported operation: Updates the InvoicingGroup resource.
  type: Operation
  expects: InvoicingGroup
  method: PATCH
  title: Updates the InvoicingGroup resource.
  returns: InvoicingGroup
supported operation: Updates the InvoicingGroup resource.
  type: Operation
  expects: InvoicingGroup
  method: PATCH
  title: Updates the InvoicingGroup resource.
  returns: InvoicingGroup

reference
type: Property
domain: InvoicingGroup
range: string

deliveries
type: Link
domain: InvoicingGroup
range: Delivery

periodEnd
type: Property
domain: InvoicingGroup
range: dateTime

invoice
type: Link
domain: InvoicingGroup
max cardinality: 1
range: Document

invoiceValidatedAt
type: Property
domain: InvoicingGroup
range: dateTime

invoiceRefusedAt
type: Property
domain: InvoicingGroup
range: dateTime

invoiceUploadedAt
type: Property
domain: InvoicingGroup
range: dateTime

declaredPaidAt
type: Property
domain: InvoicingGroup
range: dateTime

declaredTreatingAt
type: Property
domain: InvoicingGroup
range: dateTime

company
type: Link
domain: InvoicingGroup
max cardinality: 1
range: Company

placeholderDocument
type: Property
domain: InvoicingGroup

InvoicingSummary
type: Class
title: InvoicingSummary
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: period
  title: period
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: reference
  title: reference
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invoiceFilename
  title: invoiceFilename
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deliveryCount
  title: deliveryCount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: invoiceValidatedAt
  title: invoiceValidatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: passedTreatingAt
  title: passedTreatingAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: totalPriceWithoutVat
  title: totalPriceWithoutVat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: totalPriceWithVat
  title: totalPriceWithVat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: status
  title: status
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deliveries
  title: deliveries
  required: false
  readable: true
  writeable: true
  description: Delivery[]
supported property: SupportedProperty
  property: totalPricePerStatus
  title: totalPricePerStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: totalPriceWithoutVat
  title: totalPriceWithoutVat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: totalPriceWithVat
  title: totalPriceWithVat
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deliveriesCount
  title: deliveriesCount
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a InvoicingSummary resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a InvoicingSummary resource.
  returns: InvoicingSummary

id
type: Property
domain: InvoicingSummary
range: integer

period
type: Property
domain: InvoicingSummary
range: string

reference
type: Property
domain: InvoicingSummary
range: string

invoiceFilename
type: Property
domain: InvoicingSummary
range: string

deliveryCount
type: Property
domain: InvoicingSummary
range: integer

invoiceValidatedAt
type: Property
domain: InvoicingSummary
range: dateTime

passedTreatingAt
type: Property
domain: InvoicingSummary
range: dateTime

totalPriceWithoutVat
type: Property
domain: InvoicingSummary
range: integer

totalPriceWithVat
type: Property
domain: InvoicingSummary
range: integer

company
type: Property
domain: InvoicingSummary

status
type: Property
domain: InvoicingSummary

deliveries
type: Property
domain: InvoicingSummary

totalPricePerStatus
type: Property
domain: InvoicingSummary

deliveriesCount
type: Property
domain: InvoicingSummary
range: integer

Manager
type: Class
title: Manager
supported property: SupportedProperty
  property: managedCompany
  title: managedCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: courierOfCompany
  title: courierOfCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docTransportLicense
  title: docTransportLicense
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docUrssafAttestation
  title: docUrssafAttestation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docMerchandiseInsurance
  title: docMerchandiseInsurance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: PHP will cast strings like “06…” to integers Numbers like “+336…” will already be typed as strings So it can be a string or an integer internally.
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: termsOfUseAccepted
  title: termsOfUseAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailConfirmed
  title: emailConfirmed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docKbisExtract
  title: docKbisExtract
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountStatus
  title: accountStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountValidationRequested
  title: accountValidationRequested
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountRejectedMessage
  title: accountRejectedMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: sendNewDeliveryEmail
  title: sendNewDeliveryEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docIdentityCard
  title: docIdentityCard
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docCompanyStatus
  title: docCompanyStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docConcealedWork
  title: docConcealedWork
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docLiabilityInsurance
  title: docLiabilityInsurance
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Manager resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Manager resource.
  returns: Manager
supported operation: Replaces the Manager resource.
  type: Operation
  type: ReplaceAction
  expects: Manager
  method: PUT
  title: Replaces the Manager resource.
  returns: Manager

managedCompany
type: Property
domain: Manager
max cardinality: 1
range: Company

courierOfCompany
type: Property
domain: Manager
max cardinality: 1
range: Company

docTransportLicense
type: Property
domain: Manager
max cardinality: 1
range: Document

docUrssafAttestation
type: Property
domain: Manager
max cardinality: 1
range: Document

docMerchandiseInsurance
type: Property
domain: Manager
max cardinality: 1
range: Document

state
type: Property
domain: Manager

firstname
type: Property
domain: Manager
range: string

lastname
type: Property
domain: Manager
range: string

email
type: Property
domain: Manager
range: string

phoneNumber
type: Property
domain: Manager
range: string

plainPassword
type: Property
domain: Manager
range: string

termsOfUseAccepted
type: Property
domain: Manager
range: boolean

emailConfirmed
type: Property
domain: Manager
range: boolean

docKbisExtract
type: Property
domain: Manager
max cardinality: 1
range: Document

accountStatus
type: Property
domain: Manager
range: string

accountValidationRequested
type: Property
domain: Manager
range: boolean

accountRejectedMessage
type: Property
domain: Manager
range: string

sendNewDeliveryEmail
type: Property
domain: Manager
range: boolean

createdAt
type: Property
domain: Manager
range: dateTime

updatedAt
type: Property
domain: Manager
range: dateTime

docIdentityCard
type: Property
domain: Manager
max cardinality: 1
range: Document

docCompanyStatus
type: Property
domain: Manager
max cardinality: 1
range: Document

docConcealedWork
type: Property
domain: Manager
max cardinality: 1
range: Document

docLiabilityInsurance
type: Property
domain: Manager
max cardinality: 1
range: Document

CustomPageAdvancedSettings
type: Class
title: CustomPageAdvancedSettings
supported property: SupportedProperty
  property: remove
  title: remove
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: add
  title: add
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: customPage
  title: customPage
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recipientEmail
  title: recipientEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: collectionDelayT1
  title: collectionDelayT1
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: collectionDelayT2
  title: collectionDelayT2
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: collectionDelayT3
  title: collectionDelayT3
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: morningTimeSlotAvailable
  title: morningTimeSlotAvailable
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: morningTimeSlotStart
  title: morningTimeSlotStart
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: morningTimeSlotEnd
  title: morningTimeSlotEnd
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: afternoonTimeSlotAvailable
  title: afternoonTimeSlotAvailable
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: afternoonTimeSlotStart
  title: afternoonTimeSlotStart
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: afternoonTimeSlotEnd
  title: afternoonTimeSlotEnd
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a CustomPageAdvancedSettings resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a CustomPageAdvancedSettings resource.
  returns: Nothing

remove
type: Link
domain: CustomPageAdvancedSettings
range: Department

add
type: Link
domain: CustomPageAdvancedSettings
range: Department

customPage
type: Link
domain: CustomPageAdvancedSettings
max cardinality: 1
range: CustomPage

collectionDelayT1
type: Property
domain: CustomPageAdvancedSettings
range: integer

collectionDelayT2
type: Property
domain: CustomPageAdvancedSettings
range: integer

collectionDelayT3
type: Property
domain: CustomPageAdvancedSettings
range: integer

morningTimeSlotAvailable
type: Property
domain: CustomPageAdvancedSettings
range: boolean

morningTimeSlotStart
type: Property
domain: CustomPageAdvancedSettings
range: string

morningTimeSlotEnd
type: Property
domain: CustomPageAdvancedSettings
range: string

afternoonTimeSlotAvailable
type: Property
domain: CustomPageAdvancedSettings
range: boolean

afternoonTimeSlotStart
type: Property
domain: CustomPageAdvancedSettings
range: string

afternoonTimeSlotEnd
type: Property
domain: CustomPageAdvancedSettings
range: string

LoginCustomPage
type: Class
title: LoginCustomPage
supported operation: Retrieves a LoginCustomPage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a LoginCustomPage resource.
  returns: LoginCustomPage

WaypointUpdateEstimatedTimeOfArrival
type: Class
title: WaypointUpdateEstimatedTimeOfArrival
supported property: SupportedProperty
  property: waypointType
  title: waypointType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: estimatedTimeOfArrival
  title: estimatedTimeOfArrival
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a WaypointUpdateEstimatedTimeOfArrival resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a WaypointUpdateEstimatedTimeOfArrival resource.
  returns: Nothing

waypointType
type: Property
domain: WaypointUpdateEstimatedTimeOfArrival
range: string

estimatedTimeOfArrival
type: Property
domain: WaypointUpdateEstimatedTimeOfArrival
range: dateTime

Operator
type: Class
title: Operator
supported property: SupportedProperty
  property: managedCompany
  title: managedCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: courierOfCompany
  title: courierOfCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: state
  title: state
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: PHP will cast strings like “06…” to integers Numbers like “+336…” will already be typed as strings So it can be a string or an integer internally.
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: termsOfUseAccepted
  title: termsOfUseAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailConfirmed
  title: emailConfirmed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docKbisExtract
  title: docKbisExtract
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountStatus
  title: accountStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountValidationRequested
  title: accountValidationRequested
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountRejectedMessage
  title: accountRejectedMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: sendNewDeliveryEmail
  title: sendNewDeliveryEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docTransportLicense
  title: docTransportLicense
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docUrssafAttestation
  title: docUrssafAttestation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docMerchandiseInsurance
  title: docMerchandiseInsurance
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docIdentityCard
  title: docIdentityCard
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docCompanyStatus
  title: docCompanyStatus
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docConcealedWork
  title: docConcealedWork
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: docLiabilityInsurance
  title: docLiabilityInsurance
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a Operator resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Operator resource.
  returns: Operator
supported operation: Replaces the Operator resource.
  type: Operation
  type: ReplaceAction
  expects: Operator
  method: PUT
  title: Replaces the Operator resource.
  returns: Operator

managedCompany
type: Property
domain: Operator
max cardinality: 1
range: Company

courierOfCompany
type: Property
domain: Operator
max cardinality: 1
range: Company

state
type: Property
domain: Operator

firstname
type: Property
domain: Operator
range: string

lastname
type: Property
domain: Operator
range: string

email
type: Property
domain: Operator
range: string

phoneNumber
type: Property
domain: Operator
range: string

plainPassword
type: Property
domain: Operator
range: string

termsOfUseAccepted
type: Property
domain: Operator
range: boolean

emailConfirmed
type: Property
domain: Operator
range: boolean

docKbisExtract
type: Property
domain: Operator
max cardinality: 1
range: Document

accountStatus
type: Property
domain: Operator
range: string

accountValidationRequested
type: Property
domain: Operator
range: boolean

accountRejectedMessage
type: Property
domain: Operator
range: string

sendNewDeliveryEmail
type: Property
domain: Operator
range: boolean

createdAt
type: Property
domain: Operator
range: dateTime

updatedAt
type: Property
domain: Operator
range: dateTime

docTransportLicense
type: Property
domain: Operator
max cardinality: 1
range: Document

docUrssafAttestation
type: Property
domain: Operator
max cardinality: 1
range: Document

docMerchandiseInsurance
type: Property
domain: Operator
max cardinality: 1
range: Document

docIdentityCard
type: Property
domain: Operator
max cardinality: 1
range: Document

docCompanyStatus
type: Property
domain: Operator
max cardinality: 1
range: Document

docConcealedWork
type: Property
domain: Operator
max cardinality: 1
range: Document

docLiabilityInsurance
type: Property
domain: Operator
max cardinality: 1
range: Document

Parameter
type: Class
title: Parameter
supported operation: Retrieves a Parameter resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Parameter resource.
  returns: Parameter
supported operation: Replaces the Parameter resource.
  type: Operation
  type: ReplaceAction
  expects: Parameter
  method: PUT
  title: Replaces the Parameter resource.
  returns: Parameter

Ride
type: Class
title: Ride
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: vehicleType
  title: vehicleType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rideType
  title: rideType
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: company
  title: company
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: companyCourierStart
  title: companyCourierStart
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: companyCourierFinish
  title: companyCourierFinish
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: start
  title: start
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: finish
  title: finish
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: options
  title: options
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: days
  title: days
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: currentAddress
  title: currentAddress
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: comment
  title: comment
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: coordinates
  title: coordinates
  required: false
  readable: true
  writeable: false
  description: Return the data with explicit format.
supported operation: Retrieves a Ride resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Ride resource.
  returns: Ride
supported operation: Replaces the Ride resource.
  type: Operation
  type: ReplaceAction
  expects: Ride
  method: PUT
  title: Replaces the Ride resource.
  returns: Ride
supported operation: Deletes the Ride resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Ride resource.
  returns: Nothing
supported operation: Updates the Ride resource.
  type: Operation
  expects: Ride
  method: PATCH
  title: Updates the Ride resource.
  returns: Ride

name
type: Property
domain: Ride
range: string

vehicleType
type: Property
domain: Ride
range: string

rideType
type: Property
domain: Ride
range: string

company
type: Property
domain: Ride
max cardinality: 1
range: Company

companyCourierStart
type: Property
domain: Ride
max cardinality: 1
range: CompanyCourier

companyCourierFinish
type: Property
domain: Ride
max cardinality: 1
range: CompanyCourier

start
type: Property
domain: Ride

finish
type: Property
domain: Ride

options
type: Property
domain: Ride

days
type: Property
domain: Ride

currentAddress
type: Property
domain: Ride
range: string

comment
type: Property
domain: Ride
range: string

createdAt
type: Property
domain: Ride
range: dateTime

updatedAt
type: Property
domain: Ride
range: dateTime

coordinates
type: Property
domain: Ride

Scenario
type: Class
title: Scenario
supported property: SupportedProperty
  property: id
  title: id
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: pickupDatetime
  title: pickupDatetime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: additionalDistanceInMeters
  title: additionalDistanceInMeters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: deliveryTime
  title: deliveryTime
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: estimatedTransitTimeInSeconds
  title: estimatedTransitTimeInSeconds
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: travelledDistanceInMeters
  title: travelledDistanceInMeters
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: companiesForPickup
  title: companiesForPickup
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: companiesForLastMile
  title: companiesForLastMile
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: waitingTimeHubs
  title: waitingTimeHubs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: arrivalHubs
  title: arrivalHubs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: rides
  title: rides
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Scenario resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Scenario resource.
  returns: Nothing

id
type: Property
domain: Scenario
range: integer

pickupDatetime
type: Property
domain: Scenario
range: dateTime

additionalDistanceInMeters
type: Property
domain: Scenario
range: integer

deliveryTime
type: Property
domain: Scenario
range: dateTime

estimatedTransitTimeInSeconds
type: Property
domain: Scenario
range: integer

travelledDistanceInMeters
type: Property
domain: Scenario
range: integer

companiesForPickup
type: Property
domain: Scenario

companiesForLastMile
type: Property
domain: Scenario

waitingTimeHubs
type: Property
domain: Scenario
range: string

arrivalHubs
type: Link
domain: Scenario
range: Hub

rides
type: Property
domain: Scenario

StateLog
type: Class
title: StateLog
supported property: SupportedProperty
  property: courier
  title: courier
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: position
  title: position
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: coordinates
  title: coordinates
  required: false
  readable: true
  writeable: false
  description: Return the data with explicit format.

courier
type: Link
domain: StateLog
max cardinality: 1
range: CompanyCourier

createdAt
type: Property
domain: StateLog
range: dateTime

updatedAt
type: Property
domain: StateLog
range: dateTime

position
type: Property
domain: StateLog

coordinates
type: Property
domain: StateLog

Thread
type: Class
title: Thread
supported property: SupportedProperty
  property: members
  title: members
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: locked
  title: locked
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Thread resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Thread resource.
  returns: Thread
supported operation: Creates a Thread resource.
  type: Operation
  type: CreateAction
  expects: Thread
  method: POST
  title: Creates a Thread resource.
  returns: Thread

members
type: Property
domain: Thread
range: User

locked
type: Property
domain: Thread
range: boolean

UnreadMessage
type: Class
title: UnreadMessage
supported property: SupportedProperty
  property: message
  title: message
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a UnreadMessage resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a UnreadMessage resource.
  returns: UnreadMessage

message
type: Property
domain: UnreadMessage

user
type: Link
domain: UnreadMessage
max cardinality: 1
range: User

User
type: Class
title: User
supported property: SupportedProperty
  property: firstname
  title: firstname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: lastname
  title: lastname
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: phoneNumber
  title: phoneNumber
  required: false
  readable: true
  writeable: true
  description: PHP will cast strings like “06…” to integers Numbers like “+336…” will already be typed as strings So it can be a string or an integer internally.
supported property: SupportedProperty
  property: plainPassword
  title: plainPassword
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: termsOfUseAccepted
  title: termsOfUseAccepted
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: emailConfirmed
  title: emailConfirmed
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: docKbisExtract
  title: docKbisExtract
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountStatus
  title: accountStatus
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: accountValidationRequested
  title: accountValidationRequested
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accountRejectedMessage
  title: accountRejectedMessage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: courierOfCompany
  title: courierOfCompany
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sendNewDeliveryEmail
  title: sendNewDeliveryEmail
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: createdAt
  title: createdAt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: updatedAt
  title: updatedAt
  required: false
  readable: true
  writeable: false
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Replaces the User resource.
  type: Operation
  type: ReplaceAction
  expects: User
  method: PUT
  title: Replaces the User resource.
  returns: User
supported operation: Deletes the User resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the User resource.
  returns: Nothing
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Creates a User resource.
  type: Operation
  type: CreateAction
  expects: User
  method: POST
  title: Creates a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User
supported operation: Retrieves a User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a User resource.
  returns: User

firstname
type: Property
domain: User
range: string

lastname
type: Property
domain: User
range: string

email
type: Property
domain: User
range: string

phoneNumber
type: Property
domain: User
range: string

plainPassword
type: Property
domain: User
range: string

termsOfUseAccepted
type: Property
domain: User
range: boolean

emailConfirmed
type: Property
domain: User
range: boolean

docKbisExtract
type: Property
domain: User
max cardinality: 1
range: Document

accountStatus
type: Property
domain: User
range: string

accountValidationRequested
type: Property
domain: User
range: boolean

accountRejectedMessage
type: Property
domain: User
range: string

courierOfCompany
type: Property
domain: User
max cardinality: 1
range: Company

sendNewDeliveryEmail
type: Property
domain: User
range: boolean

createdAt
type: Property
domain: User
range: dateTime

updatedAt
type: Property
domain: User
range: dateTime

Vehicle
type: Class
title: Vehicle
supported property: SupportedProperty
  property: company
  title: company
  required: true
  readable: false
  writeable: true
supported property: SupportedProperty
  property: licenseNumber
  title: licenseNumber
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: loading
  title: loading
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: options
  title: options
  required: false
  readable: true
  writeable: true
supported operation: Retrieves a Vehicle resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves a Vehicle resource.
  returns: Vehicle
supported operation: Deletes the Vehicle resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Vehicle resource.
  returns: Nothing
supported operation: Replaces the Vehicle resource.
  type: Operation
  type: ReplaceAction
  expects: Vehicle
  method: PUT
  title: Replaces the Vehicle resource.
  returns: Vehicle

company
type: Link
domain: Vehicle
max cardinality: 1
range: Company

licenseNumber
type: Property
domain: Vehicle
range: string

type
type: Property
domain: Vehicle
range: string

loading
type: Property
domain: Vehicle
range: string

options
type: Property
domain: Vehicle

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of Zone resources
  title: The collection of Zone resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of PriceSpecification resources
  title: The collection of PriceSpecification resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Tender resources
  title: The collection of Tender resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CompanyCustomPage resources
  title: The collection of CompanyCustomPage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Accountant resources
  title: The collection of Accountant resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Company resources
  title: The collection of Company resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CompanyCourier resources
  title: The collection of CompanyCourier resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CompanyDepartmentAssignation resources
  title: The collection of CompanyDepartmentAssignation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CustomPage resources
  title: The collection of CustomPage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CustomPageUser resources
  title: The collection of CustomPageUser resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Delivery resources
  title: The collection of Delivery resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of DeliveryTemplate resources
  title: The collection of DeliveryTemplate resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Department resources
  title: The collection of Department resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Document resources
  title: The collection of Document resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of FreightForwarder resources
  title: The collection of FreightForwarder resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Hub resources
  title: The collection of Hub resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of IndependentCourier resources
  title: The collection of IndependentCourier resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of InvoicingGroup resources
  title: The collection of InvoicingGroup resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of InvoicingSummary resources
  title: The collection of InvoicingSummary resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Manager resources
  title: The collection of Manager resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of CustomPageAdvancedSettings resources
  title: The collection of CustomPageAdvancedSettings resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of WaypointUpdateEstimatedTimeOfArrival resources
  title: The collection of WaypointUpdateEstimatedTimeOfArrival resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Operator resources
  title: The collection of Operator resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Ride resources
  title: The collection of Ride resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Scenario resources
  title: The collection of Scenario resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of StateLog resources
  title: The collection of StateLog resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Thread resources
  title: The collection of Thread resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UnreadMessage resources
  title: The collection of UnreadMessage resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Vehicle resources
  title: The collection of Vehicle resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of Zone resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Zone
supported operation: Retrieves the collection of Zone resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Zone resources.
  returns: Collection

The collection of PriceSpecification resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: PriceSpecification
supported operation: Creates a PriceSpecification resource.
  type: Operation
  type: CreateAction
  expects: PriceSpecification
  method: POST
  title: Creates a PriceSpecification resource.
  returns: PriceSpecification
supported operation: Retrieves the collection of PriceSpecification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of PriceSpecification resources.
  returns: Collection

The collection of Tender resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Tender
supported operation: Creates a Tender resource.
  type: Operation
  type: CreateAction
  expects: Tender
  method: POST
  title: Creates a Tender resource.
  returns: Tender
supported operation: Retrieves the collection of Tender resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Tender resources.
  returns: Collection

The collection of CompanyCustomPage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CompanyCustomPage
supported operation: Creates a CompanyCustomPage resource.
  type: Operation
  type: CreateAction
  expects: CompanyCustomPage
  method: POST
  title: Creates a CompanyCustomPage resource.
  returns: CompanyCustomPage
supported operation: Retrieves the collection of CompanyCustomPage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CompanyCustomPage resources.
  returns: Collection

The collection of Accountant resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Accountant
supported operation: Retrieves the collection of Accountant resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Accountant resources.
  returns: Collection

The collection of Company resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Company
supported operation: Retrieves the collection of Company resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Company resources.
  returns: Collection

The collection of CompanyCourier resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CompanyCourier
supported operation: Retrieves the collection of CompanyCourier resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CompanyCourier resources.
  returns: Collection

The collection of CompanyDepartmentAssignation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CompanyDepartmentAssignation
supported operation: Creates a CompanyDepartmentAssignation resource.
  type: Operation
  type: CreateAction
  expects: CompanyDepartmentAssignation
  method: POST
  title: Creates a CompanyDepartmentAssignation resource.
  returns: CompanyDepartmentAssignation
supported operation: Retrieves the collection of CompanyDepartmentAssignation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CompanyDepartmentAssignation resources.
  returns: Collection

The collection of CustomPage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CustomPage
supported operation: Retrieves the collection of CustomPage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CustomPage resources.
  returns: Collection

The collection of CustomPageUser resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CustomPageUser
supported operation: Creates a CustomPageUser resource.
  type: Operation
  type: CreateAction
  expects: CustomPageUser
  method: POST
  title: Creates a CustomPageUser resource.
  returns: CustomPageUser
supported operation: Retrieves the collection of CustomPageUser resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CustomPageUser resources.
  returns: Collection

The collection of Delivery resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Delivery
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Creates a Delivery resource.
  type: Operation
  type: CreateAction
  expects: Delivery
  method: POST
  title: Creates a Delivery resource.
  returns: Delivery
supported operation: Creates a Delivery resource.
  type: Operation
  type: CreateAction
  expects: Delivery
  method: POST
  title: Creates a Delivery resource.
  returns: Delivery
supported operation: Creates a Delivery resource.
  type: Operation
  type: CreateAction
  expects: Delivery
  method: POST
  title: Creates a Delivery resource.
  returns: Delivery
supported operation: Creates a Delivery resource.
  type: Operation
  type: CreateAction
  expects: Delivery
  method: POST
  title: Creates a Delivery resource.
  returns: Delivery
supported operation: Creates a Delivery resource.
  type: Operation
  type: CreateAction
  expects: Delivery
  method: POST
  title: Creates a Delivery resource.
  returns: Delivery
supported operation: Creates a Delivery resource.
  type: Operation
  type: CreateAction
  expects: Delivery
  method: POST
  title: Creates a Delivery resource.
  returns: Delivery
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Deletes the Delivery resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Delivery resource.
  returns: Nothing
supported operation: Updates the Delivery resource.
  type: Operation
  expects: Delivery
  method: PATCH
  title: Updates the Delivery resource.
  returns: Delivery
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection
supported operation: Retrieves the collection of Delivery resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Delivery resources.
  returns: Collection

The collection of DeliveryTemplate resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: DeliveryTemplate
supported operation: Retrieves the collection of DeliveryTemplate resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of DeliveryTemplate resources.
  returns: Collection
supported operation: Creates a DeliveryTemplate resource.
  type: Operation
  type: CreateAction
  expects: DeliveryTemplate
  method: POST
  title: Creates a DeliveryTemplate resource.
  returns: DeliveryTemplate

The collection of Department resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Department
supported operation: Retrieves the collection of Department resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Department resources.
  returns: Collection

The collection of Document resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Document
supported operation: Retrieves the collection of Document resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Document resources.
  returns: Collection
supported operation: Creates a Document resource.
  type: Operation
  type: CreateAction
  expects: Document
  method: POST
  title: Creates a Document resource.
  returns: Document

The collection of FreightForwarder resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: FreightForwarder
supported operation: Creates a FreightForwarder resource.
  type: Operation
  type: CreateAction
  expects: FreightForwarder
  method: POST
  title: Creates a FreightForwarder resource.
  returns: FreightForwarder
supported operation: Retrieves the collection of FreightForwarder resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of FreightForwarder resources.
  returns: Collection

The collection of Hub resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Hub
supported operation: Retrieves the collection of Hub resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Hub resources.
  returns: Collection
supported operation: Creates a Hub resource.
  type: Operation
  type: CreateAction
  expects: Hub
  method: POST
  title: Creates a Hub resource.
  returns: Hub

The collection of IndependentCourier resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: IndependentCourier
supported operation: Creates a IndependentCourier resource.
  type: Operation
  type: CreateAction
  expects: IndependentCourier
  method: POST
  title: Creates a IndependentCourier resource.
  returns: IndependentCourier
supported operation: Retrieves the collection of IndependentCourier resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of IndependentCourier resources.
  returns: Collection

The collection of InvoicingGroup resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: InvoicingGroup
supported operation: Retrieves the collection of InvoicingGroup resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of InvoicingGroup resources.
  returns: Collection
supported operation: Creates a InvoicingGroup resource.
  type: Operation
  type: CreateAction
  expects: InvoicingGroup
  method: POST
  title: Creates a InvoicingGroup resource.
  returns: InvoicingGroup

The collection of InvoicingSummary resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: InvoicingSummary
supported operation: Retrieves the collection of InvoicingSummary resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of InvoicingSummary resources.
  returns: Collection
supported operation: Retrieves the collection of InvoicingSummary resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of InvoicingSummary resources.
  returns: Collection

The collection of Manager resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Manager
supported operation: Creates a Manager resource.
  type: Operation
  type: CreateAction
  expects: Manager
  method: POST
  title: Creates a Manager resource.
  returns: Manager
supported operation: Retrieves the collection of Manager resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Manager resources.
  returns: Collection

The collection of CustomPageAdvancedSettings resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: CustomPageAdvancedSettings
supported operation: Retrieves the collection of CustomPageAdvancedSettings resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of CustomPageAdvancedSettings resources.
  returns: Collection
supported operation: Creates a CustomPageAdvancedSettings resource.
  type: Operation
  type: CreateAction
  expects: CustomPageAdvancedSettings
  method: POST
  title: Creates a CustomPageAdvancedSettings resource.
  returns: CustomPageAdvancedSettings

The collection of WaypointUpdateEstimatedTimeOfArrival resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: WaypointUpdateEstimatedTimeOfArrival
supported operation: Retrieves the collection of WaypointUpdateEstimatedTimeOfArrival resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of WaypointUpdateEstimatedTimeOfArrival resources.
  returns: Collection
supported operation: Creates a WaypointUpdateEstimatedTimeOfArrival resource.
  type: Operation
  type: CreateAction
  expects: WaypointUpdateEstimatedTimeOfArrival
  method: POST
  title: Creates a WaypointUpdateEstimatedTimeOfArrival resource.
  returns: WaypointUpdateEstimatedTimeOfArrival

The collection of Operator resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Operator
supported operation: Retrieves the collection of Operator resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Operator resources.
  returns: Collection

The collection of Ride resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Ride
supported operation: Retrieves the collection of Ride resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Ride resources.
  returns: Collection
supported operation: Creates a Ride resource.
  type: Operation
  type: CreateAction
  expects: Ride
  method: POST
  title: Creates a Ride resource.
  returns: Ride

The collection of Scenario resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Scenario
supported operation: Retrieves the collection of Scenario resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Scenario resources.
  returns: Collection

The collection of StateLog resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: StateLog
supported operation: Retrieves the collection of StateLog resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of StateLog resources.
  returns: Collection

The collection of Thread resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Thread
supported operation: Retrieves the collection of Thread resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Thread resources.
  returns: Collection
supported operation: Creates a Thread resource.
  type: Operation
  type: CreateAction
  expects: Thread
  method: POST
  title: Creates a Thread resource.
  returns: Thread

The collection of UnreadMessage resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UnreadMessage
supported operation: Retrieves the collection of UnreadMessage resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UnreadMessage resources.
  returns: Collection

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection

The collection of Vehicle resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Vehicle
supported operation: Retrieves the collection of Vehicle resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Vehicle resources.
  returns: Collection
supported operation: Creates a Vehicle resource.
  type: Operation
  type: CreateAction
  expects: Vehicle
  method: POST
  title: Creates a Vehicle resource.
  returns: Vehicle

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

SupportedProperty
property: docConcealedWork
title: docConcealedWork
required: false
readable: true
writeable: true

SupportedProperty
property: docLiabilityInsurance
title: docLiabilityInsurance
required: false
readable: true
writeable: true

SupportedProperty
property: uploadedRequiredDocuments
title: uploadedRequiredDocuments
required: false
readable: true
writeable: false

SupportedProperty
property: requiredDocuments
title: requiredDocuments
required: false
readable: true
writeable: false

SupportedProperty
property: optionalDocuments
title: optionalDocuments
required: false
readable: true
writeable: false

SupportedProperty
property: deliveriesAsCompanyCourierStart
title: deliveriesAsCompanyCourierStart
required: false
readable: true
writeable: true

SupportedProperty
property: deliveriesAsCompanyCourierFinish
title: deliveriesAsCompanyCourierFinish
required: false
readable: true
writeable: true

SupportedProperty
property: deliveryRefusals
title: deliveryRefusals
required: false
readable: false
writeable: false

SupportedProperty
property: deliveryRejected
title: deliveryRejected
required: false
readable: false
writeable: false

SupportedProperty
property: counterOffersStart
title: counterOffersStart
required: false
readable: true
writeable: true

SupportedProperty
property: counterOffersFinish
title: counterOffersFinish
required: false
readable: true
writeable: false

SupportedProperty
property: ridesStart
title: ridesStart
required: false
readable: true
writeable: false

SupportedProperty
property: ridesFinish
title: ridesFinish
required: false
readable: true
writeable: false

SupportedProperty
property: availableDeliveries
title: availableDeliveries
required: false
readable: true
writeable: true

SupportedProperty
property: stateOrCreate
title: stateOrCreate
required: false
readable: true
writeable: false

SupportedProperty
property: contactForDelivery
title: contactForDelivery
required: false
readable: true
writeable: false
description: Return first manager.

SupportedProperty
property: counterOffersStartFinish
title: counterOffersStartFinish
required: false
readable: false
writeable: true

SupportedProperty
property: deliveriesAsFreightForwarder
title: deliveriesAsFreightForwarder
required: false
readable: true
writeable: false

SupportedProperty
property: deliveriesAsCustomer
title: deliveriesAsCustomer
required: false
readable: true
writeable: true

SupportedProperty
property: heartBeatAt
title: heartBeatAt
required: false
readable: true
writeable: false

SupportedProperty
property: hubSpotId
title: hubSpotId
required: false
readable: true
writeable: true

SupportedProperty
property: fullName
title: fullName
required: false
readable: true
writeable: false

SupportedProperty
property: type
title: type
required: false
readable: true
writeable: false

SupportedProperty
property: salt
title: salt
required: false
readable: true
writeable: false
description: Returns the salt that was originally used to encode the password.

SupportedProperty
property: username
title: username
required: false
readable: true
writeable: false
description: Returns the username used to authenticate the user, which is the email or the phonenumber if there's no email.

SupportedProperty
property: passwordResetTokenOrCreate
title: passwordResetTokenOrCreate
required: false
readable: true
writeable: false

SupportedProperty
property: accountStatusPending
title: accountStatusPending
required: false
readable: false
writeable: false

SupportedProperty
property: accountStatusRejected
title: accountStatusRejected
required: false
readable: false
writeable: false

SupportedProperty
property: accountStatusAccepted
title: accountStatusAccepted
required: false
readable: false
writeable: false

SupportedProperty
property: accountStatusDisabled
title: accountStatusDisabled
required: false
readable: false
writeable: false

SupportedProperty
property: newEmailConfirmationTokenOrCreate
title: newEmailConfirmationTokenOrCreate
required: false
readable: true
writeable: false

SupportedProperty
property: newPhoneNumberConfirmationToken
title: newPhoneNumberConfirmationToken
required: false
readable: true
writeable: true

SupportedProperty
property: newPhoneNumberConfirmationTokenOrCreate
title: newPhoneNumberConfirmationTokenOrCreate
required: false
readable: true
writeable: false

SupportedProperty
property: deleted
title: deleted
required: false
readable: true
writeable: false
description: Check if the entity has been soft deleted.

SupportedProperty
property: syncedToHubSpot
title: syncedToHubSpot
required: false
readable: true
writeable: false

Retrieves a Accountant resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Accountant resource.
returns: Accountant

SupportedProperty
property: bankInformationFullName
title: bankInformationFullName
required: false
readable: true
writeable: false

SupportedProperty
property: bankInformationStreetAddress
title: bankInformationStreetAddress
required: false
readable: true
writeable: false

SupportedProperty
property: bankInformationAdditionalStreetAddress
title: bankInformationAdditionalStreetAddress
required: false
readable: true
writeable: false

SupportedProperty
property: bankInformationPostalCode
title: bankInformationPostalCode
required: false
readable: true
writeable: false

SupportedProperty
property: bankInformationCity
title: bankInformationCity
required: false
readable: true
writeable: false

SupportedProperty
property: bankInformationCountry
title: bankInformationCountry
required: false
readable: true
writeable: false

SupportedProperty
property: mangoMandateStatus
title: mangoMandateStatus
required: false
readable: true
writeable: true

SupportedProperty
property: mangoMandateUrl
title: mangoMandateUrl
required: false
readable: true
writeable: false

SupportedProperty
property: disabledAt
title: disabledAt
required: false
readable: true
writeable: true

SupportedProperty
property: customPage
title: customPage
required: false
readable: true
writeable: false

SupportedProperty
property: allDepartments
title: allDepartments
required: false
readable: true
writeable: false
description: Not persisted, only used for returning the departments to the managers.

SupportedProperty
property: bankInformationComplete
title: bankInformationComplete
required: false
readable: true
writeable: false

Retrieves a Company resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Company resource.
returns: Company

Replaces the Company resource.
type: Operation
type: ReplaceAction
expects: Company
method: PUT
title: Replaces the Company resource.
returns: Company

Creates a Company resource.
type: Operation
type: CreateAction
expects: Company
method: POST
title: Creates a Company resource.
returns: Company

Retrieves a Company resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Company resource.
returns: Company

SupportedProperty
property: vehicleType
title: vehicleType
required: false
readable: true
writeable: false

SupportedProperty
property: vehicleLoadType
title: vehicleLoadType
required: false
readable: true
writeable: true

SupportedProperty
property: transportRules
title: transportRules
required: false
readable: true
writeable: true

SupportedProperty
property: options
title: options
required: false
readable: true
writeable: true

SupportedProperty
property: pickupWaypoints
title: pickupWaypoints
required: false
readable: true
writeable: true

SupportedProperty
property: receiptWaypoints
title: receiptWaypoints
required: false
readable: true
writeable: true

SupportedProperty
property: receiptComment
title: receiptComment
required: false
readable: true
writeable: true

SupportedProperty
property: mileage
title: mileage
required: false
readable: true
writeable: true
description: Mileage in meters.

SupportedProperty
property: estimatedPrice
title: estimatedPrice
required: false
readable: true
writeable: false
description: Estimated price in cents for FreightForwarder.

SupportedProperty
property: estimatedCourierPrice
title: estimatedCourierPrice
required: false
readable: true
writeable: false
description: Estimated price in cents for Courier.

SupportedProperty
property: scheduled
title: scheduled
required: false
readable: true
writeable: false
description: All deliveries will be scheduled by default, the deliveries created before this change won't be altered

SupportedProperty
property: name
title: name
required: false
readable: true
writeable: true

SupportedProperty
property: guaranteedPrice
title: guaranteedPrice
required: false
readable: true
writeable: false
description: This value is used during estimation and is not persisted.

SupportedProperty
property: guaranteedPriceErrors
title: guaranteedPriceErrors
required: false
readable: true
writeable: false
description: This value is used during estimation and is not persisted.

SupportedProperty
property: operatorValidated
title: operatorValidated
required: false
readable: true
writeable: false

SupportedProperty
property: createdAt
title: createdAt
required: false
readable: true
writeable: false

SupportedProperty
property: updatedAt
title: updatedAt
required: false
readable: true
writeable: false

SupportedProperty
property: template
title: template
required: false
readable: true
writeable: true

SupportedProperty
property: tender
title: tender
required: false
readable: true
writeable: true
description: This value is used during estimation and save and is not persisted.

SupportedProperty
property: openProposalPrice
title: openProposalPrice
required: false
readable: true
writeable: false

SupportedProperty
property: hasCounterOffer
title: hasCounterOffer
required: false
readable: true
writeable: false
description: Expose through API.

SupportedProperty
property: estimatedDuration
title: estimatedDuration
required: false
readable: true
writeable: false
description: Compatibility layer for the previous “estimatedDuration” property.

SupportedProperty
property: proposalType
title: proposalType
required: false
readable: true
writeable: true

SupportedProperty
property: nameForCourier
title: nameForCourier
required: false
readable: true
writeable: false

Retrieves a Delivery resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Delivery resource.
returns: Delivery

Updates the Delivery resource.
type: Operation
expects: Delivery
method: PATCH
title: Updates the Delivery resource.
returns: Delivery

Replaces the Delivery resource.
type: Operation
type: ReplaceAction
expects: Delivery
method: PUT
title: Replaces the Delivery resource.
returns: Delivery

Replaces the Delivery resource.
type: Operation
type: ReplaceAction
expects: Delivery
method: PUT
title: Replaces the Delivery resource.
returns: Delivery

Retrieves a Delivery resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Delivery resource.
returns: Delivery

Creates a Delivery resource.
type: Operation
type: CreateAction
expects: Delivery
method: POST
title: Creates a Delivery resource.
returns: Delivery

Retrieves a Delivery resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Delivery resource.
returns: Delivery

Creates a Delivery resource.
type: Operation
type: CreateAction
expects: Delivery
method: POST
title: Creates a Delivery resource.
returns: Delivery

Retrieves a Delivery resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a Delivery resource.
returns: Delivery

Creates a Delivery resource.
type: Operation
type: CreateAction
expects: Delivery
method: POST
title: Creates a Delivery resource.
returns: Delivery

Creates a Delivery resource.
type: Operation
type: CreateAction
expects: Delivery
method: POST
title: Creates a Delivery resource.
returns: Delivery

Updates the Delivery resource.
type: Operation
expects: Delivery
method: PATCH
title: Updates the Delivery resource.
returns: Delivery

Updates the Delivery resource.
type: Operation
expects: Delivery
method: PATCH
title: Updates the Delivery resource.
returns: Delivery

Updates the Delivery resource.
type: Operation
expects: Delivery
method: PATCH
title: Updates the Delivery resource.
returns: Delivery

Retrieves a User resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a User resource.
returns: User

Retrieves a User resource.
type: Operation
type: FindAction
method: GET
title: Retrieves a User resource.
returns: User