Customers

Manage your customer base.


Base entity representing your clients/buyers. Must be uploaded first as other entities depend on it.

Endpoint

POST /full-csv-integration/upload-customers

  • Form Field: customersFile

Required Fields

FieldTypeDescriptionValidations
nitStringTax identification numberCannot be empty
erp_customer_idStringUnique customer ID in your ERPCannot be empty
company_nameStringCompany or business nameCannot be empty

Optional Fields

FieldTypeDescriptionDefault
emailStringCompany email addressnull
city_nameStringHeadquarters citynull
state_nameStringState/Provincenull
postal_codeStringPostal/ZIP codenull
country_codeStringCountry codenull
credit_limitFloatCurrent credit limitnull
current_termIntegerPayment term in daysnull
allow_collectionBooleanAllow automated collection campaigns1 (true)
advance_balanceFloatCustomer advance balancenull
erp_branch_idStringBranch ID in ERPnull
branch_nameStringBranch namenull

Example CSV

nit,erp_customer_id,company_name,email,city_name,state_name,credit_limit,current_term,allow_collection
123456789-1,CUST001,ABC Company Inc.,contact@abc.com,Bogotá,Cundinamarca,1000000.00,30,1
987654321-2,CUST002,XYZ Corporation Ltd.,info@xyz.com,MedellĂ­n,Antioquia,500000.00,15,1