TOtopi
ops
ops-end-customers

Create an end customer

Changed on

Create a new end customer (for Ops)

post/ops/end-customers

Request

  • Base URL
    https://api.topi-staging.eu
  • URL
    https://api.topi-staging.eu/ops/end-customers
  • Auth
    OAuth 2
    Authorization code: /oauth2/authorize
    Token URL: /oauth2/token scopes: ops-end-customer:edit

Request body

company_registration_numberstring

end-customer Company Registration Number

currencystring required

end-customer currency

email_domainstring required

end-customer email domain

groupstring

end-customer group

namestring required

end-customer name

tax_numberstring

end-customer tax number

vat_numberstring

end-customer VAT number

Example request

{
  "billing_address": {
    "city": "aaa",
    "country_code": "DE",
    "line1": "aaa",
    "line2": "aaa",
    "postal_code": "aaa",
    "region": "aaa"
  },
  "company_registration_number": "abc123",
  "currency": "abc123",
  "email_domain": "abc123",
  "group": "abc123",
  "name": "abc123",
  "tax_number": "abc123",
  "vat_number": "abc123"
}

Response

Created response.

company_registration_numberstring

end-customer Company Registration Number

email_domainstring required

end-customer email domain

groupstring

end-customer group

idstring regexp required

end-customer ID

in_migrationboolean required

is the end-customer currently being migrated

is_newboolean required

end-customer is new

languagestring required

end-customer language

namestring required

end-customer name

not_vat_registeredboolean

end-customer declared it has no VAT number

risk_statusstring

end-customer risk status

tax_numberstring

end-customer tax number

type'Sole proprietorship' | 'Partnership' | 'Corporation' | 'Limited Liability Company (LLC)'

Type of the company (required for US)

vat_numberstring

end-customer VAT number

Example response

{
  "billing_address": {
    "city": "aaa",
    "country_code": "DE",
    "line1": "aaa",
    "line2": "aaa",
    "postal_code": "aaa",
    "region": "aaa"
  },
  "company_address": {
    "city": "aaa",
    "country_code": "DE",
    "line1": "aaa",
    "line2": "aaa",
    "postal_code": "aaa",
    "region": "aaa"
  },
  "company_registration_number": "abc123",
  "email_domain": "abc123",
  "group": "abc123",
  "id": "739b63c2-9e58-4964-b38d-4ebb424de242",
  "in_migration": false,
  "is_new": false,
  "language": "abc123",
  "name": "abc123",
  "not_vat_registered": false,
  "risk_status": "abc123",
  "tax_number": "abc123",
  "type": "Partnership",
  "vat_number": "abc123"
}

Changes

  • 0802da91479fRevision changes
    • warning

      the / request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 255

    • warning

      the / request property's maxLength was set to 255

  • ac6979514123Revision changes
    • info

      api operation id end_customer.createEndCustomerOps removed and replaced with end_customer#createEndCustomerOps