Create (Or Update) An Invoice Customer

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

firstName*string

E-invoicing Customer name

lastName*string

E-invoicing Customer name

email*string

Email address - Mandatory. Only accept a valid email address.

phone*string

Phone number - Mandatory. It should only accept numbers and the + sign.

tin?string

E-invoicing Customer TIN - Optional. It should accept letters, numbers, and "-"

country*string

Country - Mandatory. A drop-down list of countries.

state?string

State - Optional. The state drop-down should be based on the country selected.

city?string

City - Optional. The city drop-down should be based on the chosen state.

address*string

Address - Mandatory. It should accept numbers, letters, and special characters. Min 3, max 50 characters.

postcode*string

Postcode - Mandatory.

module*string

Module associated with this customer.

Value in"invoice"

Response Body

`application/json`

curl -X POST "https://example.com/api/e-invoicing/customers" \  -H "Content-Type: application/json" \  -d '{    "firstName": "John Doe Enterprises",    "lastName": "John Doe Enterprises",    "email": "customer@example.com",    "phone": "+2348098765432",    "country": "Nigeria",    "address": "456 Market Street, Yaba",    "postcode": "023401",    "module": "invoice"  }'

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "businessId": "f3f3c6a1-45e3-44aa-b05a-1fbe98d52d09",
  "reference": "CUST_INV_ABC123XYZ456",
  "modules": [
    "invoice"
  ],
  "firstName": "John",
  "lastName": "Doe",
  "email": "customer@example.com",
  "phone": "+2348098765432",
  "tin": "98765432-0001",
  "country": "Nigeria",
  "state": "Lagos",
  "city": "Yaba",
  "address": "456 Market Street, Yaba",
  "postcode": "023401",
  "createdAt": "2024-01-23T10:00:00.000Z",
  "updatedAt": "2024-01-23T10:00:00.000Z"
}

Empty

Create (Or Update) An Invoice Customer

Authorization

Request Body

Response Body

200application/json

401

403

429

`application/json`