v1

latestOpenAPI 3.1.02026-08-0658107212.4 KB
Clients

Create Client

Creates a new client.

post/clients.json

Query parameters

api_keystring required
Example:YOUR_API_KEY

Your API Key.

Request body

Example request

{
  "client": {
    "name": "Client Name",
    "code": "12345",
    "email": "foo@bar.com",
    "language": "pt",
    "address": "Avenida da República, Lisboa",
    "city": "Lisboa",
    "postal_code": "1050-555",
    "country": "Portugal",
    "fiscal_id": "508025338",
    "website": "www.invoicexpress.com",
    "phone": "213456789",
    "fax": "213456788",
    "preferred_contact": {
      "name": "Bruce Norris",
      "email": "email@invoicexpress.com",
      "phone": "213456789"
    },
    "observations": "Observations",
    "send_options": "1"
  }
}

Response

SUCCESS

Example response

{
  "client": {
    "id": "1",
    "name": "Ricardo Pereira",
    "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"
    },
    "observations": "Computer Processed",
    "open_account_link": "https://www.app.invoicexpress.com/suppliers/1f7bba947948c50e04af20d329db5bc67c38cf89",
    "send_options": "1",
    "payment_days": "0",
    "tax_exemption_code": "M00"
  }
}