Clients

Contrary to invoices, there is no test environment for clients. Editing client information with a test API key WILL change the client on production.

Creating a Client

POST https://api.request.finance/clients

Request Body

Name	Type	Description
email (*)	String
contactType (*)	String[]	Should be ["customer"] (mind the array!)
jobTitle	String
department	String
paymentMethods
address.streetAddress	String
address.extendedAddress	String
address.city	String
address.postalCode	String
address.region	String	(e.g. “California”)
address.country	String	Two character ISO 3166-1 country code of the buyer.
businessName	String
firstName	String
lastName	String
phone	String
taxRegistration	String	Tax number

Mandatory fields are marked with (*).

201

{
    "id": "[clientId]",
    // ... Client details
    "createdById": "...", // User's ID
    "createdDate": "2024-05-17T16:21:24.658Z"
}

Note that you don't have to have your clients created to issue invoices programmatically.

Updating a Client

PUT https://api.request.finance/clients/[clientId]

Request Body

Same as for the creation: Request Body

Retrieving clients

You can list all clients with:

GEThttps://api.request.finance/clients?type=customer

Note that the list of clients is not paginated. If you wish to manage a big number of clients, you probably want to consider issuing some invoices through API, see Invoices. Reach out to us via the Intercom widget for specific needs.

Get the details of one client with:

GEThttps://api.request.finance/clients/[clientId]