Clients

Find Client by Name

Returns a specific client.

get/clients/find-by-name.json

Query parameters

client_namestring required

Example:foo

The client name you want to search. Warning: partial search is not supported.

api_keystring required

Example:YOUR_API_KEY

Your API Key.

Response

SUCCESS.

Example response

{
  "client": {
    "id": 196601767,
    "name": "Ricardo Pereira",
    "language": "pt",
    "email": "someone@example.com",
    "address": "Lisbon",
    "city": "Lisbon",
    "postal_code": "1750-455",
    "fiscal_id": "508025338",
    "website": "www.invoicexpress.com",
    "country": "Portugal",
    "phone": "2313423424",
    "fax": "2313423425",
    "preferred_contact": {
      "name": "Ricardo Pereira",
      "email": "someone@example.com",
      "phone": "2233442233"
    },
    "open_account_link": "https://www.app.invoicexpress.com/suppliers/1f7bba947948c50e04af20d329db5bc67c38cf89",
    "send_options": 1,
    "tax_exemption_code": "M00"
  }
}

Changes

Changed in 1 of the 2 revisions of this API.2013

Aug 25, 20265b82d4eb0d9f2013See the full diff
- ▲
  the response property client/address became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/city became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/country became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/email became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/fax became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/fiscal_id became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/observations became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/payment_days became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/phone became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/postal_code became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/preferred_contact/email became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/preferred_contact/name became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/preferred_contact/phone became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/send_options became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/tax_exemption_code became nullable for the status 200
  response-property-became-nullable
- ▲
  the response property client/website became nullable for the status 200
  response-property-became-nullable
- ▲
  the client/id response's property type/format changed from string/ to integer/ for status 200
  response-property-type-changed
- ▲
  the client/payment_days response's property type/format changed from string/ to integer null/ for status 200
  response-property-type-changed
- ▲
  the client/send_options response's property type/format changed from string/ to integer null/ for status 200
  response-property-type-changed
- ▲
  the errors response's property type/format changed from object/ to array/ for status 401
  response-property-type-changed
- ●
  removed the optional property errors/error from the response with the 401 status
  response-optional-property-removed
- ○
  added the optional property client/code to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property client/language to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property client/preferred_contact/mobile to the response with the 200 status
  response-optional-property-added
This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history