--- title: "Sync customers" method: GET path: "/v1/customers/sync" tags: ["Customers"] --- # Sync customers `GET /v1/customers/sync` ## Request - Base URL: `` (relative, and it does not resolve against the document’s source URL) - URL: `/v1/customers/sync` - Auth: one of: - API key in header `sessionKey` - API key in header `clientCode` - API key in header `jwt` - TypeScript: (a function with typed inputs; its response is checked against the schema) ## Query parameters - `lastModified` integer - `lastIdRetrieved` integer - `take` integer - `withTotalCount` boolean ## Response `200` OK - CustomersApiInternalModelsCustomerResponse[] - `GLN` string: Global Location Number. - `added` integer - `bankAccountNumber` string: Number of customer's bank account. - `bankIban` string: IBAN number of customer's bank account. - `bankName` string: Name of customer's bank. - `bankSwiftCode` string: BIC/SWIFT identifier of customer's bank account. - `birthDate` string: Person's birthday (yyyy-mm-dd) - `businessAreaId` integer: area of business. - `businessName` string: For businesses only. - `businessTypeId` integer: Customer type ID, for businesses only. - `changed` integer - `changedBy` string - `changedByEmployeeId` integer - `code` string: National ID - `color` string: Color that the customer entry is marked with. Possible values: "", "yellow", "red", "blue", "green". - `countryId` integer: Customer’s country. - `creditLimit` integer: Customer’s credit limit: the maximum amount of money (in account default currency) that they are allowed to owe. - `customerBalanceDisabled` boolean: Flag indicating that Erply does not keep track of the customer's balance (amount prepaid or due) - `customerGroupId` integer - `customerManagerId` integer: Customer manager (must be an employee) - `customerType` string: COMPANY or PERSON. For businesses, the following ributes are set: fullName, businessName (both have the same value). For individuals, the following attributes are set: fullName, firstName, lastName. fullName is a combination of latter two: "lastName, firstName". fullName can be used for displaying customer's name wherever needed. Companies should have one name field and the attribute that is edited should be businessName. Persons should have separate fields for given name and surname (respective attributes: firstName, lastName). - `defaultPaymentDeadLine` integer: Default payment deadline (in days). - `deliveryTypeId` integer: A field that propagates from customer records to sales documents and lets the company categorize shipments by delivery method or delivery time. - `displayedName` string: Name with customer type - `doNotSell` boolean: Whether the customer is marked with a do not sell flag or not. - `eInvoiceEmail` string: In UI, the field is titled “E-invoice email address”. - `eInvoiceReference` string: Customer reference for e-invoices. - `eInvoicesViaEmailEnabled` boolean: whether the customer wants to receive invoices via electronic channels. - `ediCode` string: E-invoice integration parameter. - `ediType` string: EDI type. Possible values: 2DOC, 4DOC, SPECIAL. - `emailOptOut` boolean: Flag indicating that this customer does not want to receive email correspondence. - `employerId` integer: Used to indicate that this individual is a contact person / an employee in a particular business. - `facebookName` string - `factoringContractNumber` string: Factoring contract number. - `fax` string - `firstName` string: First name / given name. For individuals only. - `fullName` string: Full name of the customer, use for displaying customer name. - `gender` string: Gender. Erply API only accepts "male" "female" or an empty string. - `homeStoreCustomId` integer: Additional, custom home store ID - `homeStoreId` integer: Location where the customer shops most frequently. https://learn-api.erply.com/requests/getwarehouses - `id` integer - `integrationCode` string: Corresponding customer identifier in a system integrated with Erply (e.g. accounting software) - `invoicesViaDocuraEnabled` boolean: Whether the customer wants to receive invoices via Docura channels. - `invoicesViaEmailEnabled` boolean: whether the customer wants to receive invoices via email. - `isStarred` boolean: Mark if a customer should be starred - `jobTitleId` integer: Individual's job title Ids. - `lastName` string: Last name / family name. For individuals only. - `loyaltyCardNumber` string: Assign the code of customer's loyalty/membership card. This code must match the sequence produced by card swipe. - `mail` string - `mobile` string - `name` string: For businesses only. - `notes` string - `operatorId` string: E-invoice integration parameter. - `paperMailsEnabled` boolean: whether the customer wants the e-invoice operator to deliver paper mails (if such option is supported). - `partialTaxExemption` boolean - `payerId` integer: “Payer of invoices” (another customer). - `paysViaFactoring` boolean: Flag indicating that this customer pays via factoring (all invoices must be addressed to a designated third party) - `penaltyForOverdue` number: Late fee / penalty for overdue invoices. The semantic meaning of this value is not strictly defined; usually we expect it to be “% per day” - `peppolId` string: Peppol ID - `phone` string - `posCouponsDisabled` boolean: Flag indicating that coupons must not be automatically printed to this customer. - `priceListId` integer: Assign the customer a price list - `priceListId2` integer - `priceListId3` integer - `priceListId4` integer - `priceListId5` integer - `primaryStoreId` integer: ID of the primary store - `referenceNumber` string: Customer’s reference number for sales invoices. Assign a reference number - if system is configured to use hand-created customer reference numbers. By default,not necessary, since reference numbers are created automatically. - `rewardPointsDisabled` boolean: Flag indicating that the customer will not earn points for purchases. (They can still spend existing points though.) - `salesForCashOnly` boolean: Flag “Sales for cash only”. By default,false - `secondaryStoreId` integer: ID of the secondary store - `shipGoodsWithWaybills` boolean: A flag indicating that this customer wants to get goods with Waybills, not Invoice-Waybills. - `signUpStoreId` integer: Location where the customer signed up. https://learn-api.erply.com/requests/getwarehouses - `skype` string - `taxExempt` boolean: Flag indicating that this customer must not be charged sales tax. - `taxOfficeId` integer: Feature used by Greek customers: office where the customer / supplier reports to. (This value must be shown on some printouts.) - `titleId` integer: A title (Mr / Mrs / Miss) etc. - `twitterId` string - `type` string: Customer type. Possible values are "DOMESTIC", "EU", "OUTSIDE_EU", "EU_WITH_VAT - `vatNumber` string: Customer's VAT number. - `webShopUsername` string: This is for web shop integrations: to store customers' web-shop login credentials in Erply. - `website` string ## Other responses - `400`: Bad Request - `500`: Internal Server Error --- [API](https://skmtc.dev/erply/apis/crm-api.md) - [All operations](https://skmtc.dev/erply/apis/crm-api/llms.txt) - [OpenAPI document](https://skmtc.dev/erply/apis/crm-api/revisions/36dd4cc370b2?raw)