CustomerResponse

  • created_at
    Type: string · Created AtFormat: date-time
    required

    System timestamp when this record was first created

  • external_created_at
    Type: string · External Created AtFormat: date-time
    required

    Created timestamp from your system, used for audit and reconciliation

  • external_id
    Type: string · External Id
    min length:  
    1
    max length:  
    256
    required

    Unique identifier from your system

  • external_updated_at
    Type: string · External Updated AtFormat: date-time
    required

    Last-updated timestamp from your system, used for audit and reconciliation

  • id
    Type: string · IdFormat: uuid
    required

    Internal system UUID for this record

  • name
    Type: string · Name
    max length:  
    256
    required

    Customer display name

  • source
    Type: string · DataSourceenum
    required

    Namespace that scopes external_id to prevent collisions across integrations. All records sharing the same source must have unique external_ids.

    values
    • netsuite
    • priority
    • zoho_books
    • quickbooks
    • salesforce
  • tenant_id
    Type: string · Tenant IdFormat: uuid
    required

    UUID of the tenant that owns this record

  • updated_at
    Type: string · Updated AtFormat: date-time
    required

    System timestamp of the most recent update to this record

  • addresses
    Type: object · CustomerAddresses nullable

    Customer billing and shipping addresses

    • billing
      Type: object · AddressDto nullable

      Billing address

    • shipping
      Type: object · AddressDto nullable

      Shipping address

  • b2b_or_b2c
    Type: stringenum nullable

    Derived B2B/B2C classification based on tax number validation. System-set on create/update.

    values
    • b2b
    • b2c
  • comment
    Type: string · Comment
    max length:  
    200     nullable

    Internal notes about this customer

  • customer_status
    Type: stringenum nullable

    Account lifecycle status. active: can be used in new transactions, inactive: soft-deleted and excluded from lookups, suspended: temporarily blocked from new transactions

    values
    • active
    • inactive
    • suspended
  • customer_type
    Type: stringenum nullable

    Customer classification that affects tax treatment. retail: standard tax rules, marketplace: marketplace facilitator rules apply, wholesale: B2B resale (may require exemption certificate), retail_exempt: retail customer with blanket exemption

    values
    • retail
    • marketplace
    • reseller
  • email
    Type: string · EmailFormat: email nullable

    Contact email address

  • tax_number
    Type: string · Tax Number
    max length:  
    100     nullable

    Tax identification number (e.g., EIN, VAT)