Add a new payer

x-ms-visibility: "important"

Send a request to add a payer details specified in the request body. A payer can be connected to one or several drivers and/or sites.

application/json

Request Body required

Payer object to be added

name string
email string
invoiceReference string
invoiceMessage string
streetAddress string
city string
postalCode string
country string
driverIds int64[]
siteIds int64[]
language string

Responses

• 200
• 400
• 401

---

Returns the new payer that was added succesfully

application/json

Schema

Example (from schema)

---

Schema

id int64
name string
email string
invoiceReference string
invoiceMessage string
streetAddress string
city string
postalCode string
country string
lastUpdated date-time
drivers object[]
Array [
id int64
name string
]
sites object[]
Array [
id int64
groupName string
]
language string

{
  "id": 0,
  "name": "string",
  "email": "string",
  "invoiceReference": "string",
  "invoiceMessage": "string",
  "streetAddress": "string",
  "city": "string",
  "postalCode": "string",
  "country": "string",
  "lastUpdated": "2024-09-02T06:33:51.706Z",
  "drivers": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "sites": [
    {
      "id": 0,
      "groupName": "string"
    }
  ],
  "language": "string"
}

Errors in the body request

text/plain

Schema

---

Schema

string

Customer not found or not authorised

Loading...